--- DOCSTRINGS 2005-03-28 22:40:57.000000000 -0500 +++ DOCSTRINGS.new 2005-04-29 18:28:33.992040480 -0400 @@ -1291,10 +1291,10 @@ @end deftypefn I -*- texinfo -*- address@hidden {Built-in Variable} I address@hidden {Built-in Variable} J address@hidden {Built-in Variable} i address@hidden {Built-in Variable} j address@hidden {Built-in Constant} I address@hidden {Built-in Constant} J address@hidden {Built-in Constant} i address@hidden {Built-in Constant} j A pure imaginary number, defined as @iftex @tex @@ -1311,17 +1311,17 @@ @end defvr Inf -*- texinfo -*- address@hidden {Built-in Variable} Inf address@hidden {Built-in Variable} inf address@hidden {Built-in Constant} Inf address@hidden {Built-in Constant} inf Infinity. This is the result of an operation like 1/0, or an operation that results in a floating point overflow. @end defvr J -*- texinfo -*- address@hidden {Built-in Variable} I address@hidden {Built-in Variable} J address@hidden {Built-in Variable} i address@hidden {Built-in Variable} j address@hidden {Built-in Constant} I address@hidden {Built-in Constant} J address@hidden {Built-in Constant} i address@hidden {Built-in Constant} j A pure imaginary number, defined as @iftex @tex @@ -1338,13 +1338,13 @@ @end defvr NA -*- texinfo -*- address@hidden {Built-in Variable} NA address@hidden {Built-in Constant} NA Missing value. @end defvr NaN -*- texinfo -*- address@hidden {Built-in Variable} NaN address@hidden {Built-in Variable} nan address@hidden {Built-in Constant} NaN address@hidden {Built-in Constant} nan Not a number. This is the result of an operation like @iftex @tex @@ -1362,7 +1362,7 @@ @end defvr e -*- texinfo -*- address@hidden {Built-in Variable} e address@hidden {Built-in Constant} e The base of natural logarithms. The constant @iftex @tex @@ -1384,7 +1384,7 @@ @end defvr eps -*- texinfo -*- address@hidden {Built-in Variable} eps address@hidden {Built-in Constant} eps The machine precision. More precisely, @code{eps} is the largest relative spacing between any two adjacent numbers in the machine's floating point system. This number is obviously system-dependent. On @@ -1401,15 +1401,16 @@ @end defvr false -*- texinfo -*- address@hidden {Built-in Variable} false address@hidden {Built-in Constant} false Logical false value. address@hidden @end defvr i -*- texinfo -*- address@hidden {Built-in Variable} I address@hidden {Built-in Variable} J address@hidden {Built-in Variable} i address@hidden {Built-in Variable} j address@hidden {Built-in Constant} I address@hidden {Built-in Constant} J address@hidden {Built-in Constant} i address@hidden {Built-in Constant} j A pure imaginary number, defined as @iftex @tex @@ -1426,17 +1427,17 @@ @end defvr inf -*- texinfo -*- address@hidden {Built-in Variable} Inf address@hidden {Built-in Variable} inf address@hidden {Built-in Constant} Inf address@hidden {Built-in Constant} inf Infinity. This is the result of an operation like 1/0, or an operation that results in a floating point overflow. @end defvr j -*- texinfo -*- address@hidden {Built-in Variable} I address@hidden {Built-in Variable} J address@hidden {Built-in Variable} i address@hidden {Built-in Variable} j address@hidden {Built-in Constant} I address@hidden {Built-in Constant} J address@hidden {Built-in Constant} i address@hidden {Built-in Constant} j A pure imaginary number, defined as @iftex @tex @@ -1453,8 +1454,8 @@ @end defvr nan -*- texinfo -*- address@hidden {Built-in Variable} NaN address@hidden {Built-in Variable} nan address@hidden {Built-in Constant} NaN address@hidden {Built-in Constant} nan Not a number. This is the result of an operation like @iftex @tex @@ -1472,13 +1473,13 @@ @end defvr pi -*- texinfo -*- address@hidden {Built-in Variable} pi address@hidden {Built-in Constant} pi The ratio of the circumference of a circle to its diameter. Internally, @code{pi} is computed as @samp{4.0 * atan (1.0)}. @end defvr realmax -*- texinfo -*- address@hidden {Built-in Variable} realmax address@hidden {Built-in Constant} realmax The largest floating point number that is representable. The actual value is system-dependent. On machines that support 64-bit IEEE floating point arithmetic, @code{realmax} is approximately @@ -1490,10 +1491,11 @@ $1.7977\times10^{308}$. @end tex @end iftex address@hidden @end defvr realmin -*- texinfo -*- address@hidden {Built-in Variable} realmin address@hidden {Built-in Constant} realmin The smallest normalized floating point number that is representable. The actual value is system-dependent. On machines that support 64-bit IEEE floating point arithmetic, @code{realmin} is approximately @@ -1505,11 +1507,13 @@ $2.2251\times10^{-308}$. @end tex @end iftex address@hidden @end defvr true -*- texinfo -*- address@hidden {Built-in Variable} true address@hidden {Built-in Constant} true Logical true value. address@hidden @end defvr dbstop -*- texinfo -*- @@ -1665,12 +1669,12 @@ @end defvr OCTAVE_HOME -*- texinfo -*- address@hidden {Built-in Variable} OCTAVE_HOME address@hidden {Built-in Constant} OCTAVE_HOME The name of the top-level Octave installation directory. @end defvr OCTAVE_VERSION -*- texinfo -*- address@hidden {Built-in Variable} OCTAVE_VERSION address@hidden {Built-in Constant} OCTAVE_VERSION The version number of Octave, as a string. @end defvr det @@ -2740,7 +2744,7 @@ opened, by @code{tmpnam}, it is possible (though relatively unlikely) that it will not be available by the time your program attempts to open it. @end deftypefn address@hidden, mkstemp, and P_tmpdir} address@hidden, mkstemp, P_tmpdir} tmpfile -*- texinfo -*- @deftypefn {Built-in Function} address@hidden, @var{msg}] =} tmpfile () @@ -2753,7 +2757,7 @@ string. Otherwise, @var{fid} is -1 and @var{msg} contains a system-dependent error message. @end deftypefn address@hidden, mkstemp, and P_tmpdir} address@hidden, mkstemp, P_tmpdir} mkstemp -*- texinfo -*- @deftypefn {Built-in Function} address@hidden, @var{name}, @var{msg}] =} mkstemp (@var{template}, @var{delete}) @@ -2774,7 +2778,7 @@ is -1, @var{name} is empty, and @var{msg} contains a system-dependent error message. @end deftypefn address@hidden, tmpnam, and P_tmpdir} address@hidden, tmpnam, P_tmpdir} umask -*- texinfo -*- @deftypefn {Built-in Function} {} umask (@var{mask}) @@ -2785,15 +2789,15 @@ @end deftypefn P_tmpdir -*- texinfo -*- address@hidden {Built-in Variable} P_tmpdir address@hidden {Built-in Constant} P_tmpdir The default name of the directory for temporary files on this system. The value of this variable is system dependent. @end defvr SEEK_SET -*- texinfo -*- address@hidden {Built-in Variable} SEEK_SET address@hidden {Built-in Variable} SEEK_CUR address@hidden {Built-in Variable} SEEK_END address@hidden {Built-in Constant} SEEK_SET address@hidden {Built-in Constant} SEEK_CUR address@hidden {Built-in Constant} SEEK_END These variables may be used as the optional third argument for the function @code{fseek}. @@ -2810,33 +2814,39 @@ @end defvr SEEK_CUR -*- texinfo -*- address@hidden {Built-in Variable} SEEK_CUR address@hidden {Built-in Constant} SEEK_CUR See SEEK_SET. @end defvr SEEK_END -*- texinfo -*- address@hidden {Built-in Variable} SEEK_END address@hidden {Built-in Constant} SEEK_END See SEEK_SET. @end defvr stdin -*- texinfo -*- address@hidden {Built-in Variable} stdin address@hidden {Built-in Constant} stdin The standard input stream (file id 0). When Octave is used interactively, this is filtered through the command line editing functions. + address@hidden, stderr} @end defvr stdout -*- texinfo -*- address@hidden {Built-in Variable} stdout address@hidden {Built-in Constant} stdout The standard output stream (file id 1). Data written to the standard output is normally filtered through the pager. + address@hidden, stderr} @end defvr stderr -*- texinfo -*- address@hidden {Built-in Variable} stderr address@hidden {Built-in Constant} stderr The standard error stream (file id 2). Even if paging is turned on, the standard error is not sent to the pager. It is useful for error messages and prompts. + address@hidden, stdout} @end defvr filter -*- texinfo -*- @@ -6009,7 +6019,7 @@ Note: qz performs permutation balancing, but not scaling (see balance). Order of output arguments was selected for compatibility with MATLAB -See also: balance, dare, eig, schur address@hidden, dare, eig, schur @end deftypefn rand -*- texinfo -*- @@ -6294,7 +6304,7 @@ @end defvr SIG -*- texinfo -*- address@hidden {Built-in Variable} SIG address@hidden {Built-in Constant} SIG Structure of Unix signal names and their defined values. @end defvr sort @@ -6883,78 +6893,93 @@ @end deftypefn F_DUPFD -*- texinfo -*- address@hidden {Built-in Variable} F_DUPFD address@hidden {Built-in Constant} F_DUPFD Request to @code{fcntl} to return a duplicate file descriptor. address@hidden, F_GETFD, F_GETFL, F_SETFD, F_SETFL} @end defvr F_GETFD -*- texinfo -*- address@hidden {Built-in Variable} F_GETFD address@hidden {Built-in Constant} F_GETFD Request to @code{fcntl} to return the file descriptor flags. address@hidden, F_DUPFD, F_GETFL, F_SETFD, F_SETFL} @end defvr F_GETFL -*- texinfo -*- address@hidden {Built-in Variable} F_GETFL address@hidden {Built-in Constant} F_GETFL Request to @code{fcntl} to return the file status flags. address@hidden, F_DUPFD, F_GETFD, F_SETFD, F_SETFL} @end defvr F_SETFD -*- texinfo -*- address@hidden {Built-in Variable} F_SETFD address@hidden {Built-in Constant} F_SETFD Request to @code{fcntl} to set the file descriptor flags. address@hidden, F_DUPFD, F_GETFD, F_GETFL, F_SETFL} @end defvr F_SETFL -*- texinfo -*- address@hidden {Built-in Variable} F_SETFL address@hidden {Built-in Constant} F_SETFL Request to @code{fcntl} to set the file status flags. address@hidden, F_DUPFD, F_GETFD, F_GETFL, F_SETFD} @end defvr O_APPEND -*- texinfo -*- address@hidden {Built-in Variable} O_APPEND address@hidden {Built-in Constant} O_APPEND File status flag, append on each write. address@hidden, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY} @end defvr O_ASYNC -*- texinfo -*- address@hidden {Built-in Variable} O_ASYNC address@hidden {Built-in Constant} O_ASYNC File status flag, asynchronous I/O. address@hidden, O_APPEND, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY} @end defvr O_CREAT -*- texinfo -*- address@hidden {Built-in Variable} O_CREAT address@hidden {Built-in Constant} O_CREAT File status flag, create file if it does not exist. address@hidden, O_APPEND, O_ASYNC, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY} @end defvr O_EXCL -*- texinfo -*- address@hidden {Built-in Variable} O_EXCL address@hidden {Built-in Constant} O_EXCL File status flag, file locking. address@hidden, O_APPEND, O_ASYNC, O_CREAT, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY} @end defvr O_NONBLOCK -*- texinfo -*- address@hidden {Built-in Variable} O_NONBLOCK address@hidden {Built-in Constant} O_NONBLOCK File status flag, non-blocking I/O. address@hidden, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY} @end defvr O_RDONLY -*- texinfo -*- address@hidden {Built-in Variable} O_RDONLY address@hidden {Built-in Constant} O_RDONLY File status flag, file opened for reading only. address@hidden, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY} @end defvr O_RDWR -*- texinfo -*- address@hidden {Built-in Variable} O_RDWR address@hidden {Built-in Constant} O_RDWR File status flag, file open for both reading and writing. address@hidden, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_SYNC, O_TRUNC, O_WRONLY} @end defvr O_SYNC -*- texinfo -*- address@hidden {Built-in Variable} O_SYNC address@hidden {Built-in Constant} O_SYNC File status flag, file opened for synchronous I/O. address@hidden, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_TRUNC, O_WRONLY} @end defvr O_TRUNC -*- texinfo -*- address@hidden {Built-in Variable} O_TRUNC address@hidden {Built-in Constant} O_TRUNC File status flag, if file exists, truncate it when writing. address@hidden, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_WRONLY} @end defvr O_WRONLY -*- texinfo -*- address@hidden {Built-in Variable} O_WRONLY address@hidden {Built-in Constant} O_WRONLY File status flag, file opened for writing only. address@hidden, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC} @end defvr clc -*- texinfo -*- @@ -7381,7 +7406,7 @@ @end deftypefn argv -*- texinfo -*- address@hidden {Built-in Variable} argv address@hidden {Built-in Constant} argv The command line arguments passed to Octave are available in this variable. For example, if you invoked Octave using the command @@ -7399,8 +7424,8 @@ @end defvr program_invocation_name -*- texinfo -*- address@hidden {Built-in Variable} program_invocation_name address@hidden {Built-in Variable} program_name address@hidden {Built-in Constant} program_invocation_name address@hidden {Built-in Constant} program_name When Octave starts, the value of the built-in variable @code{program_invocation_name} is automatically set to the name that was typed at the shell prompt to run Octave, and the value of @@ -7418,22 +7443,8 @@ @end defvr program_name -*- texinfo -*- address@hidden {Built-in Variable} program_invocation_name address@hidden {Built-in Variable} program_name -When Octave starts, the value of the built-in variable address@hidden is automatically set to the name that was -typed at the shell prompt to run Octave, and the value of address@hidden is automatically set to the final component of address@hidden For example, if you typed address@hidden@value{OCTAVEHOME}/bin/octave} to start Octave, address@hidden would have the value address@hidden"@value{OCTAVEHOME}/bin/octave"}, and @code{program_name} would -have the value @code{"octave"}. - -If executing a script from the command line (e.g., @code{octave foo.m}) -or using an executable Octave script, the program name is set to the -name of the script. @xref{Executable Octave Programs}, for an example of -how to create an executable Octave script. address@hidden {Built-in Constant} program_name +SEE program_invocation_name. @end defvr isvarname -*- texinfo -*-