--- ../../octave-2.1.71/src/help.cc 2005-05-02 07:17:12.000000000 -0400 +++ help.cc 2005-06-21 00:29:01.996944904 -0400 @@ -93,243 +93,577 @@ static help_list operators[] = { { "!", - "Logical not operator. See also `~'.\n", }, + "-*- texinfo -*-\n\ address@hidden Operator !\n\ +Logical not operator.\n\ address@hidden deffn\n\ address@hidden", }, { "!=", - "Logical not equals operator. See also `~' and `<>'.\n", }, + "-*- texinfo -*-\n\ address@hidden Operator !=\n\ +Logical not equals operator.\n\ address@hidden deffn\n\ address@hidden, <>}", }, { "\"", - "String delimiter.\n", }, + "-*- texinfo -*-\n\ address@hidden Operator \"\n\ +String delimiter.\n\ address@hidden deffn\n\ address@hidden'}", }, { "#", - "Begin comment character. See also `%'.", }, + "-*- texinfo -*-\n\ address@hidden Operator #\n\ +Begin comment character.\n\ address@hidden deffn\n\ address@hidden", }, { "%", - "Begin comment charcter. See also `#'.", }, + "-*- texinfo -*-\n\ address@hidden Operator %\n\ +Begin comment charcter.\n\ address@hidden deffn\n\ address@hidden", }, { "&", - "Logical and operator. See also `&&'.", }, + "-*- texinfo -*-\n\ address@hidden Operator &\n\ +Logical and operator that operates on vectors.\n\ address@hidden&&}", }, { "&&", - "Logical and operator. See also `&'.", }, + "-*- texinfo -*-\n\ address@hidden Operator &&\n\ +Logical and operator that operates like all(@var{cond1} & @var{cond2}).\n\ address@hidden deffn\n\ address@hidden&}", }, { "'", - "Matrix transpose operator. For complex matrices, computes the\n\ -complex conjugate (Hermitian) transpose. See also `.''\n\ + "-*- texinfo -*-\n\ address@hidden Operator '\n\ +Matrix transpose operator.\n\ +For complex matrices, computes the complex conjugate (Hermitian) transpose.\n\ \n\ The single quote character may also be used to delimit strings, but\n\ it is better to use the double quote character, since that is never\n\ -ambiguous", }, +ambiguous.\n\ address@hidden deffn\n\ address@hidden', \"}", }, { "(", - "Array index or function argument delimiter.", }, + "-*- texinfo -*-\n\ address@hidden Operator (\n\ +Array index, function argument delimiter, or mathematical precedence\n\ +operator.\n\ address@hidden deffn", }, { ")", - "Array index or function argument delimiter.", }, + "-*- texinfo -*-\n\ address@hidden Operator )\n\ +Array index, function argument delimiter, or mathematical precedence\n\ +operator.\n\ address@hidden deffn", }, { "*", - "Multiplication operator. See also `.*'", }, + "-*- texinfo -*-\n\ address@hidden Operator *\n\ +Multiplication operator.\n\ address@hidden deffn\n\ address@hidden", }, { "**", - "Power operator. See also `^', `.**', and `.^'", }, + "-*- texinfo -*-\n\ address@hidden Operator **\n\ +Power operator.\n\ address@hidden deffn\n\ address@hidden, .**, .^}", }, { "+", - "Addition operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator +\n\ +Addition operator.\n\ address@hidden deffn\n\ address@hidden, -}", }, { "++", - "Increment operator. As in C, may be applied as a prefix or postfix operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator ++\n\ +Increment operator.\n\ +As in C, may be applied as a prefix or postfix operator.\n\ address@hidden deffn\n\ address@hidden, --}", }, { ",", - "Array index, function argument, or command separator.", }, + "-*- texinfo -*-\n\ address@hidden Operator ,\n\ +Array index, function argument, or command separator.\n\ address@hidden deffn", }, { "-", - "Subtraction or unary negation operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator -\n\ +Subtraction or unary negation operator.\n\ address@hidden deffn\n\ address@hidden, +}", }, { "--", - "Decrement operator. As in C, may be applied as a prefix or postfix operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator --\n\ +Decrement operator.\n\ +As in C, may be applied as a prefix or postfix operator.\n\ address@hidden deffn\n\ address@hidden, ++}", }, { ".'", - "Matrix transpose operator. For complex matrices, computes the\n\ -transpose, *not* the complex conjugate transpose. See also `''.", }, + "-*- texinfo -*-\n\ address@hidden Operator .'\n\ +Matrix transpose operator.\n\ +For complex matrices, computes the transpose, *not* the complex \n\ +conjugate transpose.\n\ address@hidden deffn\n\ address@hidden'}", }, { ".*", - "Element by element multiplication operator. See also `*'.", }, + "-*- texinfo -*-\n\ address@hidden Operator .*\n\ +Element by element multiplication operator.\n\ address@hidden deffn\n\ address@hidden", }, { ".**", - "Element by element power operator. See also `**', `^', and `.^'.", }, + "-*- texinfo -*-\n\ address@hidden Operator .**\n\ +Element by element power operator.\n\ address@hidden deffn\n\ address@hidden, ^, .^}", }, { "./", - "Element by element division operator. See also `/' and `\\'.", }, + "-*- texinfo -*-\n\ address@hidden Operator ./\n\ +Element by element division operator.\n\ address@hidden deffn\n\ address@hidden/, \\}", }, { ".^", - "Element by element power operator. See also `**', `^', and `.^'.", }, + "-*- texinfo -*-\n\ address@hidden Operator .^\n\ +Element by element power operator.\n\ address@hidden deffn\n\ address@hidden, ^, .^}", }, { "/", - "Right division. See also `\\' and `./'.", }, + "-*- texinfo -*-\n\ address@hidden Operator /\n\ +Right division.\n\ address@hidden deffn\n\ address@hidden, ./}", }, { ":", - "Select entire rows or columns of matrices.", }, + "-*- texinfo -*-\n\ address@hidden Operator :\n\ +Select entire rows or columns of matrices or specify an array.\n\ address@hidden +a = [1:4;5:8]\n\ +a(:,1)\n\ address@hidden example\n\ address@hidden deffn", }, { ";", - "Array row or command separator. See also `,'.", }, + "-*- texinfo -*-\n\ address@hidden Operator ;\n\ +Array row or command separator.\n\ address@hidden,}", }, { "<", - "Less than operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator <\n\ +Less than operator.\n\ address@hidden deffn", }, { "<=", - "Less than or equals operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator <=\n\ +Less than or equals operator.\n\ address@hidden deffn", }, { "<>", - "Logical not equals operator. See also `!=' and `~='.", }, + "-*- texinfo -*-\n\ address@hidden Operator <>\n\ +Logical not equals operator.\n\ address@hidden, ~=}", }, { "=", - "Assignment operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator =\n\ +Assignment operator.\n\ address@hidden deffn", }, { "==", - "Equality test operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator ==\n\ +Equality test operator.\n\ address@hidden deffn", }, { ">", - "Greater than operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator >\n\ +Greater than operator.\n\ address@hidden deffn", }, { ">=", - "Greater than or equals operator.", }, + "-*- texinfo -*-\n\ address@hidden Operator >=\n\ +Greater than or equals operator.\n\ address@hidden deffn", }, { "[", - "Return list delimiter. See also `]'.", }, + "-*- texinfo -*-\n\ address@hidden Operator [\n\ +Return list delimiter.\n\ address@hidden deffn\n\ address@hidden", }, { "\\", - "Left division operator. See also `/' and `./'.", }, + "-*- texinfo -*-\n\ address@hidden Operator \\\n\ +Left division operator.\n\ address@hidden deffn\n\ address@hidden/, ./}", }, { "]", - "Return list delimiter. See also `['.", }, + "-*- texinfo -*-\n\ address@hidden Operator ]\n\ +Return list delimiter.\n\ address@hidden deffn\n\ address@hidden", }, { "^", - "Power operator. See also `**', `.^', and `.**.'", }, + "-*- texinfo -*-\n\ address@hidden Operator ^\n\ +Power operator.\n\ address@hidden deffn\n\ address@hidden, .^, .**}", }, { "|", - "Logical or operator. See also `||'.", }, + "-*- texinfo -*-\n\ address@hidden Operator |\n\ +Logical vectorized or operator.\n\ address@hidden deffn\n\ address@hidden||}", }, { "||", - "Logical or operator. See also `|'.", }, + "-*- texinfo -*-\n\ address@hidden Operator ||\n\ +Logical or operator. Operates like all(@var{cond1} | @var{cond2}).\n\ address@hidden deffn\n\ address@hidden|}", }, { "~", - "Logical not operator. See also `!' and `~'.", }, + "-*- texinfo -*-\n\ address@hidden Operator ~\n\ +Logical not operator.\n\ address@hidden deffn\n\ address@hidden, ~=}", }, { "~=", - "Logical not equals operator. See also `<>' and `!='.", }, + "-*- texinfo -*-\n\ address@hidden Operator ~=\n\ +Logical not equals operator.\n\ address@hidden deffn\n\ address@hidden<>, !=}", }, { 0, 0, }, }; static help_list keywords[] = { - { "all_va_args", - "Pass all unnamed arguments to another function call.", }, { "break", - "Exit the innermost enclosing do, while or for loop.", }, + "-*- texinfo -*-\n\ address@hidden Keyword break\n\ +Exit the innermost enclosing do, while or for loop.\n\ +\n\ address@hidden, return}", }, { "case", - "A case statement in an switch. Octave cases are exclusive and do not\n\ + "-*- texinfo -*-\n\ address@hidden Keyword case +A case statement in an switch. Octave cases are exclusive and do not\n\ fall-through as do C-language cases. A switch statement must have at least\n\ -one case.",}, +one case.\n\ address@hidden deffn\n\ address@hidden",}, { "catch", - "begin the cleanup part of a try-catch block", }, + "-*- texinfo -*-\n\ address@hidden Keyword catch\n\ +Begin the cleanup section of a try-catch block. This part of the block\n\ +is not executed unless some part of the try section of the block fails.\n\ +\n\ +WARNING: If there is a failure of a line in the try section, the results\n\ +of the section up to the point of the error will be executed and then the\n\ +catch section will be executed.\n\ address@hidden deffn\n\ address@hidden, try}", }, { "continue", - "Jump to the end of the innermost enclosing do, while or for loop.", }, + "-*- texinfo -*-\n\ address@hidden Keyword continue\n\ +Jump to the end of the innermost enclosing do, while or for loop.\n\ +\n\ address@hidden deffn\n\ address@hidden, do, for, return, while}", }, { "do", - "Begin a do-until loop. This differs from a do-while loop in that the\n\ -body of the loop is executed at least once.",}, + "-*- texinfo -*-\n\ address@hidden Keyword do @dots{} until (@var{cond})\n\ +Begin a do-until loop. This differs from a while loop in that the\n\ +body of the loop is executed at least once.\n\ address@hidden +a = 1\n\ +do\n\ + a = a + 1\n\ +until a > 3\n\ address@hidden example\n\ address@hidden deffn address@hidden, while}",}, { "else", - "Alternate action for an if block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword else\n\ +Alternate action for an if block.\n\ address@hidden deffn\n\ address@hidden", }, { "elseif", - "Alternate conditional test for an if block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword elseif\n\ +Alternate conditional test for an if block.\n\ address@hidden deffn\n\ address@hidden, else}", }, { "end", - "Mark the end of any for, if, do, while, or function block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword end\n\ +Mark the end of any for, if, do, try, while, or function block.\n\ address@hidden deffn", }, { "end_try_catch", - "Mark the end of an try-catch block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword end_try_catch\n\ +Mark the end of an try-catch block.\n\ address@hidden deffn\n\ address@hidden", }, { "end_unwind_protect", - "Mark the end of an unwind_protect block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword end_unwind_protect\n\ +Mark the end of an unwind_protect block.\n\ address@hidden deffn\n\ address@hidden", }, { "endfor", - "Mark the end of a for loop.", }, + "-*- texinfo -*-\n\ address@hidden Keyword endfor\n\ +Mark the end of a for loop.\n\ address@hidden deffn\n\ address@hidden", }, { "endfunction", - "Mark the end of a function.", }, + "-*- texinfo -*-\n\ address@hidden Keyword endfunction\n\ +Mark the end of a function.\n\ address@hidden deffn\n\ address@hidden", }, { "endif", - "Mark the end of an if block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword endif\n\ +Mark the end of an if block.\n\ address@hidden deffn\n\ address@hidden", }, { "endswitch", - "Mark the end of a switch block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword endswitch\n\ +Mark the end of a switch block.\n\ address@hidden deffn\n\ address@hidden", }, { "endwhile", - "Mark the end of a while loop.", }, + "-*- texinfo -*-\n\ address@hidden Keyword endwhile\n\ +Mark the end of a while loop.\n\ address@hidden deffn\n\ address@hidden", }, { "for", - "Begin a for loop.", }, + "-*- texinfo -*-\n\ address@hidden Keyword for @address@hidden @dots{} endfor\n\ +Begin a for loop.\n\ +\n\ +This provides a method for looping over all values of an array.\n\ +\n\ address@hidden +for i = 1:5\n\ + i\n\ +endfor\n\ address@hidden example\n\ address@hidden deffn\n\ address@hidden, while}", }, { "function", - "Begin a function body.", }, + "-*- texinfo -*-\n\ address@hidden Keyword function address@hidden = functionname(@var{inputs}) @dots{} endfunction\n\ address@hidden Keyword function functionname(@var{inputs}) @dots{} endfunction\n\ address@hidden Keyword function address@hidden = functionname @dots{} endfunction\n\ +Begin a function body. This keyword allows you to define functions\n\ +with an arbitrary number (zero or more) of input and output arguements\n\ +may be specified and a variable number may be specified by using the\n\ +varargin and varargout keywords.\n\ address@hidden deffn\n\ address@hidden, varargout}", }, { "global", - "Declare variables to have global scope.", }, - - { "gplot", - "Produce 2-D plots using gnuplot-like command syntax.", }, + "-*- texinfo -*-\n\ address@hidden Keyword global\n\ +Declare variables to have global scope.\n\ address@hidden deffn\n\ address@hidden, static}", }, { "gsplot", "Produce 3-D plots using gnuplot-like command syntax.", }, { "if", - "Begin an if block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword if (@var{cond}) @dots{} endif\n\ address@hidden Keyword if (@var{cond}) @dots{} else @dots{} endif\n\ address@hidden Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif\n\ address@hidden Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else @dots{} endif\n\ +Begin an if block.\n\ +\n\ +This function allows conditional logic to be performed of the form:\n\ +\n\ +The @var{cond} may be a logical condition of the form \"a == b\" or any\n\ +statement or function that can be evaluated to a non-zero result.\n\ address@hidden deffn\n\ address@hidden, any, switch, !, !=, ==, <, <=, >, >=}", }, { "otherwise", - "The default statement in a switch block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword otherwise\n\ +The default statement in a switch block.\n\ address@hidden deffn\n\ address@hidden", }, { "persistent", - "Declare variables as persistent.", }, - - { "replot", - "Replot a graphic.", }, + "-*- texinfo -*-\n\ address@hidden Keyword persistent\n\ +Declare variables as persistent.\n\ address@hidden deffn\n\ address@hidden, static}", }, { "return", - "Return from a function.", }, + "-*- texinfo -*-\n\ address@hidden Keyword return\n\ +Return from a function.\n\ +\n\ +This may be used to return from a function before the end of the function\n\ +would otherwise occur.\n\ address@hidden deffn\n\ address@hidden", }, { "static", - "Declare variables as persistent.", }, + "-*- texinfo -*-\n\ address@hidden Keyword static\n\ +Declare variables as persistent within a function.\n\ address@hidden deffn\n\ address@hidden, persistent}", }, { "switch", - "Begin a switch statement.",}, + "-*- texinfo -*-\n\ address@hidden Keyword switch\n\ +Begin a switch statement.\n\ address@hidden deffn\n\ address@hidden",}, { "try", - "Begin a try-catch block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword try @dots{} catch @dots{} end_try_catch\n\ +Begin a try-catch block.\n\ +\n\ +This block allows you to catch errors and execute alternate code in case\n\ +of an error. If there is no error in the try section, then the catch\n\ +section will not be executed.\n\ +\n\ address@hidden +try\n\ + a = 0;\n\ + error ('Now go to catch');\n\ +catch\n\ + b = 1\n\ +end_try_catch\n\ address@hidden example\n\ address@hidden deffn\n\ address@hidden, error}", }, { "until", - "End a do-until loop.",}, + "-*- texinfo -*-\n\ address@hidden Keyword until\n\ +End a do-until loop.\n\ address@hidden deffn\n\ address@hidden",}, { "unwind_protect", - "Begin an unwind_protect block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword unwind_protect\n\ +Begin an unwind_protect block.\n\ address@hidden deffn", }, { "unwind_protect_cleanup", - "Begin the cleanup section of an unwind_protect block.", }, + "-*- texinfo -*-\n\ address@hidden Keyword unwind_protect_cleanup\n\ +Begin the cleanup section of an unwind_protect block.\n\ address@hidden deffn\n\ address@hidden", }, { "varargin", - "Pass an arbitrary number of arguments into a function.",}, + "-*- texinfo -*-\n\ address@hidden Keyword varargin\n\ +Pass an arbitrary number of arguments into a function. The arguments\n\ +are passed in as a cell array.\n\ address@hidden +function address@hidden, varargout] = foo(@var{b}, varargin)\n\ address@hidden example\n\ address@hidden deffn\n\ address@hidden, nargout, varargout}",}, { "varargout", - "Pass an arbitrary number of arguments out of a function.",}, + "-*- texinfo -*-\n\ address@hidden Keyword varargout\n\ +Pass an arbitrary number of arguments out of a function. The arguments\n\ +are passed out as a cell array.\n\ address@hidden +function address@hidden, varargout] = foo(@var{b}, varargin)\n\ address@hidden example\n\ address@hidden deffn\n\ address@hidden, nargout, varargin}",}, { "while", - "Begin a while loop.", }, + "-*- texinfo -*-\n\ address@hidden Keyword while (@var{cond}) @dots{} endwhile\n\ +Begin a while loop. This will not execute once if the condition is\n\ +not met in contrast to a do loop.\n\ address@hidden +i = 0;\n\ +while (i < 3)\n\ + i = i + 1\n\ +endwhile\n\ address@hidden example\n\ address@hidden deffn\n\ address@hidden, for}", }, { 0, 0, }, };