]> git.eshelyaron.com Git - emacs.git/commitdiff
(Hooks): Change description of calc-window-hook and
authorJay Belanger <jay.p.belanger@gmail.com>
Mon, 30 May 2005 21:04:46 +0000 (21:04 +0000)
committerJay Belanger <jay.p.belanger@gmail.com>
Mon, 30 May 2005 21:04:46 +0000 (21:04 +0000)
calc-trail-window-hook to match usage.
(Computational Functions): Add more constant-generating functions.
(Customizable Variables): Use defvar.

man/calc.texi

index 9b89282aa3d0249e60a2f16269752b7ea41245a9..3e8feaf14378f92717d690db07533147f779c42f 100644 (file)
@@ -33640,22 +33640,25 @@ example, for a rectangular complex number the result is the sum of
 the absolute values of the components.
 @end defun
 
-@findex two-pi
+@findex e
+@findex gamma-const
+@findex ln-2
+@findex ln-10
+@findex phi
 @findex pi-over-2
 @findex pi-over-4
 @findex pi-over-180
 @findex sqrt-two-pi
 @findex sqrt-e
-@findex e
-@findex ln-2
-@findex ln-10
+@findex two-pi
 @defun pi
 The function @samp{(pi)} computes @samp{pi} to the current precision.
 Other related constant-generating functions are @code{two-pi},
 @code{pi-over-2}, @code{pi-over-4}, @code{pi-over-180}, @code{sqrt-two-pi},
-@code{e}, @code{sqrt-e}, @code{ln-2}, and @code{ln-10}.  Each function
-returns a floating-point value in the current precision, and each uses
-caching so that all calls after the first are essentially free.
+@code{e}, @code{sqrt-e}, @code{ln-2}, @code{ln-10}, @code{phi} and
+@code{gamma-const}.  Each function returns a floating-point value in the
+current precision, and each uses caching so that all calls after the
+first are essentially free.
 @end defun
 
 @defmac math-defcache @var{func} @var{initial} @var{form}
@@ -34704,7 +34707,7 @@ step, before the Calc window is destroyed.
 @end defvar
 
 @defvar calc-window-hook
-If this hook exists, it is called to create the Calc window.
+If this hook is non-@code{nil}, it is called to create the Calc window.
 Upon return, this new Calc window should be the current window.
 (The Calc buffer will already be the current buffer when the
 hook is called.)  If the hook is not defined, Calc will
@@ -34713,10 +34716,10 @@ and @code{select-window} to create the Calc window.
 @end defvar
 
 @defvar calc-trail-window-hook
-If this hook exists, it is called to create the Calc Trail window.
-The variable @code{calc-trail-buffer} will contain the buffer
-which the window should use.  Unlike @code{calc-window-hook},
-this hook must @emph{not} switch into the new window.
+If this hook is non-@code{nil}, it is called to create the Calc Trail
+window.  The variable @code{calc-trail-buffer} will contain the buffer
+which the window should use.  Unlike @code{calc-window-hook}, this hook
+must @emph{not} switch into the new window.
 @end defvar
 
 @defvar calc-edit-mode-hook
@@ -34820,11 +34823,7 @@ expression is basically a pattern that Calc can search for.
 See @ref{Regexp Search,, Regular Expression Search, emacs, The GNU Emacs Manual}
 to see how regular expressions work.
 
-@table @code
-
-@item calc-settings-file
-
-@vindex calc-settings-file
+@defvar calc-settings-file
 The variable @code{calc-settings-file} holds the file name in
 which commands like @kbd{m m} and @kbd{Z P} store ``permanent''
 definitions.  
@@ -34834,9 +34833,9 @@ If @code{calc-settings-file} is not your user init file (typically
 exists) the first time Calc is invoked.
 
 The default value for this variable is @code{"~/.calc.el"}.
+@end defvar
 
-@item calc-gnuplot-name
-
+@defvar calc-gnuplot-name
 See @ref{Graphics}.@*
 The variable @code{calc-gnuplot-name} should be the name of the
 GNUPLOT program (a string).  If you have GNUPLOT installed on your
@@ -34845,10 +34844,10 @@ variable.  (@pxref{Customizable Variables})
 You may also need to set some Lisp variables to show Calc how to run
 GNUPLOT on your system, see @ref{Devices, ,Graphical Devices} .  The default value
 of @code{calc-gnuplot-name} is @code{"gnuplot"}.
+@end defvar
 
-@item  calc-gnuplot-plot-command
-@itemx calc-gnuplot-print-command
-
+@defvar  calc-gnuplot-plot-command
+@defvarx calc-gnuplot-print-command
 See @ref{Devices, ,Graphical Devices}.@*
 The variables @code{calc-gnuplot-plot-command} and
 @code{calc-gnuplot-print-command} represent system commands to
