Mercurial > octave-nkf

comparison src/help.cc @ 10840:89f4d7e294cc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck .cc files
author Rik <octave@nomad.inbox5.com>
date Sat, 31 Jul 2010 11:18:11 -0700
parents 8f27f368aba2
children 4ffa19147604
comparison
equal deleted inserted replaced
10839:65bc065bec95 10840:89f4d7e294cc
284 @end deffn"), 284 @end deffn"),
285 285
286 pair_type ("end", 286 pair_type ("end",
287 "-*- texinfo -*-\n\ 287 "-*- texinfo -*-\n\
288 @deffn Keyword end\n\ 288 @deffn Keyword end\n\
289 Mark the end of any @code{for}, @code{if}, @code{do}, @code{while}, or @code{function} block.\n\ 289 Mark the end of any @code{for}, @code{if}, @code{do}, @code{while}, or\n\
290 @code{function} block.\n\
290 @seealso{for, if, do, while, function}\n\ 291 @seealso{for, if, do, while, function}\n\
291 @end deffn"), 292 @end deffn"),
292 293
293 pair_type ("end_try_catch", 294 pair_type ("end_try_catch",
294 "-*- texinfo -*-\n\ 295 "-*- texinfo -*-\n\
341 342
342 pair_type ("for", 343 pair_type ("for",
343 "-*- texinfo -*-\n\ 344 "-*- texinfo -*-\n\
344 @deffn Keyword for @var{i} = @var{range}\n\ 345 @deffn Keyword for @var{i} = @var{range}\n\
345 Begin a for loop.\n\ 346 Begin a for loop.\n\
347 \n\
346 @example\n\ 348 @example\n\
347 @group\n\ 349 @group\n\
348 for i = 1:10\n\ 350 for i = 1:10\n\
349 i\n\ 351 i\n\
350 endfor\n\ 352 endfor\n\
365 367
366 pair_type ("global", 368 pair_type ("global",
367 "-*- texinfo -*-\n\ 369 "-*- texinfo -*-\n\
368 @deffn Keyword global\n\ 370 @deffn Keyword global\n\
369 Declare variables to have global scope.\n\ 371 Declare variables to have global scope.\n\
372 \n\
370 @example\n\ 373 @example\n\
371 @group\n\ 374 @group\n\
372 global @var{x};\n\ 375 global @var{x};\n\
373 if isempty (@var{x})\n\ 376 if isempty (@var{x})\n\
374 x = 1;\n\ 377 x = 1;\n\
383 @deffn Keyword if (@var{cond}) @dots{} endif\n\ 386 @deffn Keyword if (@var{cond}) @dots{} endif\n\
384 @deffnx Keyword if (@var{cond}) @dots{} else @dots{} endif\n\ 387 @deffnx Keyword if (@var{cond}) @dots{} else @dots{} endif\n\
385 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif\n\ 388 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif\n\
386 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else @dots{} endif\n\ 389 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else @dots{} endif\n\
387 Begin an if block.\n\ 390 Begin an if block.\n\
391 \n\
388 @example\n\ 392 @example\n\
389 @group\n\ 393 @group\n\
390 x = 1;\n\ 394 x = 1;\n\
391 if (x == 1)\n\ 395 if (x == 1)\n\
392 disp (\"one\");\n\ 396 disp (\"one\");\n\
441 445
442 pair_type ("switch", 446 pair_type ("switch",
443 "-*- texinfo -*-\n\ 447 "-*- texinfo -*-\n\
444 @deffn Keyword switch @var{statement}\n\ 448 @deffn Keyword switch @var{statement}\n\
445 Begin a switch block.\n\ 449 Begin a switch block.\n\
450 \n\
446 @example\n\ 451 @example\n\
447 @group\n\ 452 @group\n\
448 yesno = \"yes\"\n\ 453 yesno = \"yes\"\n\
449 \n\ 454 \n\
450 switch yesno\n\ 455 switch yesno\n\
1002 // functions available in DIRECTORY. If no directory is given, search 1007 // functions available in DIRECTORY. If no directory is given, search
1003 // the current path. 1008 // the current path.
1004 1009
1005 DEFUN (__list_functions__, args, , 1010 DEFUN (__list_functions__, args, ,
1006 "-*- texinfo -*-\n\ 1011 "-*- texinfo -*-\n\
1007 @deftypefn {Function File} {@var{retval} =} __list_functions__ ()\n\ 1012 @deftypefn {Function File} {@var{retval} =} __list_functions__ ()\n\
1008 @deftypefnx{Function File} {@var{retval} =} __list_functions__ (@var{directory})\n\ 1013 @deftypefnx {Function File} {@var{retval} =} __list_functions__ (@var{directory})\n\
1009 Undocumented internal function.\n\ 1014 Undocumented internal function.\n\
1010 @end deftypefn") 1015 @end deftypefn")
1011 { 1016 {
1012 octave_value retval; 1017 octave_value retval;
1013 1018
1042 return retval; 1047 return retval;
1043 } 1048 }
1044 1049
1045 DEFUN (doc_cache_file, args, nargout, 1050 DEFUN (doc_cache_file, args, nargout,
1046 "-*- texinfo -*-\n\ 1051 "-*- texinfo -*-\n\
1047 @deftypefn {Built-in Function} {@var{val} =} doc_cache_file ()\n\ 1052 @deftypefn {Built-in Function} {@var{val} =} doc_cache_file ()\n\
1048 @deftypefnx {Built-in Function} {@var{old_val} =} doc_cache_file (@var{new_val})\n\ 1053 @deftypefnx {Built-in Function} {@var{old_val} =} doc_cache_file (@var{new_val})\n\
1049 Query or set the internal variable that specifies the name of the\n\ 1054 Query or set the internal variable that specifies the name of the\n\
1050 Octave documentation cache file. A cache file significantly improves\n\ 1055 Octave documentation cache file. A cache file significantly improves\n\
1051 the performance of the @code{lookfor} command. The default value is \n\ 1056 the performance of the @code{lookfor} command. The default value is \n\
1052 @file{@var{octave-home}/share/octave/@var{version}/etc/doc-cache},\n\ 1057 @file{@var{octave-home}/share/octave/@var{version}/etc/doc-cache},\n\
1053 in which @var{octave-home} is the root directory of the Octave installation,\n\ 1058 in which @var{octave-home} is the root directory of the Octave installation,\n\
1054 and @var{version} is the Octave version number.\n\ 1059 and @var{version} is the Octave version number.\n\
1055 The default value may be overridden by the environment variable\n\ 1060 The default value may be overridden by the environment variable\n\
1056 @w{@code{OCTAVE_DOC_CACHE_FILE}}, or the command line argument\n\ 1061 @w{@env{OCTAVE_DOC_CACHE_FILE}}, or the command line argument\n\
1057 @samp{--doc-cache-file NAME}.\n\ 1062 @samp{--doc-cache-file NAME}.\n\
1058 @seealso{lookfor, info_program, doc, help, makeinfo_program}\n\ 1063 @seealso{lookfor, info_program, doc, help, makeinfo_program}\n\
1059 @end deftypefn") 1064 @end deftypefn")
1060 { 1065 {
1061 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (doc_cache_file); 1066 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (doc_cache_file);
1062 } 1067 }
1063 1068
1064 DEFUN (info_file, args, nargout, 1069 DEFUN (info_file, args, nargout,
1065 "-*- texinfo -*-\n\ 1070 "-*- texinfo -*-\n\
1066 @deftypefn {Built-in Function} {@var{val} =} info_file ()\n\ 1071 @deftypefn {Built-in Function} {@var{val} =} info_file ()\n\
1067 @deftypefnx {Built-in Function} {@var{old_val} =} info_file (@var{new_val})\n\ 1072 @deftypefnx {Built-in Function} {@var{old_val} =} info_file (@var{new_val})\n\
1068 Query or set the internal variable that specifies the name of the\n\ 1073 Query or set the internal variable that specifies the name of the\n\
1069 Octave info file. The default value is\n\ 1074 Octave info file. The default value is\n\
1070 @file{@var{octave-home}/info/octave.info}, in\n\ 1075 @file{@var{octave-home}/info/octave.info}, in\n\
1071 which @var{octave-home} is the root directory of the Octave installation.\n\ 1076 which @var{octave-home} is the root directory of the Octave installation.\n\
1072 The default value may be overridden by the environment variable\n\ 1077 The default value may be overridden by the environment variable\n\
1073 @w{@code{OCTAVE_INFO_FILE}}, or the command line argument\n\ 1078 @w{@env{OCTAVE_INFO_FILE}}, or the command line argument\n\
1074 @samp{--info-file NAME}.\n\ 1079 @samp{--info-file NAME}.\n\
1075 @seealso{info_program, doc, help, makeinfo_program}\n\ 1080 @seealso{info_program, doc, help, makeinfo_program}\n\
1076 @end deftypefn") 1081 @end deftypefn")
1077 { 1082 {
1078 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_file); 1083 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_file);
1079 } 1084 }
1080 1085
1081 DEFUN (info_program, args, nargout, 1086 DEFUN (info_program, args, nargout,
1082 "-*- texinfo -*-\n\ 1087 "-*- texinfo -*-\n\
1083 @deftypefn {Built-in Function} {@var{val} =} info_program ()\n\ 1088 @deftypefn {Built-in Function} {@var{val} =} info_program ()\n\
1084 @deftypefnx {Built-in Function} {@var{old_val} =} info_program (@var{new_val})\n\ 1089 @deftypefnx {Built-in Function} {@var{old_val} =} info_program (@var{new_val})\n\
1085 Query or set the internal variable that specifies the name of the\n\ 1090 Query or set the internal variable that specifies the name of the\n\
1086 info program to run. The default value is\n\ 1091 info program to run. The default value is\n\
1087 @file{@var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}/info}\n\ 1092 @file{@var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}/info}\n\
1088 in which @var{octave-home} is the root directory of the Octave installation,\n\ 1093 in which @var{octave-home} is the root directory of the Octave installation,\n\
1089 @var{version} is the Octave version number, and @var{arch}\n\ 1094 @var{version} is the Octave version number, and @var{arch}\n\
1090 is the system type (for example, @code{i686-pc-linux-gnu}). The\n\ 1095 is the system type (for example, @code{i686-pc-linux-gnu}). The\n\
1091 default value may be overridden by the environment variable\n\ 1096 default value may be overridden by the environment variable\n\
1092 @w{@code{OCTAVE_INFO_PROGRAM}}, or the command line argument\n\ 1097 @w{@env{OCTAVE_INFO_PROGRAM}}, or the command line argument\n\
1093 @samp{--info-program NAME}.\n\ 1098 @samp{--info-program NAME}.\n\
1094 @seealso{info_file, doc, help, makeinfo_program}\n\ 1099 @seealso{info_file, doc, help, makeinfo_program}\n\
1095 @end deftypefn") 1100 @end deftypefn")
1096 { 1101 {
1097 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_program); 1102 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_program);
1098 } 1103 }
1099 1104
1100 DEFUN (makeinfo_program, args, nargout, 1105 DEFUN (makeinfo_program, args, nargout,
1101 "-*- texinfo -*-\n\ 1106 "-*- texinfo -*-\n\
1102 @deftypefn {Built-in Function} {@var{val} =} makeinfo_program ()\n\ 1107 @deftypefn {Built-in Function} {@var{val} =} makeinfo_program ()\n\
1103 @deftypefnx {Built-in Function} {@var{old_val} =} makeinfo_program (@var{new_val})\n\ 1108 @deftypefnx {Built-in Function} {@var{old_val} =} makeinfo_program (@var{new_val})\n\
1104 Query or set the internal variable that specifies the name of the\n\ 1109 Query or set the internal variable that specifies the name of the\n\
1105 program that Octave runs to format help text containing\n\ 1110 program that Octave runs to format help text containing\n\
1106 Texinfo markup commands. The default value is @code{makeinfo}.\n\ 1111 Texinfo markup commands. The default value is @code{makeinfo}.\n\
1107 @seealso{info_file, info_program, doc, help}\n\ 1112 @seealso{info_file, info_program, doc, help}\n\
1110 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program); 1115 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program);
1111 } 1116 }
1112 1117
1113 DEFUN (suppress_verbose_help_message, args, nargout, 1118 DEFUN (suppress_verbose_help_message, args, nargout,
1114 "-*- texinfo -*-\n\ 1119 "-*- texinfo -*-\n\
1115 @deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\ 1120 @deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\
1116 @deftypefnx {Built-in Function} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})\n\ 1121 @deftypefnx {Built-in Function} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})\n\
1117 Query or set the internal variable that controls whether Octave\n\ 1122 Query or set the internal variable that controls whether Octave\n\
1118 will add additional help information to the end of the output from\n\ 1123 will add additional help information to the end of the output from\n\
1119 the @code{help} command and usage messages for built-in commands.\n\ 1124 the @code{help} command and usage messages for built-in commands.\n\
1120 @end deftypefn") 1125 @end deftypefn")