Mercurial > hg > octave-nkf

comparison src/help.cc @ 14618:36f451642f79

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add texi_macros_file to manual. * basics.txi: Add function to manual. * aspell-octave.en.pws: Add 'makeinfo' to Octave dictionary. * help.cc (makeinfo_program, texi_macros_file): Improve doctrings.
author Rik <octave@nomad.inbox5.com>
date Thu, 10 May 2012 17:08:50 -0700
parents 4e9dc46d4125
children 877263efaacc
comparison
equal deleted inserted replaced
14617:8ffb01c3a27a 14618:36f451642f79
1300 "-*- texinfo -*-\n\ 1300 "-*- texinfo -*-\n\
1301 @deftypefn {Built-in Function} {@var{val} =} texi_macros_file ()\n\ 1301 @deftypefn {Built-in Function} {@var{val} =} texi_macros_file ()\n\
1302 @deftypefnx {Built-in Function} {@var{old_val} =} texi_macros_file (@var{new_val})\n\ 1302 @deftypefnx {Built-in Function} {@var{old_val} =} texi_macros_file (@var{new_val})\n\
1303 @deftypefnx {Built-in Function} {} texi_macros_file (@var{new_val}, \"local\")\n\ 1303 @deftypefnx {Built-in Function} {} texi_macros_file (@var{new_val}, \"local\")\n\
1304 Query or set the internal variable that specifies the name of the\n\ 1304 Query or set the internal variable that specifies the name of the\n\
1305 file containing Texinfo macros that are prepended to doc strings\n\ 1305 file containing Texinfo macros that are prepended to documentation strings\n\
1306 before they are passed to makeinfo. The default value is \n\ 1306 before they are passed to makeinfo. The default value is \n\
1307 @file{@var{octave-home}/share/octave/@var{version}/etc/macros.texi},\n\ 1307 @file{@var{octave-home}/share/octave/@var{version}/etc/macros.texi},\n\
1308 in which @var{octave-home} is the root directory of the Octave installation,\n\ 1308 in which @var{octave-home} is the root directory of the Octave installation,\n\
1309 and @var{version} is the Octave version number.\n\ 1309 and @var{version} is the Octave version number.\n\
1310 The default value may be overridden by the environment variable\n\ 1310 The default value may be overridden by the environment variable\n\
1312 @samp{--texi-macros-file NAME}.\n\ 1312 @samp{--texi-macros-file NAME}.\n\
1313 \n\ 1313 \n\
1314 When called from inside a function with the \"local\" option, the variable is\n\ 1314 When called from inside a function with the \"local\" option, the variable is\n\
1315 changed locally for the function and any subroutines it calls. The original\n\ 1315 changed locally for the function and any subroutines it calls. The original\n\
1316 variable value is restored when exiting the function.\n\ 1316 variable value is restored when exiting the function.\n\
1317 @seealso{lookfor, info_program, doc, help, makeinfo_program}\n\ 1317 @seealso{makeinfo_program}\n\
1318 @end deftypefn") 1318 @end deftypefn")
1319 { 1319 {
1320 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (texi_macros_file); 1320 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (texi_macros_file);
1321 } 1321 }
1322 1322
1376 Texinfo markup commands. The default value is @code{makeinfo}.\n\ 1376 Texinfo markup commands. The default value is @code{makeinfo}.\n\
1377 \n\ 1377 \n\
1378 When called from inside a function with the \"local\" option, the variable is\n\ 1378 When called from inside a function with the \"local\" option, the variable is\n\
1379 changed locally for the function and any subroutines it calls. The original\n\ 1379 changed locally for the function and any subroutines it calls. The original\n\
1380 variable value is restored when exiting the function.\n\ 1380 variable value is restored when exiting the function.\n\
1381 @seealso{info_file, info_program, doc, help}\n\ 1381 @seealso{texi_macros_file, info_file, info_program, doc, help}\n\
1382 @end deftypefn") 1382 @end deftypefn")
1383 { 1383 {
1384 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program); 1384 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program);
1385 } 1385 }
1386 1386