# HG changeset patch # User address@hidden # Date 1225465246 -3600 # Node ID 030004490d3c9722bd1a3c56f74da62f65be69c6 # Parent 971ac94d3e91cc1f0019b6c7eb49072b268ba8ba Remove descriptions of built-in variables from manual diff --git a/doc/ChangeLog b/doc/ChangeLog --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2008-10-31 Soren Hauberg + + * interpreter/var.txi: remove sections on built-in variables. + 2008-10-22 David Bateman * interprter/plot.txi: Add documentation for error bar series. diff --git a/doc/interpreter/var.txi b/doc/interpreter/var.txi --- a/doc/interpreter/var.txi +++ b/doc/interpreter/var.txi @@ -55,18 +55,18 @@ @dfn{assignment operators} and @dfn{increment operators}. @xref{Assignment Ops, ,Assignment Expressions}. -A number of variables have special built-in meanings. For example, address@hidden holds the current working directory, and @code{pi} names the -ratio of the circumference of a circle to its diameter. @xref{Summary of -Built-in Variables}, for a list of all the predefined variables. Some -of these built-in symbols are constants and may not be changed. Others -can be used and assigned just like all other variables, but their values -are also used or changed automatically by Octave. +There is one built-in variable with a special meaning. The @code{ans} variable +always contains the result of the last computation, where the output wasn't +assigned to any variable. The code @code{a = cos (pi)} will assign the value -1 +to the variable @code{a}, but will not change the value of @code{ans}. However, +the code @code{cos (pi)} will set the value of @code{ans} to -1. Variables in Octave do not have fixed types, so it is possible to first store a numeric value in a variable and then to later use the same name to hold a string value in the same program. Variables may not be used before they have been given a value. Doing so results in an error. + address@hidden(ans) @DOCSTRING(isvarname) @@ -368,209 +368,3 @@ @DOCSTRING(which) address@hidden Summary of Built-in Variables address@hidden Summary of Built-in Variables - -Here is a summary of all of Octave's built-in variables along with -cross references to additional information and their default values. In -the following table @var{octave-home} stands for the root directory -where all of Octave is installed (the default is @address@hidden, address@hidden stands for the Octave version number (for example, address@hidden) and @var{arch} stands for the type of system for which -Octave was compiled (for example, @code{x86_64-unknown-linux-gnu}). - address@hidden @code address@hidden EDITOR address@hidden For History}. - -Default value: @code{"emacs"}. - address@hidden EXEC_PATH address@hidden Subprocesses}. - -Default value: @code{":$PATH"}. - address@hidden OCTAVE_HOME - -Default value: @code{"@value{OCTAVEHOME}"}. - address@hidden PAGER address@hidden and Output}. - -Default value: @code{"less", or "more"}. - address@hidden PS1 address@hidden the Prompt}. - -Default value: @code{"\s:\#> "}. - address@hidden PS2 address@hidden the Prompt}. - -Default value: @code{"> "}. - address@hidden PS4 address@hidden the Prompt}. - -Default value: @code{"+ "}. - address@hidden beep_on_error address@hidden and Warnings}. - -Default value: 0. - address@hidden completion_append_char address@hidden For Completion}. - -Default value: @code{" "}. - address@hidden default_save_options address@hidden File I/O}. - -Default value: @code{"ascii"}. - address@hidden crash_dumps_octave_core address@hidden File I/O}. - -Default value: 1. - address@hidden fixed_point_format address@hidden - -Default value: 0. - address@hidden gnuplot_binary address@hidden Plotting}. - -Default value: @code{"gnuplot"}. - address@hidden history_file address@hidden For History}. - -Default value: @code{"~/.octave_hist"}. - address@hidden history_size address@hidden For History}. - -Default value: 1024. - address@hidden ignore_function_time_stamp address@hidden Files}. - -Default value: @code{"system"}. - address@hidden max_recursion_depth address@hidden - -Default value: 256. - address@hidden output_max_field_width address@hidden - -Default value: 10. - address@hidden output_precision address@hidden - -Default value: 5. - address@hidden page_screen_output address@hidden and Output}. - -Default value: 1. - address@hidden print_empty_dimensions address@hidden Matrices}. - -Default value: 1. - address@hidden save_precision address@hidden File I/O}. - -Default value: 17. - address@hidden saving_history address@hidden For History}. - -Default value: 1. - address@hidden sighup_dumps_octave_core address@hidden File I/O}. - -Default value: 1. - address@hidden sigterm_dumps_octave_core address@hidden File I/O}. - -Default value: 1. - address@hidden silent_functions address@hidden Functions}. - -Default value: 0. - address@hidden split_long_rows address@hidden - -Default value: 1. - address@hidden struct_levels_to_print address@hidden Structures}. - -Default value: 2. - address@hidden suppress_verbose_help_message address@hidden Help}. - -Default value: 1. address@hidden vtable - - address@hidden Defaults from the Environment address@hidden Defaults from the Environment - -Octave uses the values of the following environment variables to set the -default values for the corresponding built-in or internal variables. -In addition, the values from the environment may be overridden by -command-line arguments. @xref{Command Line Options}. - address@hidden @code address@hidden EDITOR address@hidden For History}. - -Built-in variable: @code{EDITOR}. - address@hidden OCTAVE_EXEC_PATH address@hidden Subprocesses}. - -Built-in variable: @code{EXEC_PATH}. -Command-line argument: @code{--exec-path}. - address@hidden OCTAVE_PATH address@hidden Files}. - -Internal variable changed by function @code{path}. -Command-line argument: @code{--path}. - address@hidden OCTAVE_INFO_FILE address@hidden Help}. - -Internal variable changed by function @code{info_file}. -Command-line argument: @code{--info-file}. - address@hidden OCTAVE_INFO_PROGRAM address@hidden Help}. - -Internal variable changed by function @code{info_program}. -Command-line argument: @code{--info-program}. - address@hidden OCTAVE_HISTSIZE address@hidden For History}. - -Built-in variable: @code{history_size}. - address@hidden OCTAVE_HISTFILE address@hidden For History}. - -Built-in variable: @code{history_file}. address@hidden vtable