From 0b128ac42684060c8183c645667dc4c6730e9ba3 Mon Sep 17 00:00:00 2001 From: Martin Rudalics Date: Tue, 15 May 2012 11:38:50 +0200 Subject: [PATCH] Some minor fixes of Elisp manual. * commands.texi (Recursive Editing): recursive-edit is a command. * compile.texi (Docs and Compilation): byte-compile-dynamic-docstrings is an option. * debugging.texi (Invoking the Debugger): debug is a command. * display.texi (Progress): progress-reporter-update and progress-reporter-force-update have VALUE argument optional. (Animated Images): Use non-@code{nil} instead of non-nil. * files.texi (Format Conversion Round-Trip): Use non-@code{nil} instead of non-nil. * frames.texi (Creating Frames): make-frame is a command. (Input Focus): select-frame is a command. (Pointer Shape): void-text-area-pointer is an option. * help.texi (Describing Characters): read-kbd-macro is a command. (Help Functions): describe-prefix-bindings is a command. * markers.texi (Creating Markers): Both arguments of copy-marker are optional. * minibuf.texi (Reading File Names): Use @kbd instead of @code. * modes.texi (Mode Line Variables): mode-line-remote and mode-line-client are not options. (Imenu): imenu-add-to-menubar is a command. (SMIE Indentation Helpers): Use non-@code{nil} instead of non-nil. * os.texi (Sound Output): play-sound-file is a command. * package.texi (Package Archives): Use @key{RET} instead of @kbd{RET}. * processes.texi (Signals to Processes): Use @key{RET} instead of @code{RET}. (Signals to Processes): signal-process is a command. * text.texi (Clickable Text): Use @key{RET} instead of @kbd{RET}. (Base 64): base64-encode-string is not a command while base64-decode-region is. * windows.texi (Switching Buffers): pop-to-buffer is a command. --- doc/lispref/ChangeLog | 52 ++++++++++++++++++++++++++++++++++++++ doc/lispref/commands.texi | 4 +-- doc/lispref/compile.texi | 4 +-- doc/lispref/debugging.texi | 4 +-- doc/lispref/display.texi | 6 ++--- doc/lispref/files.texi | 8 +++--- doc/lispref/frames.texi | 12 ++++----- doc/lispref/help.texi | 8 +++--- doc/lispref/markers.texi | 2 +- doc/lispref/minibuf.texi | 2 +- doc/lispref/modes.texi | 18 ++++++------- doc/lispref/os.texi | 4 +-- doc/lispref/package.texi | 4 +-- doc/lispref/processes.texi | 6 ++--- doc/lispref/text.texi | 10 ++++---- doc/lispref/windows.texi | 4 +-- 16 files changed, 100 insertions(+), 48 deletions(-) diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 273396e57c3..935815bc00c 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,55 @@ +2012-05-15 Martin Rudalics + + * commands.texi (Recursive Editing): recursive-edit is a + command. + + * compile.texi (Docs and Compilation): + byte-compile-dynamic-docstrings is an option. + + * debugging.texi (Invoking the Debugger): debug is a command. + + * display.texi (Progress): progress-reporter-update and + progress-reporter-force-update have VALUE argument optional. + (Animated Images): Use non-@code{nil} instead of non-nil. + + * files.texi (Format Conversion Round-Trip): Use non-@code{nil} + instead of non-nil. + + * frames.texi (Creating Frames): make-frame is a command. + (Input Focus): select-frame is a command. + (Pointer Shape): void-text-area-pointer is an option. + + * help.texi (Describing Characters): read-kbd-macro is a + command. + (Help Functions): describe-prefix-bindings is a command. + + * markers.texi (Creating Markers): Both arguments of copy-marker + are optional. + + * minibuf.texi (Reading File Names): Use @kbd instead of @code. + + * modes.texi (Mode Line Variables): mode-line-remote and + mode-line-client are not options. + (Imenu): imenu-add-to-menubar is a command. + (SMIE Indentation Helpers): Use non-@code{nil} instead of + non-nil. + + * os.texi (Sound Output): play-sound-file is a command. + + * package.texi (Package Archives): Use @key{RET} instead of + @kbd{RET}. + + * processes.texi (Signals to Processes): Use @key{RET} instead + of @code{RET}. + (Signals to Processes): signal-process is a command. + + * text.texi (Clickable Text): Use @key{RET} instead of + @kbd{RET}. + (Base 64): base64-encode-string is not a command while + base64-decode-region is. + + * windows.texi (Switching Buffers): pop-to-buffer is a command. + 2012-05-08 Glenn Morris * Makefile.in (clean, mostlyclean): Add some more vol1/2 items. diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index ec5a95a3f3b..a6dfbe2f8ee 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi @@ -3211,7 +3211,7 @@ a recursive edit but also provides the other features of the debugger. Recursive editing levels are also used when you type @kbd{C-r} in @code{query-replace} or use @kbd{C-x q} (@code{kbd-macro-query}). -@defun recursive-edit +@deffn Command recursive-edit @cindex suspend evaluation This function invokes the editor command loop. It is called automatically by the initialization of Emacs, to let the user begin @@ -3238,7 +3238,7 @@ then type @kbd{C-M-c} to exit and continue executing @code{simple-rec}. (simple-rec) @result{} nil @end example -@end defun +@end deffn @deffn Command exit-recursive-edit This function exits from the innermost recursive edit (including diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index 06767a4a329..032ba052484 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi @@ -291,10 +291,10 @@ is by adding this string to the file's first line: -*-byte-compile-dynamic-docstrings: nil;-*- @end example -@defvar byte-compile-dynamic-docstrings +@defopt byte-compile-dynamic-docstrings If this is non-@code{nil}, the byte compiler generates compiled files that are set up for dynamic loading of documentation strings. -@end defvar +@end defopt @node Dynamic Loading @section Dynamic Loading of Individual Functions diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi index 115d8ff42de..885766bd1cc 100644 --- a/doc/lispref/debugging.texi +++ b/doc/lispref/debugging.texi @@ -448,7 +448,7 @@ erroneously show up in this list. Here we describe in full detail the function @code{debug} that is used to invoke the debugger. -@defun debug &rest debugger-args +@deffn Command debug &rest debugger-args This function enters the debugger. It switches buffers to a buffer named @file{*Backtrace*} (or @file{*Backtrace*<2>} if it is the second recursive entry to the debugger, etc.), and fills it with information @@ -535,7 +535,7 @@ are printed on the top line of the buffer. You can use this feature to display messages---for example, to remind yourself of the conditions under which @code{debug} is called. @end table -@end defun +@end deffn @node Internals of Debugger @subsection Internals of the Debugger diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 1fe5a92e8a3..bc2a905a043 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -414,7 +414,7 @@ This function calls @code{progress-reporter-update}, so the first message is printed immediately. @end defun -@defun progress-reporter-update reporter value +@defun progress-reporter-update reporter &optional value This function does the main work of reporting progress of your operation. It displays the message of @var{reporter}, followed by progress percentage determined by @var{value}. If percentage is zero, @@ -435,7 +435,7 @@ try to reduce the number of calls to it: resulting overhead will most likely negate your effort. @end defun -@defun progress-reporter-force-update reporter value &optional new-message +@defun progress-reporter-force-update reporter &optional value new-message This function is similar to @code{progress-reporter-update} except that it prints a message in the echo area unconditionally. @@ -4905,7 +4905,7 @@ create animation. Currently, Emacs only supports animated GIF files. The following functions related to animated images are available. @defun image-animated-p image -This function returns non-nil if @var{image} can be animated. +This function returns non-@code{nil} if @var{image} can be animated. The actual return value is a cons @code{(@var{nimages} . @var{delay})}, where @var{nimages} is the number of frames and @var{delay} is the delay in seconds between them. diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index d18ba458969..f558089a205 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi @@ -3129,10 +3129,10 @@ in the order of appearance in the list. This command writes the current buffer contents into the file @var{file} in a format based on @var{format}, which is a list of format names. It constructs the actual format starting from @var{format}, then appending -any elements from the value of @code{buffer-file-format} with a non-nil -@var{preserve} flag (see above), if they are not already present in -@var{format}. It then updates @code{buffer-file-format} with this -format, making it the default for future saves. Except for the +any elements from the value of @code{buffer-file-format} with a +non-@code{nil} @var{preserve} flag (see above), if they are not already +present in @var{format}. It then updates @code{buffer-file-format} with +this format, making it the default for future saves. Except for the @var{format} argument, this command is similar to @code{write-file}. In particular, @var{confirm} has the same meaning and interactive treatment as the corresponding argument to @code{write-file}. @xref{Definition of diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 9d10326c294..29c3dcad404 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi @@ -109,7 +109,7 @@ for @code{framep} above. To create a new frame, call the function @code{make-frame}. -@defun make-frame &optional alist +@deffn Command make-frame &optional alist This function creates and returns a new frame, displaying the current buffer. @@ -135,7 +135,7 @@ This function itself does not make the new frame the selected frame. @xref{Input Focus}. The previously selected frame remains selected. On graphical terminals, however, the windowing system may select the new frame for its own reasons. -@end defun +@end deffn @defvar before-make-frame-hook A normal hook run by @code{make-frame} before it creates the frame. @@ -1396,7 +1396,7 @@ same meaning as for @code{select-frame} (see below). The return value of this function is not significant. @end defun -@defun select-frame frame &optional norecord +@deffn Command select-frame frame &optional norecord This function selects frame @var{frame}, temporarily disregarding the focus of the X server if any. The selection of @var{frame} lasts until the next time the user does something to select a different frame, or @@ -1419,7 +1419,7 @@ been deleted. In general, you should never use @code{select-frame} in a way that could switch to a different terminal without switching back when you're done. -@end defun +@end deffn Emacs cooperates with the window system by arranging to select frames as the server and window manager request. It does so by generating a @@ -1882,12 +1882,12 @@ of the buffer contents), the mouse pointer usually uses the @code{arrow} style, but you can specify a different style (one of those above) by setting @code{void-text-area-pointer}. -@defvar void-text-area-pointer +@defopt void-text-area-pointer This variable specifies the mouse pointer style for void text areas. These include the areas after the end of a line or below the last line in the buffer. The default is to use the @code{arrow} (non-text) pointer style. -@end defvar +@end defopt When using X, you can specify what the @code{text} pointer style really looks like by setting the variable @code{x-pointer-shape}. diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 3edeac2b6d5..16a2caf03b4 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -512,7 +512,7 @@ for Meta. @end smallexample @end defun -@defun read-kbd-macro string &optional need-vector +@deffn Command read-kbd-macro string &optional need-vector This function is used mainly for operating on keyboard macros, but it can also be used as a rough inverse for @code{key-description}. You call it with a string containing key descriptions, separated by spaces; @@ -520,7 +520,7 @@ it returns a string or vector containing the corresponding events. (This may or may not be a single valid key sequence, depending on what events you use; @pxref{Key Sequences}.) If @var{need-vector} is non-@code{nil}, the return value is always a vector. -@end defun +@end deffn @node Help Functions @section Help Functions @@ -627,12 +627,12 @@ character, and the help character has no binding after that prefix. The variable's default value is @code{describe-prefix-bindings}. @end defvar -@defun describe-prefix-bindings +@deffn Command describe-prefix-bindings This function calls @code{describe-bindings} to display a list of all the subcommands of the prefix key of the most recent key sequence. The prefix described consists of all but the last event of that key sequence. (The last event is, presumably, the help character.) -@end defun +@end deffn The following two functions are meant for modes that want to provide help without relinquishing control, such as the ``electric'' modes. diff --git a/doc/lispref/markers.texi b/doc/lispref/markers.texi index 25a9fc88fc5..1e8829396a7 100644 --- a/doc/lispref/markers.texi +++ b/doc/lispref/markers.texi @@ -206,7 +206,7 @@ chapter. @end example @end defun -@defun copy-marker marker-or-integer &optional insertion-type +@defun copy-marker &optional marker-or-integer insertion-type If passed a marker as its argument, @code{copy-marker} returns a new marker that points to the same place and the same buffer as does @var{marker-or-integer}. If passed an integer as its argument, diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index e40cbd14687..7b4e589a704 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi @@ -1404,7 +1404,7 @@ returns the pre-inserted contents of the minibuffer. If the user types @key{RET} in an empty minibuffer, this function returns an empty string, regardless of the value of @var{require-match}. This is, for instance, how the user can make the -current buffer visit no file using @code{M-x set-visited-file-name}. +current buffer visit no file using @kbd{M-x set-visited-file-name}. If @var{predicate} is non-@code{nil}, it specifies a function of one argument that decides which file names are acceptable completion diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index e9be9f1763f..e42011c34a2 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1991,14 +1991,14 @@ default value also displays the recursive editing level, information on the process status, and whether narrowing is in effect. @end defopt -@defopt mode-line-remote +@defvar mode-line-remote This variable is used to show whether @code{default-directory} for the current buffer is remote. -@end defopt +@end defvar -@defopt mode-line-client +@defvar mode-line-client This variable is used to identify @code{emacsclient} frames. -@end defopt +@end defvar The following three variables are used in @code{mode-line-modes}: @@ -2316,10 +2316,10 @@ definitions, or other named portions of the buffer; then the user can choose one of them and move point to it. Major modes can add a menu bar item to use Imenu using @code{imenu-add-to-menubar}. -@defun imenu-add-to-menubar name +@deffn Command imenu-add-to-menubar name This function defines a local menu bar item named @var{name} to run Imenu. -@end defun +@end deffn The user-level commands for using Imenu are described in the Emacs Manual (@pxref{Imenu,, Imenu, emacs, the Emacs Manual}). This section @@ -3861,9 +3861,9 @@ Return non-@code{nil} if the current token's parent is among @var{parents}. @end defun @defun smie-rule-sibling-p -Return non-nil if the current token's parent is actually a sibling. -This is the case for example when the parent of a @code{","} is just the -previous @code{","}. +Return non-@code{nil} if the current token's parent is actually a +sibling. This is the case for example when the parent of a @code{","} +is just the previous @code{","}. @end defun @defun smie-rule-parent &optional offset diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 35ac7c20384..384531c8e37 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi @@ -2106,10 +2106,10 @@ calls the functions in the list @code{play-sound-functions}. Each function is called with one argument, @var{sound}. @end defun -@defun play-sound-file file &optional volume device +@deffn Command play-sound-file file &optional volume device This function is an alternative interface to playing a sound @var{file} specifying an optional @var{volume} and @var{device}. -@end defun +@end deffn @defvar play-sound-functions A list of functions to be called before playing a sound. Each function diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi index e9737f15a1c..387fba52c63 100644 --- a/doc/lispref/package.texi +++ b/doc/lispref/package.texi @@ -295,8 +295,8 @@ How to accomplish this is beyond the scope of this manual. A convenient way to set up and update a package archive is via the @code{package-x} library. This is included with Emacs, but not loaded -by default; type @kbd{M-x load-library @kbd{RET} package-x @kbd{RET}} -to load it, or add @code{(require 'package-x)} to your init file. +by default; type @kbd{M-x load-library @key{RET} package-x @key{RET}} to +load it, or add @code{(require 'package-x)} to your init file. @xref{Lisp Libraries,, Lisp Libraries, emacs, The GNU Emacs Manual}. Once loaded, you can make use of the following: diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index 6275ce0b1b7..7426437e6f0 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi @@ -1071,7 +1071,7 @@ job-control shells won't work when a pipe is used. See @defun interrupt-process &optional process current-group This function interrupts the process @var{process} by sending the signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt -character'' (normally @kbd{C-c} on some systems, and @code{DEL} on +character'' (normally @kbd{C-c} on some systems, and @key{DEL} on others) sends this signal. When the argument @var{current-group} is non-@code{nil}, you can think of this function as ``typing @kbd{C-c}'' on the terminal by which Emacs talks to the subprocess. @@ -1110,7 +1110,7 @@ it the signal @code{SIGCONT}. This presumes that @var{process} was stopped previously. @end defun -@defun signal-process process signal +@deffn Command signal-process process signal This function sends a signal to process @var{process}. The argument @var{signal} specifies which signal to send; it should be an integer, or a symbol whose name is a signal. @@ -1118,7 +1118,7 @@ or a symbol whose name is a signal. The @var{process} argument can be a system process @acronym{ID} (an integer); that allows you to send signals to processes that are not children of Emacs. @xref{System Processes}. -@end defun +@end deffn @node Output from Processes @section Receiving Output from Processes diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 3e9135a7d81..1963d2519a3 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -3531,7 +3531,7 @@ properties. For simplicity, we will refer to the clickable text as a @dfn{link}. Implementing a link involves three separate steps: (1) indicating -clickability when the mouse moves over the link; (2) making @kbd{RET} +clickability when the mouse moves over the link; (2) making @key{RET} or @kbd{Mouse-2} on that link do something; and (3) setting up a @code{follow-link} condition so that the link obeys @code{mouse-1-click-follows-link}. @@ -4069,7 +4069,7 @@ text, to avoid overlong lines. However, if the optional argument the output is just one long line. @end deffn -@deffn Command base64-encode-string string &optional no-line-break +@defun base64-encode-string string &optional no-line-break This function converts the string @var{string} into base 64 code. It returns a string containing the encoded text. As for @code{base64-encode-region}, an error is signaled if a character in the @@ -4079,15 +4079,15 @@ Normally, this function inserts newline characters into the encoded text, to avoid overlong lines. However, if the optional argument @var{no-line-break} is non-@code{nil}, these newlines are not added, so the result string is just one long line. -@end deffn +@end defun -@defun base64-decode-region beg end +@deffn Command base64-decode-region beg end This function converts the region from @var{beg} to @var{end} from base 64 code into the corresponding decoded text. It returns the length of the decoded text. The decoding functions ignore newline characters in the encoded text. -@end defun +@end deffn @defun base64-decode-string string This function converts the string @var{string} from base 64 code into diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index c8a9316bcfa..75d4a9beb8c 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi @@ -1559,7 +1559,7 @@ displaying the buffer. Hence, all the variables affecting @code{display-buffer} will affect it as well. @xref{Choosing Window}, for the documentation of @code{display-buffer}. -@defun pop-to-buffer buffer-or-name &optional action norecord +@deffn Command pop-to-buffer buffer-or-name &optional action norecord This function makes @var{buffer-or-name} the current buffer and displays it in some window, preferably not the window previously selected. It then selects the displaying window. If that window is @@ -1582,7 +1582,7 @@ displayed in the selected window. Like @code{switch-to-buffer}, this function updates the buffer list unless @var{norecord} is non-@code{nil}. -@end defun +@end deffn @node Choosing Window @section Choosing a Window for Display -- 2.39.2