From 4181427f24e591f539122db2e3d8d8b55a7de7cd Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Sun, 8 Jun 2014 16:39:23 -0700 Subject: [PATCH] Doc fixes: markup (mainly nil -> @code{nil}) --- doc/emacs/rmail.texi | 4 +-- doc/lispref/anti.texi | 2 +- doc/lispref/display.texi | 8 ++--- doc/lispref/keymaps.texi | 4 +-- doc/lispref/modes.texi | 8 ++--- doc/lispref/os.texi | 2 +- doc/lispref/sequences.texi | 2 +- doc/lispref/text.texi | 4 +-- doc/misc/calc.texi | 4 +-- doc/misc/cc-mode.texi | 6 ++-- doc/misc/ede.texi | 18 +++++------ doc/misc/efaq-w32.texi | 8 ++--- doc/misc/efaq.texi | 2 +- doc/misc/eieio.texi | 8 ++--- doc/misc/emacs-gnutls.texi | 2 +- doc/misc/ert.texi | 14 ++++---- doc/misc/eshell.texi | 4 +-- doc/misc/gnus-faq.texi | 66 +++++++++++++++++++------------------- doc/misc/gnus.texi | 17 +++++----- doc/misc/htmlfontify.texi | 4 +-- doc/misc/idlwave.texi | 2 +- doc/misc/mairix-el.texi | 2 +- doc/misc/message.texi | 2 +- doc/misc/mh-e.texi | 2 +- doc/misc/reftex.texi | 20 ++++++------ doc/misc/srecode.texi | 4 +-- doc/misc/todo-mode.texi | 24 +++++++------- doc/misc/url.texi | 2 +- doc/misc/wisent.texi | 4 +-- 29 files changed, 125 insertions(+), 124 deletions(-) diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index 72f3034a83..6fab25a187 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi @@ -753,7 +753,7 @@ in replies, using the variable @code{mail-dont-reply-to-names}. Its value should be a regular expression; any recipients that match are excluded from the @samp{CC} field. They are also excluded from the @samp{To} field, unless this would leave the field empty. If this -variable is nil, then the first time you compose a reply it is +variable is @code{nil}, then the first time you compose a reply it is initialized to a default value that matches your own address. To omit the @samp{CC} field completely for a particular reply, enter @@ -962,7 +962,7 @@ making any kind of summary discards any previous summary. use for the summary window. The variable @code{rmail-summary-line-count-flag} controls whether the summary line for a message should include the line count of the message. Setting -this option to nil might speed up the generation of summaries. +this option to @code{nil} might speed up the generation of summaries. @node Rmail Summary Edit @subsection Editing in Summaries diff --git a/doc/lispref/anti.texi b/doc/lispref/anti.texi index 3de9f4ab9d..2ca2290a02 100644 --- a/doc/lispref/anti.texi +++ b/doc/lispref/anti.texi @@ -30,7 +30,7 @@ minimum of fuss. But @xref{Dynamic Binding Tips}, for tips to avoid making your programs hard to understand. @item -Calling a minor mode function from Lisp with a nil or omitted argument +Calling a minor mode function from Lisp with a @code{nil} or omitted argument does not enable the minor mode unconditionally; instead, it toggles the minor mode---which is the straightforward thing to do, since that is the behavior when invoked interactively. One downside is that it diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index b4f987bb2a..e0349e4ca0 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -1720,10 +1720,10 @@ Properties}. @defun overlays-at pos &optional sorted This function returns a list of all the overlays that cover the character at -position @var{pos} in the current buffer. If @var{sorted} is non-nil, the list -is in decreasing order of priority, otherwise it is in no particular order. -An overlay contains position @var{pos} if it begins at or before @var{pos}, and -ends after @var{pos}. +position @var{pos} in the current buffer. If @var{sorted} is non-@code{nil}, +the list is in decreasing order of priority, otherwise it is in no particular +order. An overlay contains position @var{pos} if it begins at or before +@var{pos}, and ends after @var{pos}. To illustrate usage, here is a Lisp function that returns a list of the overlays that specify property @var{prop} for the character at point: diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index a2168d3e53..7cc2b39345 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi @@ -2901,7 +2901,7 @@ Documentation}). @item :key-sequence @var{keys} @var{keys} is a hint for speeding up Emacs's first display of the -menu. It should be nil if you know that the menu item has no keyboard +menu. It should be @code{nil} if you know that the menu item has no keyboard equivalent; otherwise it should be a string or vector specifying a keyboard equivalent for the menu item. @@ -2929,7 +2929,7 @@ anything else (meaning an ordinary menu item). @item :selected @var{selected} @var{selected} is an expression; the checkbox or radio button is -selected whenever the expression's value is non-nil. +selected whenever the expression's value is non-@code{nil}. @item :help @var{help} @var{help} is a string describing the menu item. diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index c30547e65a..e23e2685a7 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -702,7 +702,7 @@ mode and minor modes. It uses the @code{documentation} function to retrieve the documentation strings of the major and minor mode commands (@pxref{Accessing Documentation}). -If called from Lisp with a non-nil @var{buffer} argument, this +If called from Lisp with a non-@code{nil} @var{buffer} argument, this function displays the documentation for that buffer's major and minor modes, rather than those of the current buffer. @end deffn @@ -3804,8 +3804,8 @@ expressions (not separated by any token) rather than an expression. @end itemize When @var{arg} is a token, the function is called with point just before -that token. A return value of nil always means to fallback on the -default behavior, so the function should return nil for arguments it +that token. A return value of @code{nil} always means to fallback on the +default behavior, so the function should return @code{nil} for arguments it does not expect. @var{offset} can be: @@ -3904,7 +3904,7 @@ A few things to note: @itemize @item The first case indicates the basic indentation increment to use. -If @code{sample-indent-basic} is nil, then SMIE uses the global +If @code{sample-indent-basic} is @code{nil}, then SMIE uses the global setting @code{smie-indent-basic}. The major mode could have set @code{smie-indent-basic} buffer-locally instead, but that is discouraged. diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 59ad376436..3b63e08676 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi @@ -748,7 +748,7 @@ Here is an example of how you could use these hooks: (add-hook 'suspend-resume-hook (lambda () (message "Resumed!") (sit-for 2))) @end smallexample -@c The sit-for prevents the ``nil'' that suspend-emacs returns +@c The sit-for prevents the @code{nil} that suspend-emacs returns @c hiding the message. Here is what you would see upon evaluating @code{(suspend-emacs "pwd")}: diff --git a/doc/lispref/sequences.texi b/doc/lispref/sequences.texi index 01de4ccb0c..b518bfc6b7 100644 --- a/doc/lispref/sequences.texi +++ b/doc/lispref/sequences.texi @@ -747,7 +747,7 @@ argument @var{b} is given, the result of this operation is stored into @defun bool-vector-subsetp a b Return @code{t} if every @code{t} value in @var{a} is also t in -@var{b}, nil otherwise. All arguments should be bool vectors of the +@var{b}, @code{nil} otherwise. All arguments should be bool vectors of the same length. @end defun diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 4c3286adbf..6665cc3e67 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -806,7 +806,7 @@ non-whitespace character in each line in the region. If this command acts on the entire buffer (i.e. if called interactively with the mark inactive, or called from Lisp with -@var{end} nil), it also deletes all trailing lines at the end of the +@var{end} @code{nil}), it also deletes all trailing lines at the end of the buffer if the variable @code{delete-trailing-lines} is non-@code{nil}. @end deffn @@ -2865,7 +2865,7 @@ adding the face @var{face} to the @code{face} text property. (@pxref{Special Properties}), such as a face name or an anonymous face (@pxref{Faces}). -If any text in the region already has a non-nil @code{face} property, +If any text in the region already has a non-@code{nil} @code{face} property, those face(s) are retained. This function sets the @code{face} property to a list of faces, with @var{face} as the first element (by default) and the pre-existing faces as the remaining elements. If the diff --git a/doc/misc/calc.texi b/doc/misc/calc.texi index 93c873e2ed..56aa2d04a1 100644 --- a/doc/misc/calc.texi +++ b/doc/misc/calc.texi @@ -21624,7 +21624,7 @@ to @noindent Every character not part of the sub-formula @samp{b} has been changed to a dot. (If the customizable variable -@code{calc-highlight-selections-with-faces} is non-nil, then the characters +@code{calc-highlight-selections-with-faces} is non-@code{nil}, then the characters not part of the sub-formula are de-emphasized by using a less noticeable face instead of using dots. @pxref{Displaying Selections}.) The @samp{*} next to the line number is to remind you that @@ -21858,7 +21858,7 @@ by @samp{#} signs: @end group @end smallexample If the customizable variable -@code{calc-highlight-selections-with-faces} is non-nil, then the +@code{calc-highlight-selections-with-faces} is non-@code{nil}, then the non-selected portion of the formula will be de-emphasized by using a less noticeable face (@code{calc-nonselected-face}) instead of dots and the selected sub-formula will be highlighted by using a more diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi index 35aea2889a..cbb49e00ef 100644 --- a/doc/misc/cc-mode.texi +++ b/doc/misc/cc-mode.texi @@ -3915,7 +3915,7 @@ Conceptually, a line of code is always indented relative to some position higher up in the buffer (typically the indentation of the previous line). That position is the @dfn{anchor position} in the syntactic element. If there is an entry after the syntactic symbol in -the syntactic element list then it's either nil or that anchor position. +the syntactic element list then it's either @code{nil} or that anchor position. Here is an example. Suppose we had the following code as the only thing in a C++ buffer @footnote{The line numbers in this and future examples @@ -6067,7 +6067,7 @@ suggestion to get a consistent style): @defun c-lineup-assignments @findex lineup-assignments (c-) Line up the current line after the assignment operator on the first line -in the statement. If there isn't any, return nil to allow stacking with +in the statement. If there isn't any, return @code{nil} to allow stacking with other line-up functions. If the current line contains an assignment operator too, try to align it with the first one. @@ -6532,7 +6532,7 @@ Return the syntactic symbol in @var{langelem}. @defun c-langelem-pos langelem @findex langelem-pos (c-) -Return the anchor position in @var{langelem}, or nil if there is none. +Return the anchor position in @var{langelem}, or @code{nil} if there is none. @end defun @defun c-langelem-col langelem &optional preserve-point diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi index 0bf1983cdc..89e576b8c2 100644 --- a/doc/misc/ede.texi +++ b/doc/misc/ede.texi @@ -1200,7 +1200,7 @@ until one of them returns true. The method from the autoload. If it is a string (i.e., a project file name), it checks to see if that exists in BUFFER's directory. If it is a function, then it calls that function and expects it to return a file -name or nil. If the file exists, then this directory is assumed to be +name or @code{nil}. If the file exists, then this directory is assumed to be part of a project, and @code{ede-directory-project-p} returns the instance of @code{ede-project-autoload} that matched. @@ -1275,11 +1275,11 @@ Return a string that is the name of the target used by a Make system. A brief description of the project or target. This is currently used by the @samp{ede-speedbar} interface. @item ede-want-file-p -Return non-nil if a target will accept a given file. +Return non-@code{nil} if a target will accept a given file. It is generally unnecessary to override this. See the section on source code. @item ede-buffer-mine -Return non-nil if a buffer belongs to this target. Used during +Return non-@code{nil} if a buffer belongs to this target. Used during association when a file is loaded. It is generally unnecessary to override this unless you keep auxiliary files. @end table @@ -1614,7 +1614,7 @@ Provide a speedbar description for @var{OBJ}. @end deffn @deffn Method ede-map-any-target-p :AFTER this proc -For project @var{THIS}, map @var{PROC} to all targets and return if any non-nil. +For project @var{THIS}, map @var{PROC} to all targets and return if any non-@code{nil}. Return the first non-@code{nil} value returned by @var{PROC}. @end deffn @@ -1768,7 +1768,7 @@ If @var{TARGET} belongs to a subproject, return that project file. @end deffn @deffn Method ede-find-target :AFTER proj buffer -Fetch the target in @var{PROJ} belonging to @var{BUFFER} or nil. +Fetch the target in @var{PROJ} belonging to @var{BUFFER} or @code{nil}. @end deffn @deffn Method ede-add-subproject :AFTER proj-a proj-b @@ -1884,8 +1884,8 @@ The function symbol must take two arguments: NAME - The name of the file to find. DIR - The directory root for this cpp-root project. -It should return the fully qualified file name passed in from NAME@. If that file does not -exist, it should return nil. +It should return the fully qualified file name passed in from NAME@. +If that file does not exist, it should return @code{nil}. @end table @@ -2047,7 +2047,7 @@ Default Value: @code{nil} Non-@code{nil} if this is a metasubproject. Usually, a subproject is determined by a parent project. If multiple top level projects are grouped into a large project not maintained by EDE, then you need -to set this to non-nil. The only effect is that the @code{dist} rule will then avoid +to set this to non-@code{nil}. The only effect is that the @code{dist} rule will then avoid making a tar file. @end table @@ -2281,7 +2281,7 @@ Default Value: @code{nil} Non-@code{nil} if this is a metasubproject. Usually, a subproject is determined by a parent project. If multiple top level projects are grouped into a large project not maintained by EDE, then you need -to set this to non-nil. The only effect is that the @code{dist} rule will then avoid +to set this to non-@code{nil}. The only effect is that the @code{dist} rule will then avoid making a tar file. @end table diff --git a/doc/misc/efaq-w32.texi b/doc/misc/efaq-w32.texi index 314aa8db36..c59f7547d8 100644 --- a/doc/misc/efaq-w32.texi +++ b/doc/misc/efaq-w32.texi @@ -1176,8 +1176,8 @@ Place the following in your init file: @cindex font menu, adding fonts @vindex w32-fixed-font-alist -If you have set w32-use-w32-font-dialog to nil, you can add fonts to -the font menu by changing `w32-fixed-font-alist'. For example: +If you have set w32-use-w32-font-dialog to @code{nil}, you can add fonts to +the font menu by changing @code{w32-fixed-font-alist}. For example: @example (setq w32-fixed-font-alist @@ -1664,8 +1664,8 @@ smtpmail is loaded, then you'll need to change @code{smtpmail-smtp-server}. If you are experiencing problems with sending large messages, check -the value of the variable @code{smtpmail-debug-info}. If it is non-nil, you -should set it to @code{nil}: +the value of the variable @code{smtpmail-debug-info}. If it is +non-@code{nil}, you should set it to @code{nil}: @node Incoming mail with Rmail @subsection Incoming mail with Rmail and POP3 diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi index 51d2cc00d5..c320b8b6c0 100644 --- a/doc/misc/efaq.texi +++ b/doc/misc/efaq.texi @@ -1948,7 +1948,7 @@ automatically scrolls the display horizontally when point moves off the left or right edge of the window. Note that this is overridden by the variable -@code{truncate-partial-width-windows} if that variable is non-nil +@code{truncate-partial-width-windows} if that variable is non-@code{nil} and the current buffer is not full-frame width. In Emacs 20, use @code{hscroll-mode}. diff --git a/doc/misc/eieio.texi b/doc/misc/eieio.texi index d65bcf1d28..937fae2690 100644 --- a/doc/misc/eieio.texi +++ b/doc/misc/eieio.texi @@ -306,7 +306,7 @@ or is of a subclass of @var{CLASS-NAME}. @end defun @defvar eieio-error-unsupported-class-tags -If non-nil, @code{defclass} signals an error if a tag in a slot +If non-@code{nil}, @code{defclass} signals an error if a tag in a slot specifier is unsupported. This option is here to support programs written with older versions of @@ -471,7 +471,7 @@ Here are some examples: @item my-class-name An object of your class type. @item (or null symbol) - A symbol, or nil. + A symbol, or @code{nil}. @end table @item :allocation @@ -573,7 +573,7 @@ prefixed by the @code{:documentation} tag, and appears after the list of slots, and before the options. @item :allow-nil-initform -If this option is non-nil, and the @code{:initform} is @code{nil}, but +If this option is non-@code{nil}, and the @code{:initform} is @code{nil}, but the @code{:type} is specifies something such as @code{string} then allow this to pass. The default is to have this option be off. This is implemented as an alternative to unbound slots. @@ -1264,7 +1264,7 @@ Return the list of public slots for @var{obj}. @defun class-slot-initarg class slot For the given @var{class} return the :initarg associated with @var{slot}. Not all slots have initargs, so the return value can be -nil. +@code{nil}. @end defun @node Base Classes diff --git a/doc/misc/emacs-gnutls.texi b/doc/misc/emacs-gnutls.texi index 844579c1f9..bc054ac76b 100644 --- a/doc/misc/emacs-gnutls.texi +++ b/doc/misc/emacs-gnutls.texi @@ -94,7 +94,7 @@ There's one way to find out if GnuTLS is available, by calling Zaretskii) in the same directory as Emacs, you should be OK. @defun gnutls-available-p -This function returns t if GnuTLS is available in this instance of Emacs. +This function returns @code{t} if GnuTLS is available in this instance of Emacs. @end defun Oh, but sometimes things go wrong. Budgets aren't balanced, diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi index 25174a396a..ec1614c714 100644 --- a/doc/misc/ert.texi +++ b/doc/misc/ert.texi @@ -139,8 +139,7 @@ An ERT test definition equivalent to the above comments is this: If you know @code{defun}, the syntax of @code{ert-deftest} should look familiar: This example defines a test named @code{pp-test-quote} that -will pass if the three calls to @code{equal} all return true -(non-nil). +will pass if the three calls to @code{equal} all return non-@code{nil}. @code{should} is a macro with the same meaning as @code{cl-assert} but better error reporting. @xref{The @code{should} Macro}. @@ -315,7 +314,8 @@ tests or symbols naming tests. @item @code{(tag TAG)} selects all tests that have TAG on their tags list. (Tags are optional labels you can apply to tests when you define them.) @item @code{(satisfies PREDICATE)} selects all tests that satisfy PREDICATE, -a function that takes a test as argument and returns non-nil if it is selected. +a function that takes a test as argument and returns non-@code{nil} if +it is selected. @end itemize Selectors that are frequently useful when selecting tests to run @@ -382,13 +382,13 @@ F addition-test @end example In this example, @code{should} recorded the fact that (= (+ 1 2) 4) -reduced to (= 3 4) before it reduced to nil. When debugging why the +reduced to (= 3 4) before it reduced to @code{nil}. When debugging why the test failed, it helps to know that the function @code{+} returned 3 here. ERT records the return value for any predicate called directly within @code{should}. In addition to @code{should}, ERT provides @code{should-not}, which -checks that the predicate returns nil, and @code{should-error}, which +checks that the predicate returns @code{nil}, and @code{should-error}, which checks that the form called within it signals an error. An example use of @code{should-error}: @@ -531,7 +531,7 @@ Instead, it is better to use lower-level mechanisms with simple and predictable semantics like @code{with-temp-buffer}, @code{insert} or @code{insert-file-contents-literally}, and to activate any desired mode by calling the corresponding function directly, after binding the -hook variables to nil. This avoids the above problems. +hook variables to @code{nil}. This avoids the above problems. @node Useful Techniques @@ -761,7 +761,7 @@ the arguments given to the explanation function, returns the value that it returns. The explanation can be any object but should have a comprehensible printed representation. If the return value of the predicate needs no explanation for a given list of arguments, the -explanation function should return nil. +explanation function should return @code{nil}. To associate an explanation function with a predicate, add the property @code{ert-explainer} to the symbol that names the predicate. diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi index 67aa4799f7..e7c3c71afd 100644 --- a/doc/misc/eshell.texi +++ b/doc/misc/eshell.texi @@ -676,8 +676,8 @@ You can, of course, define your own virtual targets. They are defined by adding a list of the form @samp{("/dev/name" @var{function} @var{mode})} to @code{eshell-virtual-targets}. The first element is the device name; @var{function} may be either a lambda or a function name. If -@var{mode} is nil, then the function is the output function; if it is -non-nil, then the function is passed the redirection mode as a +@var{mode} is @code{nil}, then the function is the output function; if it is +non-@code{nil}, then the function is passed the redirection mode as a symbol--@code{overwrite} for @code{>}, @code{append} for @code{>>}, or @code{insert} for @code{>>>}--and the function is expected to return the output function. diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index 858ce8c2a5..7bb89fdf02 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi @@ -377,7 +377,7 @@ but it only says "nntp (news) open error", what to do? You've got to tell Gnus where to fetch the news from. Read the documentation for information on how to do this. As a -first start, put those lines in ~/.gnus.el: +first start, put those lines in @file{~/.gnus.el}: @example (setq gnus-select-method '(nntp "news.yourprovider.net")) @@ -389,7 +389,7 @@ first start, put those lines in ~/.gnus.el: @node FAQ 3-2 @subsubheading Question 3.2 -I'm working under Windows and have no idea what ~/.gnus.el means. +I'm working under Windows and have no idea what @file{~/.gnus.el} means. @subsubheading Answer @@ -421,7 +421,7 @@ to Control Panel -> System -> Advanced). There you'll find the possibility to set environment variables. Create a new one with name HOME and value C:\myhome. Rebooting is not necessary. -Now to create ~/.gnus.el, say +Now to create @file{~/.gnus.el}, say @samp{C-x C-f ~/.gnus.el RET C-x C-s}. in Emacs. @@ -495,7 +495,7 @@ I want Gnus to fetch news from several servers, is this possible? Of course. You can specify more sources for articles in the variable gnus-secondary-select-methods. Add something like -this in ~/.gnus.el: +this in @file{~/.gnus.el}: @example (add-to-list 'gnus-secondary-select-methods @@ -566,7 +566,7 @@ commonly used one is nnml. It stores every mail in one file and is therefore quite fast. However you might prefer a one file per group approach if your file system has problems with many small files, the nnfolder back end is then probably the -choice for you. To use nnml add the following to ~/.gnus.el: +choice for you. To use nnml add the following to @file{~/.gnus.el}: @example (add-to-list 'gnus-secondary-select-methods '(nnml "")) @@ -591,7 +591,7 @@ it's a POP3 server, then you need something like this: @end example @noindent -Make sure ~/.gnus.el isn't readable to others if you store +Make sure @file{~/.gnus.el} isn't readable to others if you store your password there. If you want to read your mail from a traditional spool file on your local machine, it's @@ -630,7 +630,7 @@ OK, now you only need to tell Gnus how to send mail. If you want to send mail via sendmail (or whichever MTA is playing the role of sendmail on your system), you don't need to do anything. However, if you want to send your mail to an -SMTP Server you need the following in your ~/.gnus.el +SMTP Server you need the following in your @file{~/.gnus.el} @example (setq send-mail-function 'smtpmail-send-it) @@ -650,7 +650,7 @@ There are two ways of using IMAP with Gnus. The first one is to use IMAP like POP3, that means Gnus fetches the mail from the IMAP server and stores it on disk. If you want to do this (you don't really want to do this) add the following to -~/.gnus.el +@file{~/.gnus.el} @example (add-to-list 'mail-sources '(imap :server "mail.mycorp.com" @@ -765,7 +765,7 @@ Loading only unread messages can be annoying if you have threaded view enabled, @end example @noindent -in ~/.gnus.el to load enough old articles to prevent teared threads, replace 'some with t to load +in @file{~/.gnus.el} to load enough old articles to prevent teared threads, replace 'some with @code{t} to load all articles (Warning: Both settings enlarge the amount of data which is fetched when you enter a group and slow down the process of entering a group). @@ -829,7 +829,7 @@ The variable gnus-visible-headers controls which headers are shown, its value is a regular expression, header lines which match it are shown. So if you want author, subject, date, and if the header exists, Followup-To and MUA / NUA -say this in ~/.gnus.el: +say this in @file{~/.gnus.el}: @example (setq gnus-visible-headers @@ -856,7 +856,7 @@ Say @end example @noindent -in ~/.gnus.el. If you don't want HTML rendered, even if there's no text alternative add +in @file{~/.gnus.el}. If you don't want HTML rendered, even if there's no text alternative add @example (setq mm-automatic-display (remove "text/html" mm-automatic-display)) @@ -970,7 +970,7 @@ adaptive scoring say @end example @noindent -in ~/.gnus.el. +in @file{~/.gnus.el}. @node FAQ 4-10 @subsubheading Question 4.10 @@ -985,7 +985,7 @@ While in group buffer move point over the group and hit can set options for the group. At the bottom of the buffer you'll find an item that allows you to set variables locally for the group. To disable threading enter -gnus-show-threads as name of variable and nil as +gnus-show-threads as name of variable and @code{nil} as value. Hit button done at the top of the buffer when you're ready. @@ -1147,7 +1147,7 @@ don't want that (you probably don't want), say @end example @noindent -in ~/.gnus.el. +in @file{~/.gnus.el}. An example might be better than thousand words, so here's my nnmail-split-methods. Note that I send duplicates in a @@ -1269,7 +1269,7 @@ For other versions of Gnus, say @end example @noindent -in ~/.gnus.el. +in @file{~/.gnus.el}. You can reformat a paragraph by hitting @samp{M-q} (as usual). @@ -1303,7 +1303,7 @@ following lists are signature, signature-file, organization, address, name or body. The attribute name can also be a string. In that case, this will be used as a header name, and the value will be inserted in the -headers of the article; if the value is `nil', the header +headers of the article; if the value is @code{nil}, the header name will be removed. You can also say (eval (foo bar)), then the function foo will be evaluated with argument bar and the result will be thrown away. @@ -1395,7 +1395,7 @@ If you want your outgoing messages to be spell-checked, say @end example @noindent -In your ~/.gnus.el, if you prefer on-the-fly spell-checking say +In your @file{~/.gnus.el}, if you prefer on-the-fly spell-checking say @example (add-hook 'message-mode-hook (lambda () (flyspell-mode 1))) @@ -1423,7 +1423,7 @@ Yes, say something like @end example @noindent -in ~/.gnus.el. Change "^de\\." and "deutsch8" to something +in @file{~/.gnus.el}. Change "^de\\." and "deutsch8" to something that suits your needs. @node FAQ 5-7 @@ -1452,7 +1452,7 @@ details. However, what you really want is the Insidious Big Brother Database bbdb. Get it through the XEmacs package system or from @uref{http://bbdb.sourceforge.net/, bbdb's homepage}. -Now place the following in ~/.gnus.el, to activate bbdb for Gnus: +Now place the following in @file{~/.gnus.el}, to activate bbdb for Gnus: @example (require 'bbdb) @@ -1532,7 +1532,7 @@ Now you only have to tell Gnus to include the X-face in your postings by saying @end example @noindent -in ~/.gnus.el. If you use Gnus 5.10, you can simply add an entry +in @file{~/.gnus.el}. If you use Gnus 5.10, you can simply add an entry @example (x-face-file "~/.xface") @@ -1550,7 +1550,7 @@ newsgroups? @subsubheading Answer -Put this in ~/.gnus.el: +Put this in @file{~/.gnus.el}: @example (setq gnus-confirm-mail-reply-to-news t) @@ -1580,7 +1580,7 @@ How to tell Gnus not to generate a sender header? @subsubheading Answer Since 5.10 Gnus doesn't generate a sender header by -default. For older Gnus' try this in ~/.gnus.el: +default. For older Gnus' try this in @file{~/.gnus.el}: @example (eval-after-load "message" @@ -1645,7 +1645,7 @@ by saying: @end example @noindent -in ~/.gnus.el. If you use Gnus 5.9 or earlier, you can use this +in @file{~/.gnus.el}. If you use Gnus 5.9 or earlier, you can use this instead (works for newer versions as well): @example @@ -1745,7 +1745,7 @@ by saying @samp{O f}. However, wouldn't it be much more convenient to have more direct access to the archived message from Gnus? If you say yes, put this snippet by Frank Haun in -~/.gnus.el: +@file{~/.gnus.el}: @example (defun my-archive-article (&optional n) @@ -1898,7 +1898,7 @@ to another group. @subsubheading Answer -Say something like this in ~/.gnus.el: +Say something like this in @file{~/.gnus.el}: @example (setq nnmail-expiry-target "nnml:expired") @@ -1980,7 +1980,7 @@ The Gnus agent is part of Gnus, it allows you to fetch mail and news and store them on disk for reading them later when you're offline. It kind of mimics offline newsreaders like Forte Agent. If you want to use -the Agent place the following in ~/.gnus.el if you are +the Agent place the following in @file{~/.gnus.el} if you are still using 5.8.8 or 5.9 (it's the default since 5.10): @example @@ -2175,13 +2175,13 @@ Starting Gnus is really slow, how to speed it up? The reason for this could be the way Gnus reads its active file, see the node "The Active File" in the Gnus manual for things you might try to speed the process up. -An other idea would be to byte compile your ~/.gnus.el (say +An other idea would be to byte compile your @file{~/.gnus.el} (say @samp{M-x byte-compile-file RET ~/.gnus.el RET} to do it). Finally, if you have require statements in your .gnus, you could replace them with eval-after-load, which loads the stuff not at startup time, but when it's needed. Say you've got this in your -~/.gnus.el: +@file{~/.gnus.el}: @example (require 'message) @@ -2208,7 +2208,7 @@ How to speed up the process of entering a group? @subsubheading Answer A speed killer is setting the variable -gnus-fetch-old-headers to anything different from nil, +gnus-fetch-old-headers to anything different from @code{nil}, so don't do this if speed is an issue. To speed up building of summary say @@ -2217,7 +2217,7 @@ building of summary say @end example @noindent -at the bottom of your ~/.gnus.el, this will make gnus +at the bottom of your @file{~/.gnus.el}, this will make gnus byte-compile things like gnus-summary-line-format. then you could increase the value of gc-cons-threshold @@ -2237,7 +2237,7 @@ recent GNU Emacs, you should say @end example @noindent -in ~/.gnus.el (thanks to Jesper harder for the last +in @file{~/.gnus.el} (thanks to Jesper harder for the last two suggestions). Finally if you are still using 5.8.8 or 5.9 and experience speed problems with summary buffer generation, you definitely should update to @@ -2263,8 +2263,8 @@ to normal speed. @table @dfn @item ~/.gnus.el -When the term ~/.gnus.el is used it just means your Gnus -configuration file. You might as well call it ~/.gnus or +When the term @file{~/.gnus.el} is used it just means your Gnus +configuration file. You might as well call it @file{~/.gnus} or specify another name. @item Back End diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index fa8078a286..8f1550942e 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -12528,7 +12528,7 @@ you're in, you could say something like the following: Modify to suit your needs. @vindex gnus-message-highlight-citation -If @code{gnus-message-highlight-citation} is t, different levels of +If @code{gnus-message-highlight-citation} is @code{t}, different levels of citations are highlighted like in Gnus article buffers also in message mode buffers. @@ -20518,7 +20518,7 @@ matches. This takes a long time in big groups. You can inhibit this slow scoring on headers or body by setting the variable @code{gnus-inhibit-slow-scoring}. If @code{gnus-inhibit-slow-scoring} is regexp, slow scoring is inhibited if -the group matches the regexp. If it is t, slow scoring on it is +the group matches the regexp. If it is @code{t}, slow scoring on it is inhibited for all groups. Now, there's not much you can do about the slowness for news groups, but for @@ -21445,18 +21445,19 @@ three items unique to nnir summary buffers: %g Article original short group name (string) @end example -If nil (the default) this will use @code{gnus-summary-line-format}. +If @code{nil} (the default) this will use @code{gnus-summary-line-format}. @item nnir-retrieve-headers-override-function -If non-nil, a function that retrieves article headers rather than using +If non-@code{nil}, a function that retrieves article headers rather than using the gnus built-in function. This function takes an article list and group as arguments and populates the `nntp-server-buffer' with the retrieved headers. It should then return either 'nov or 'headers indicating the retrieved header format. Failure to retrieve headers should return @code{nil}. -If this variable is nil, or if the provided function returns nil for a -search result, @code{gnus-retrieve-headers} will be called instead." +If this variable is @code{nil}, or if the provided function returns +@code{nil} for a search result, @code{gnus-retrieve-headers} will be +called instead." @end table @@ -21959,7 +21960,7 @@ original article yet, @code{nnmairix} will use an additional mairix search for determining the file name of the article. This, of course, is way slower than the registry---if you set hundreds or even thousands of marks this way, it might take some time. You can avoid this situation by -setting @code{nnmairix-only-use-registry} to t. +setting @code{nnmairix-only-use-registry} to @code{t}. Maybe you also want to propagate marks the other way round, i.e., if you tick an article in a "real" mail group, you'd like to have the same @@ -24905,7 +24906,7 @@ classified as spammers. While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is @emph{not} a separate back end. If you set -@code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting +@code{spam-use-BBDB-exclusive} to @code{t}, @emph{all} your BBDB splitting will be exclusive. @end defvar diff --git a/doc/misc/htmlfontify.texi b/doc/misc/htmlfontify.texi index 1d8794d772..d31a087be2 100644 --- a/doc/misc/htmlfontify.texi +++ b/doc/misc/htmlfontify.texi @@ -792,7 +792,7 @@ See: @ref{hfy-link-style-fun}. @end lisp Given @var{props}, a list of text-properties, return the value of the -face property, or nil. +face property, or @code{nil}. @item hfy-box-to-border-assoc @findex hfy-box-to-border-assoc @@ -824,7 +824,7 @@ with a class of @code{t} is considered to match any class you specify. This matches Emacs's behavior when deciding on which face attributes to use, to the best of my understanding ). -If @var{class} is nil, then you just get get whatever +If @var{class} is @code{nil}, then you just get get whatever @code{face-attr-construct} returns; i.e., the current specification in effect for @var{face}. diff --git a/doc/misc/idlwave.texi b/doc/misc/idlwave.texi index 4a15080364..40c98a358c 100644 --- a/doc/misc/idlwave.texi +++ b/doc/misc/idlwave.texi @@ -1645,7 +1645,7 @@ of completed words. @defopt idlwave-completion-force-default-case (@code{nil}) Non-@code{nil} means completion will always honor the settings in -@code{idlwave-completion-case}. When nil (the default), entirely lower +@code{idlwave-completion-case}. When @code{nil} (the default), entirely lower case strings will always be completed to lower case, no matter what the settings in @code{idlwave-completion-case}. @end defopt diff --git a/doc/misc/mairix-el.texi b/doc/misc/mairix-el.texi index 01d9e33381..f20582659b 100644 --- a/doc/misc/mairix-el.texi +++ b/doc/misc/mairix-el.texi @@ -307,7 +307,7 @@ options `mairix-update-options'; the default is ``-F'' and ``-Q'' to make updates as fast as possible. Note that by using these options, absolutely no integrity checking is done. If your database somehow gets corrupted, simply delete it and update. If `mairix-synchronous-update' -is nil (the default), mairix will be called in a subprocess so Emacs +is @code{nil} (the default), mairix will be called in a subprocess so Emacs will still be usable while the update is done. @end table diff --git a/doc/misc/message.texi b/doc/misc/message.texi index 700acfc9b5..7421360211 100644 --- a/doc/misc/message.texi +++ b/doc/misc/message.texi @@ -2131,7 +2131,7 @@ translation process. @vindex message-fill-column @cindex auto-fill Local value for the column beyond which automatic line-wrapping should -happen for message buffers. If non-nil (the default), also turn on +happen for message buffers. If non-@code{nil} (the default), also turn on auto-fill in message buffers. @item message-signature-separator diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi index d4fd6d52bb..a5766e346e 100644 --- a/doc/misc/mh-e.texi +++ b/doc/misc/mh-e.texi @@ -3739,7 +3739,7 @@ when you press @key{TAB} when prompted for a folder name. The hook @code{mh-kill-folder-suppress-prompt-functions} is an abnormal hook run at the beginning of the command @kbd{k}. The hook functions -are called with no arguments and should return a non-nil value to +are called with no arguments and should return a non-@code{nil} value to suppress the normal prompt when you remove a folder. This is useful for folders that are easily regenerated. The default value of @code{mh-search-p} suppresses the prompt on folders generated by diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index 5479dfd9a2..6d79d352e4 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi @@ -4078,7 +4078,7 @@ group which contains all labels. This may also be a function to do local parsing and identify point to be in a non-standard label environment. The function must take an argument @var{bound} and limit backward searches to this value. It -should return either nil or a cons cell @code{(@var{function} +should return either @code{nil} or a cons cell @code{(@var{function} . @var{position})} with the function symbol and the position where the special environment starts. See the Info documentation for an example. @@ -4235,7 +4235,7 @@ special packages like fancyref) are being used. RefTeX can and by default does parse around each label to detect the correct label type, but this process can be slow when a document contains thousands of labels. If you use label prefixes consistently, you may speed up -document parsing by setting this variable to a non-nil value. RefTeX +document parsing by setting this variable to a non-@code{nil} value. RefTeX will then compare the label prefix with the prefixes found in `reftex-label-alist' and derive the correct label type in this way. Possible values for this option are: @@ -4822,7 +4822,7 @@ case. @defopt reftex-index-verify-function A function which is called at each match during global indexing. -If the function returns nil, the current match is skipped. +If the function returns @code{nil}, the current match is skipped. @end defopt @defopt reftex-index-phrases-skip-indexed-matches @@ -4942,7 +4942,7 @@ escapes. @defopt reftex-revisit-to-echo Non-@code{nil} means, automatic citation display will revisit files if -necessary. When nil, citation display in echo area will only be active +necessary. When @code{nil}, citation display in echo area will only be active for cached echo strings (see @code{reftex-cache-cite-echo}), or for @BibTeX{} database files which are already visited by a live associated buffers. @@ -5275,8 +5275,8 @@ will - supply arguments for macros like @code{\index} (flag 5) @end example -You may also set the variable itself to t or nil in order to turn all -options on or off, respectively.@* +You may also set the variable itself to @code{t} or @code{nil} in +order to turn all options on or off, respectively.@* Supplying labels in new sections and environments applies when creating sections with @kbd{C-c C-s} and environments with @kbd{C-c C-e}.@* Supplying macro arguments applies when you insert such a macro @@ -5286,7 +5286,7 @@ See the @AUCTeX{} documentation for more information. @defopt reftex-revisit-to-follow Non-@code{nil} means, follow-mode will revisit files if necessary. -When nil, follow-mode will be suspended for stuff in unvisited files. +When @code{nil}, follow-mode will be suspended for stuff in unvisited files. @end defopt @defopt reftex-allow-detached-macro-args @@ -5395,8 +5395,8 @@ if you'd like RefTeX to base its classification of labels on prefixes. This can speed-up document parsing, but may in some cases reduce the quality of the context used by RefTeX to describe a label. @item -Fixed bug in @code{reftex-create-bibtex-file} when @code{reftex-comment-citations} -is non-nil. +Fixed bug in @code{reftex-create-bibtex-file} when +@code{reftex-comment-citations} is non-@code{nil}. @item Fixed bugs in indexing: Case-sensitive search, quotes before and/or after words. Disabled indexing in comment lines. @@ -5743,7 +5743,7 @@ New option @code{reftex-cache-cite-echo}. @kbd{M-x reftex-reset-mode} now also removes the file with parsing info. @item -Default of @code{reftex-revisit-to-follow} changed to nil. +Default of @code{reftex-revisit-to-follow} changed to @code{nil}. @end itemize @noindent @b{Version 3.24} diff --git a/doc/misc/srecode.texi b/doc/misc/srecode.texi index 7c274b4a20..cd72656c91 100644 --- a/doc/misc/srecode.texi +++ b/doc/misc/srecode.texi @@ -1175,7 +1175,7 @@ The following built-in simple arguments are available: @subsubsection Argument :indent -Supplies the @code{INDENT} macro. When @code{INDENT} is non-nil, then +Supplies the @code{INDENT} macro. When @code{INDENT} is non-@code{nil}, then each line is individually indented with @code{indent-according-to-mode} during macro processing. @@ -1577,7 +1577,7 @@ start with the main entry point. @defun srecode-insert-fcn template dictionary &optional stream @anchor{srecode-insert-fcn} Insert @var{template} using @var{dictionary} into @var{stream}. -If @var{stream} is nil, then use the current buffer. +If @var{stream} is @code{nil}, then use the current buffer. @end defun @node Template Naming Conventions diff --git a/doc/misc/todo-mode.texi b/doc/misc/todo-mode.texi index d178e2a2e2..e63bc2c64a 100644 --- a/doc/misc/todo-mode.texi +++ b/doc/misc/todo-mode.texi @@ -634,12 +634,12 @@ operations described in the next section.) @item @samp{diary} (@kbd{y}): Override the option @code{todo-include-in-diary}; that is, add @code{todo-nondiary-marker} -if the option is non-nil, omit this marker if the option is nil. +if the option is non-@code{nil}, omit this marker if the option is @code{nil}. @samp{nonmarking} (@kbd{k}): Override the option @code{todo-diary-nonmarking}; that is, add -@code{diary-nonmarking-symbol} if the option is non-nil, omit this -symbol if the option is nil. Since this symbol only applies to diary +@code{diary-nonmarking-symbol} if the option is non-@code{nil}, omit this +symbol if the option is @code{nil}. Since this symbol only applies to diary items, the new item is automatically marked as such, i.e., lacks @code{todo-nondiary-marker}. @@ -658,7 +658,7 @@ a weekday name as the date header instead of a year-month-day string. @samp{time} (@kbd{t}): Prompt for entering a time string in the minibuffer instead of automatically inserting the current time; however, typing @key{RET} at the prompt enters the current time if -@code{todo-always-add-time-string} is non-nil, otherwise it enters the +@code{todo-always-add-time-string} is non-@code{nil}, otherwise it enters the empty string (i.e., no time string). @item @@ -669,7 +669,7 @@ down, i.e., lowering their priority, by one. @samp{region} (@kbd{r}): Use the text of the selected region as the text of the new item, and insert this in accordance with the item insertion options and other parameters passed. If the option -@code{todo-use-only-highlighted-region} is non-nil, then use the +@code{todo-use-only-highlighted-region} is non-@code{nil}, then use the region only when it is highlighted; otherwise, use the region regardless of highlighting. @end enumerate @@ -733,14 +733,14 @@ key again will complete the sequence. @c @item @c @kbd{i y h} does the same as the preceding command, except that @c @code{todo-nondiary-marker} is added if @code{todo-include-in-diary} is -@c non-nil and omitted if that option is nil; that is, the diary key @kbd{y} -@c overrides the setting of this option. +@c non-@code{nil} and omitted if that option is @code{nil}; that is, +@c the diary key @kbd{y} @c overrides the setting of this option. @c @item @c @kbd{i y t h} does the same as the preceding command, except that it @c prompts for a time string instead of automatically inserting the @c current time; however, typing @key{RET} at the prompt returns the -@c current time if @code{todo-always-add-time-string} is non-nil, otherwise -@c the empty string (i.e., no time string). +@c current time if @code{todo-always-add-time-string} is non-@code{nil}, +@c otherwise the empty string (i.e., no time string). @c @item @c @kbd{i y t t} does the same as the preceding command, except that it @c prompts for the item's priority and inserts it accordingly. @@ -815,7 +815,7 @@ of item editing parameters to edit the current item's date string. @samp{time} (@kbd{t}): Edit the current item's time string, if present; otherwise, add one. Typing @key{RET} at the prompt enters -the current time if @code{todo-always-add-time-string} is non-nil, +the current time if @code{todo-always-add-time-string} is non-@code{nil}, otherwise it enters the empty string (i.e., no time string). @end enumerate @@ -839,7 +839,7 @@ invocation. @samp{full} (@kbd{f}): Successively prompt for editing the year, month (with completion) and day number parts of the current item's date string, and, if the option @code{todo-always-add-time-string} is -non-nil, also for editing its time string. +non-@code{nil}, also for editing its time string. @samp{calendar} (@kbd{c}): This pops up the Emacs calendar, and after you type @key{RET} on a date in the calendar makes that date the @@ -1174,7 +1174,7 @@ of putting the todo file out of synch with the archive file. You may find it preferable not to delete empty todo categories but to enable the option @code{todo-skip-archived-categories}. When this is -non-nil, such empty todo categories are skipped over by the sequential +non-@code{nil}, such empty todo categories are skipped over by the sequential category navigation commands @kbd{f} and @kbd{b}, so they don't distract you while navigating and you maintain the structural correspondence between todo and archive files (you can also still jump to empty todo categories diff --git a/doc/misc/url.texi b/doc/misc/url.texi index 49d4b1526d..765d97d598 100644 --- a/doc/misc/url.texi +++ b/doc/misc/url.texi @@ -872,7 +872,7 @@ more likely to conflict with other files. @end defun @defun url-cache-expired -This function returns non-nil if a cache entry has expired (or is absent). +This function returns non-@code{nil} if a cache entry has expired (or is absent). The arguments are a URL and optional expiration delay in seconds (default @var{url-cache-expire-time}). @end defun diff --git a/doc/misc/wisent.texi b/doc/misc/wisent.texi index 9435235ec0..dce853a13d 100644 --- a/doc/misc/wisent.texi +++ b/doc/misc/wisent.texi @@ -1443,7 +1443,7 @@ tokens (@pxref{Useful functions}). @defun wisent-skip-token @anchor{wisent-skip-token} Skip the lookahead token in order to resume parsing. -Return nil. +Return @code{nil}. Must be used in error recovery semantic actions. It typically looks like this: @@ -1463,7 +1463,7 @@ It typically looks like this: @findex wisent-skip-block @defun wisent-skip-block Safely skip a block in order to resume parsing. -Return nil. +Return @code{nil}. Must be used in error recovery semantic actions. A block is data between an open-delimiter (syntax class @code{(}) and -- 2.39.2