@@ -34861,9 +34860,9 @@ to display or print the output.
 The default value of @code{calc-gnuplot-plot-command} is @code{nil},
 and the default value of @code{calc-gnuplot-print-command} is
 @code{"lp %s"}.
+@end defvar
 
-@item calc-language-alist
-
+@defvar calc-language-alist
 See @ref{Basic Embedded Mode}.@*
 The variable @code{calc-language-alist} controls the languages that
 Calc will associate with major modes.  When Calc embedded mode is
@@ -34889,9 +34888,9 @@ The default value of @code{calc-language-alist} is
     (fortran-mode . fortran)
     (f90-mode . fortran))
 @end example
+@end defvar
 
-@item calc-embedded-announce-formula
-
+@defvar calc-embedded-announce-formula
 See @ref{Customizing Embedded Mode}.@*
 The variable @code{calc-embedded-announce-formula} helps determine
 what formulas @kbd{M-# a} will activate in a buffer.  It is a
@@ -34903,10 +34902,10 @@ activated.  (Calc also uses other patterns to find formulas, such as
 The default pattern is @code{"%Embed\n\\(% .*\n\\)*"}, which checks
 for @samp{%Embed} followed by any number of lines beginning with
 @samp{%} and a space.
+@end defvar
 
-@item  calc-embedded-open-formula
-@itemx calc-embedded-close-formula
-
+@defvar  calc-embedded-open-formula
+@defvarx calc-embedded-close-formula
 See @ref{Customizing Embedded Mode}.@*
 The variables @code{calc-embedded-open-formula} and
 @code{calc-embedded-open-formula} control the region that Calc will
@@ -34931,10 +34930,10 @@ Lines beginning with @samp{.EQ} and @samp{.EN} (@dfn{eqn} delimiters);
 @item
 Lines containing a single @samp{%} or @samp{.\"} symbol and nothing else.
 @end enumerate
+@end defvar
 
-@item  calc-embedded-open-word
-@itemx calc-embedded-close-word
-
+@defvar  calc-embedded-open-word
+@defvarx calc-embedded-close-word
 See @ref{Customizing Embedded Mode}.@*
 The variables @code{calc-embedded-open-word} and
 @code{calc-embedded-close-word} control the region that Calc will
@@ -34944,10 +34943,10 @@ regular expressions.
 The default values of @code{calc-embedded-open-word} and
 @code{calc-embedded-close-word} are @code{"^\\|[^-+0-9.eE]"} and 
 @code{"$\\|[^-+0-9.eE]"} respectively.
+@end defvar
 
-@item  calc-embedded-open-plain
-@itemx calc-embedded-close-plain
-
+@defvar  calc-embedded-open-plain
+@defvarx calc-embedded-close-plain
 See @ref{Customizing Embedded Mode}.@*
 The variables @code{calc-embedded-open-plain} and
 @code{calc-embedded-open-plain} are used to delimit ``plain''
@@ -34960,10 +34959,10 @@ The default string for @code{calc-embedded-open-plain} is
 @code{calc-embedded-close-plain} is @code{" %%%\n"}, without
 the trailing newline here, the first line of a Big mode formula
 that followed might be shifted over with respect to the other lines.
+@end defvar
 
-@item  calc-embedded-open-new-formula
-@itemx calc-embedded-close-new-formula
-
+@defvar  calc-embedded-open-new-formula
+@defvarx calc-embedded-close-new-formula
 See @ref{Customizing Embedded Mode}.@*
 The variables @code{calc-embedded-open-new-formula} and
 @code{calc-embedded-close-new-formula} are strings which are
@@ -34978,10 +34977,10 @@ also @code{"\n\n"}.  The final newline is omitted by @w{@kbd{M-# f}}
 if typed at the end of a line.  (It follows that if @kbd{M-# f} is
 typed on a blank line, both a leading opening newline and a trailing
 closing newline are omitted.)
+@end defvar
 
-@item  calc-embedded-open-mode
-@itemx calc-embedded-close-mode
-
+@defvar  calc-embedded-open-mode
+@defvarx calc-embedded-close-mode
 See @ref{Customizing Embedded Mode}.@*
 The variables @code{calc-embedded-open-mode} and
 @code{calc-embedded-close-mode} are strings which Calc will place before
@@ -34995,8 +34994,7 @@ and the default value of @code{calc-embedded-close-mode} is
 If you change the value of @code{calc-embedded-close-mode}, it is a good
 idea still to end with a newline so that mode annotations will appear on
 lines by themselves.
-
-@end table
+@end defvar
 
 @node Reporting Bugs, Summary, Customizable Variables, Top
 @appendix Reporting Bugs