+2014-06-08 Glenn Morris <rgm@gnu.org>
+
+ * entering.texi (Entering Emacs): Small fix re initial-buffer-choice.
+ * misc.texi (emacsclient Options): Copyedit.
+
+ * buffers.texi (Uniquify): Copyedits.
+ * files.texi (Visiting): Update for uniquify changes.
+
+ * dired.texi (Marks vs Flags):
+ * rmail.texi (Rmail Scrolling): Markup fixes re SPC.
+
+ * help.texi (Help, Misc Help): Copyedits.
+
+ * screen.texi (Menu Bar): Copyedits.
+ * msdog.texi (Windows Keyboard): F10 menus are now a general feature.
+
+ * frames.texi (Frame Commands): Copyedits re M-F10, F11.
+ * cmdargs.texi (Window Size X): Copyedits.
+
+ * ack.texi (Acknowledgments):
+ * emacs.texi (Acknowledgments): Updates.
+
2014-06-08 Glenn Morris <rgm@gnu.org>
* ack.texi (Acknowledgments):
@cindex unique buffer names
@cindex directories in buffer names
When several buffers visit identically-named files, Emacs must give
-the buffers distinct names. The default method
-(@code{uniquify-buffer-name-style} set to
-@code{post-forward-angle-brackets}) for making buffer names unique
-adds @samp{<dir1>}, @samp{<dir2>}, etc.@: to the end of the buffer
-names, where @file{dir1} and @file{dir2} are the minimal parts of the
-leading directories needed to make the buffer name unique. For
-example, if you have files @file{/foo/bar/mumble/name} and
-@file{/baz/quux/mumble/name} visited, their buffers will be named
-@samp{name<bar/mumble>} and @samp{name<quux/mumble>} correspondingly.
+the buffers distinct names. The default method adds a suffix based on
+the names of the directories that contain the files. For example, if
+you visit files @file{/foo/bar/mumble/name} and
+@file{/baz/quux/mumble/name} at the same time, their buffers will be
+named @samp{name<bar/mumble>} and @samp{name<quux/mumble>}, respectively.
+Emacs adds as many directory parts as are needed to make a unique name.
@vindex uniquify-buffer-name-style
- There are several styles to make buffer names unique. To select
-one, customize the variable @code{uniquify-buffer-name-style}
-(@pxref{Easy Customization}).
+ You can choose from several different styles for constructing unique
+buffer names, by customizing the option @code{uniquify-buffer-name-style}.
The @code{forward} naming method includes part of the file's
directory name at the beginning of the buffer name; using this method,
In contrast, the @code{post-forward} naming method would call the
buffers @samp{Makefile|tmp} and @samp{Makefile|zaphod}. The default
-method @code{post-forward-angle-brackets} is like @code{post-forward}
-except that it prepends the unique path in angle brackets. The
+method @code{post-forward-angle-brackets} is like @code{post-forward},
+except that it encloses the unique path in angle brackets. The
@code{reverse} naming method would call them @samp{Makefile\tmp} and
@samp{Makefile\zaphod}. The nontrivial difference between
@code{post-forward} and @code{reverse} occurs when just one directory
becomes @samp{file\middle\top}, while @code{post-forward} puts them in
forward order after the file name, as in @samp{file|top/middle}. If
@code{uniquify-buffer-name-style} is set to @code{nil}, the buffer
-names simply get a @samp{<2>} etc. prepended. This used to be the
-default behavior in Emacs versions up to 24.4.
+names simply get @samp{<2>}, @samp{<3>}, etc. appended.
Which rule to follow for putting the directory names in the buffer
name is not very important if you are going to @emph{look} at the
@itemx --fullscreen
@opindex --fullscreen
@cindex fullscreen, command-line argument
-Specify that width and height shall be the size of the screen. Normally
-no window manager decorations are shown.
+Specify that width and height should be that of the screen. Normally
+no window manager decorations are shown. (After starting Emacs,
+you can toggle this state using @key{F11}, @code{toggle-frame-fullscreen}.)
@item -mm
@opindex -mm
@itemx --maximized
@opindex --maximized
@cindex maximized, command-line argument
-Specify that the Emacs frame shall be maximized. This normally
+Specify that the Emacs frame should be maximized. This normally
means that the frame has window manager decorations.
+(After starting Emacs, you can toggle this state using @kbd{M-F10},
+@code{toggle-frame-maximized}.)
@item -fh
@opindex -fh
@itemx --fullheight
@opindex --fullheight
@cindex fullheight, command-line argument
-Specify that the height shall be the height of the screen.
+Specify that the height should be the height of the screen.
@item -fw
@opindex -fw
@itemx --fullwidth
@opindex --fullwidth
@cindex fullwidth, command-line argument
-Specify that the width shall be the width of the screen.
+Specify that the width should be the width of the screen.
@end table
@noindent
that already have @samp{D} flags:
@example
-* c D t * c SPC D * c t SPC
+* c D t * c @key{SPC} D * c t @key{SPC}
@end example
This assumes that no files were already marked with @samp{t}.
You can also force Emacs to display a file or directory at startup
by setting the variable @code{initial-buffer-choice} to a string
naming that file or directory. The value of
-@code{initial-buffer-choice} may also be a function which should
-return a buffer which is then displayed. @code{initial-buffer-choice}
-may also be @code{t} in which case the @file{*scratch*} buffer will be
-shown. In any case, even if you specify one or more files on the
-command line, Emacs opens but does not display them if
-@code{initial-buffer-choice} is non-nil.
+@code{initial-buffer-choice} may also be a function (of no arguments)
+that should return a buffer which is then displayed.
+@ignore
+@c I do not think this should be mentioned. AFAICS it is just a dodge
+@c around inhibit-startup-screen not being settable on a site-wide basis.
+@code{initial-buffer-choice} may also be @code{t} in which case the
+@file{*scratch*} buffer will be shown.
+@end ignore
+If @code{initial-buffer-choice} is non-@code{nil}, then if you specify
+any files on the command line, Emacs still visits them, but does not
+display them initially.
@node Exiting
@section Exiting Emacs
buffer name from the file name, omitting the directory name. For
example, a file named @file{/usr/rms/emacs.tex} is visited in a buffer
named @samp{emacs.tex}. If there is already a buffer with that name,
-Emacs constructs a unique name; the normal method is to append
-@samp{<2>}, @samp{<3>}, and so on, but you can select other methods.
-@xref{Uniquify}.
+Emacs constructs a unique name; the normal method is to add a suffix
+based on the directory name (e.g., @samp{<rms>}, @samp{<tmp>},
+and so on), but you can select other methods. @xref{Uniquify}.
@cindex creating files
To create a new file, just visit it using the same command, @kbd{C-x
@item M-<F10>
@kindex M-<F10>
@findex toggle-frame-maximized
-Toggle maximization state of the current frame.
+Toggle the maximization state of the current frame. When a frame is
+maximized, it fills the screen.
@item <F11>
@kindex <F11>
@findex toggle-frame-fullscreen
-Toggle fullscreen mode of the current frame.
+Toggle fullscreen mode for the current frame. (The difference
+between ``fullscreen'' and ``maximized'' is normally that the former
+hides window manager decorations, giving slightly more screen space to
+Emacs itself.)
@end table
The @kbd{C-x 5 0} (@code{delete-frame}) command deletes the selected
@xref{Package Keywords}.
@end table
- @kbd{C-h}, @key{F1}, or @kbd{?} means ``help'' in various other
-contexts as well. For instance, you can type them after a prefix key
-to view a list of the keys that can follow the prefix key. (A few
-prefix keys don't support @kbd{C-h} or @kbd{?} in this way, because
-they define other meanings for it, but they all support @key{F1} for
-help.)
+ @kbd{C-h} or @key{F1} mean ``help'' in various other contexts as
+well. For instance, you can type them after a prefix key to view a
+list of the keys that can follow the prefix key. (You can also use
+@kbd{?} in this context. A few prefix keys don't support @kbd{C-h}
+or @kbd{?} in this way, because they define other meanings for those
+inputs, but they all support @key{F1}.)
@menu
* Help Summary:: Brief list of all Help commands.
typing @kbd{C-h}, @kbd{?}, or @key{F1}
(@code{describe-prefix-bindings}) after the prefix key. (There are a
few prefix keys for which not all of these keys work---those that
-provide their own bindings for one of them. One of these prefix keys
-is @key{ESC} in combination with @kbd{C-h}, because @kbd{@key{ESC} C-h} is
-actually @kbd{C-M-h}, which marks a defun. However, @kbd{@key{ESC} @key{F1}}
-and @kbd{@key{ESC} ?} work fine.)
+provide their own bindings for that key. One of these prefix keys
+is @key{ESC}, because @kbd{@key{ESC} C-h} is actually @kbd{C-M-h},
+which marks a defun. However, @kbd{@key{ESC} @key{F1}} and
+@kbd{@key{ESC} ?} work fine.)
@node Help Files
@section Help Files
current text terminal. @xref{Windows Startup}.
If you omit a filename argument while supplying the @samp{-c} option,
-the new frame displays the @file{*scratch*} buffer by default. This
-behavior can be customized using the variable
-@code{initial-buffer-choice} (@pxref{Entering Emacs}).
+the new frame displays the @file{*scratch*} buffer by default. You
+can customize this behavior with the variable @code{initial-buffer-choice}
+(@pxref{Entering Emacs}).
@item -F @var{alist}
@itemx --frame-parameters=@var{alist}
You can redefine some of them with meanings more like the MS-Windows
meanings by enabling CUA Mode (@pxref{CUA Bindings}).
-@kindex F10 @r{(MS-Windows)}
-@cindex menu bar access using keyboard @r{(MS-Windows)}
- The @key{F10} key on Windows activates the menu bar in a way that
-makes it possible to use the menus without a mouse. In this mode, the
-arrow keys traverse the menus, @key{RET} selects a highlighted menu
-item, and @key{ESC} closes the menu.
-
@iftex
@inforef{Windows Keyboard, , emacs}, for information about additional
Windows-specific variables in this category.
@kindex S-SPC @r{(Rmail)}
Since the most common thing to do while reading a message is to
scroll through it by screenfuls, Rmail makes @key{SPC} and @key{DEL}
-(or @key{S-SPC}) do the same as @kbd{C-v} (@code{scroll-up-command})
+(or @kbd{S-@key{SPC}}) do the same as @kbd{C-v} (@code{scroll-up-command})
and @kbd{M-v} (@code{scroll-down-command}) respectively.
@kindex . @r{(Rmail)}
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
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
can use to perform common operations. There's no need to list them
here, as you can more easily see them yourself.
-@kindex M-`
-@kindex F10
-@findex menu-bar-open
- On a display that support a mouse, you can use the mouse to choose a
+ On a display that supports a mouse, you can use the mouse to choose a
command from the menu bar. An arrow on the right edge of a menu item
means it leads to a subsidiary menu, or @dfn{submenu}. A @samp{...}
at the end of a menu item means that the command will prompt you for
item, type @kbd{C-h k}, and then select the menu bar with the mouse in
the usual way (@pxref{Key Help}).
+@kindex F10
+@findex menu-bar-open
+@cindex menu bar access using keyboard
Instead of using the mouse, you can also invoke the first menu bar
item by pressing @key{F10} (to run the command @code{menu-bar-open}).
You can then navigate the menus with the arrow keys. To activate a
selected menu item, press @key{RET}; to cancel menu navigation, press
@kbd{C-g} or @kbd{@key{ESC} @key{ESC} @key{ESC}}.
+@kindex M-`
@findex tmm-menubar
@vindex tty-menu-open-use-tmm
On a text terminal, you can optionally access the menu-bar menus in
+2014-06-08 Glenn Morris <rgm@gnu.org>
+
+ * os.texi (Startup Summary): Small fix for initial-buffer-choice.
+
+ * files.texi (Subroutines of Visiting): Mention uniquify.
+
+ * numbers.texi (Comparison of Numbers): Copyedits.
+
2014-06-08 Glenn Morris <rgm@gnu.org>
* display.texi (Window Systems): Remove window-setup-hook.
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
@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:
which are sometimes useful in user Lisp code: @code{create-file-buffer}
and @code{after-find-file}. This section explains how to use them.
+@c FIXME This does not describe the default behavior, because
+@c uniquify is enabled by default and advises this function.
+@c This is confusing. uniquify should be folded into the function proper.
@defun create-file-buffer filename
This function creates a suitably named buffer for visiting
@var{filename}, and returns it. It uses @var{filename} (sans directory)
as the name if that name is free; otherwise, it appends a string such as
@samp{<2>} to get an unused name. See also @ref{Creating Buffers}.
+Note that the @file{uniquify} library affects the result of this
+function. @xref{Uniquify,,, emacs, The GNU Emacs Manual}.
@strong{Please note:} @code{create-file-buffer} does @emph{not}
associate the new buffer with a file and does not select the buffer.
@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.
@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.
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
@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:
@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.
@end defun
@defun < number-or-marker &rest number-or-markers
-This function tests whether every argument is strictly less than the
-respective next argument. It returns @code{t} if so, @code{nil}
-otherwise.
+This function tests whether each argument is strictly less than the
+following argument. It returns @code{t} if so, @code{nil} otherwise.
@end defun
@defun <= number-or-marker &rest number-or-markers
-This function tests whether every argument is less than or equal to
-the respective next argument. It returns @code{t} if so, @code{nil}
-otherwise.
+This function tests whether each argument is less than or equal to
+the following argument. It returns @code{t} if so, @code{nil} otherwise.
@end defun
@defun > number-or-marker &rest number-or-markers
-This function tests whether every argument is strictly greater than
-the respective next argument. It returns @code{t} if so, @code{nil}
-otherwise.
+This function tests whether each argument is strictly greater than
+the following argument. It returns @code{t} if so, @code{nil} otherwise.
@end defun
@defun >= number-or-marker &rest number-or-markers
-This function tests whether every argument is greater than or equal to
-the respective next argument. It returns @code{t} if so, @code{nil}
-otherwise.
+This function tests whether each argument is greater than or equal to
+the following argument. It returns @code{t} if so, @code{nil} otherwise.
@end defun
@defun max number-or-marker &rest numbers-or-markers
It now exits if the option @code{--batch} was specified.
@item
-If @code{initial-buffer-choice} is a string, it visits the file with
-that name. If it is a function, it calls the function and selects the
-buffer returned by the function. It it is @code{t}, it selects the
-@file{*scratch*} buffer. If the @file{*scratch*} buffer exists and is
-empty, it inserts @code{initial-scratch-message} into that buffer.
+If @code{initial-buffer-choice} is a string, it visits the file (or
+directory) with that name. If it is a function, it calls the function
+with no arguments and selects the buffer that it returns.
+@ignore
+@c I do not think this should be mentioned. AFAICS it is just a dodge
+@c around inhibit-startup-screen not being settable on a site-wide basis.
+If it is @code{t}, it selects the @file{*scratch*} buffer.
+@end ignore
+If the @file{*scratch*} buffer exists and is empty, it inserts
+@code{initial-scratch-message} into that buffer.
@c To make things nice and confusing, the next three items can be
@c called from two places. If displaying a startup screen, they are
(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")}:
@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
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
(@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
+2014-06-08 Karl Berry <karl@gnu.org>
+
+ * doc/info.texi (Help-^L): "mode line", "screenful",
+ stand-alone and Emacs Info both use the mode line.
+ Use x instead of weird C-x 0 to get rid of help msg
+ in standalone Info.
+
+2014-06-08 Glenn Morris <rgm@gnu.org>
+
+ * vip.texi (Files): Defer to Emacs manual for uniquify details.
+
+ * info.texi (Help-Small-Screen): Clarify details of S-SPC.
+ (Help-Small-Screen, Help-]): Do not mention S-SPC.
+ (Emacs Info Variables): Markup fix.
+
+ * ebrowse.texi (Source Display, Finding/Viewing):
+ * erc.texi (Sample Session):
+ * ses.texi (The Basics):
+ * todo-mode.texi (Moving and Deleting Items):
+ * woman.texi (Navigation): Markup fixes re SPC, RET.
+
2014-06-02 Glenn Morris <rgm@gnu.org>
* efaq.texi (Finding a package with particular functionality):
@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
@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
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
@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.
@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
name.
@table @kbd
-@item SPC
+@item @key{SPC}
This command views the class declaration if the database
contains information about it. If you don't parse the entire source
you are working on, some classes will only be known to exist but the
location of their declarations and definitions will not be known.
-@item RET
+@item @key{RET}
Works like @kbd{SPC}, except that it finds the class
declaration rather than viewing it, so that it is ready for
editing.
@cindex declaration of a member, in member buffers
@table @kbd
-@item RET
+@item @key{RET}
This command finds the definition of the member the cursor is on.
Finding involves roughly the same as the standard Emacs tags facility
does---loading the file and searching for a regular expression matching
@item f
This command finds the declaration of the member the cursor is on.
-@item SPC
+@item @key{SPC}
This is the same command as @kbd{RET}, but views the member definition
instead of finding the member's source file.
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.
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
@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
@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
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
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
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
@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
@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
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}.
@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
@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
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.
@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
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,
@item Join the #emacs channel
-In that buffer, type ``/join SPC #emacs'' and hit @kbd{RET}. Depending
+In that buffer, type ``/join @key{SPC} #emacs'' and hit @kbd{RET}. Depending
on how you've set up ERC, either a new buffer for ``#emacs'' will be
displayed, or a new buffer called ``#emacs'' will be created in the
background. If the latter, switch to the ``#emacs'' buffer. You will
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}.
@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
@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}:
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
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.
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.
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"))
@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
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.
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
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 ""))
@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
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)
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"
@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).
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
@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))
@end example
@noindent
-in ~/.gnus.el.
+in @file{~/.gnus.el}.
@node FAQ 4-10
@subsubheading Question 4.10
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.
@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
@end example
@noindent
-in ~/.gnus.el.
+in @file{~/.gnus.el}.
You can reformat a paragraph by hitting @samp{M-q}
(as usual).
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.
@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)))
@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
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)
@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")
@subsubheading Answer
-Put this in ~/.gnus.el:
+Put this in @file{~/.gnus.el}:
@example
(setq gnus-confirm-mail-reply-to-news t)
@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"
@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
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 <pille3003@@fhaun.de> in
-~/.gnus.el:
+@file{~/.gnus.el}:
@example
(defun my-archive-article (&optional n)
@subsubheading Answer
-Say something like this in ~/.gnus.el:
+Say something like this in @file{~/.gnus.el}:
@example
(setq nnmail-expiry-target "nnml:expired")
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
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)
@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
@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
@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
@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
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.
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
%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
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
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
@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
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}.
@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
screen, it is necessary to give you special advice at the beginning.
If the entire text you are looking at fits on the screen, the text
-@samp{All} will be displayed at the bottom of the screen. In the
-stand-alone Info reader, it is displayed at the bottom right corner of
-the screen; in Emacs, it is displayed on the modeline. If you see the
-text @samp{Top} instead, it means that there is more text below that
-does not fit. To move forward through the text and see another screen
-full, press @key{SPC}, the Space bar. To move back up, press the key
+@samp{All} will be displayed near the bottom of the screen, on the
+mode line (usually, the line in inverse video). If you see the text
+@samp{Top} instead, it means that there is more text below that does
+not fit. To move forward through the text and see another screenful,
+press @key{SPC}, the Space bar. To move back up, press the key
labeled @samp{Backspace} or @samp{DEL} (on some keyboards, this key
-might be labeled @samp{Delete}), or @key{S-SPC}.
+might be labeled @samp{Delete}). In a graphical Emacs, you can also use
+@kbd{S-@key{SPC}} (press and hold the @key{Shift} key and then press
+@key{SPC}) to move backwards, but this does not work in the
+stand-alone Info reader (nor in Emacs, if you are using it in a
+text-mode terminal).
@ifinfo
-Here are 40 lines of junk, so you can try @key{SPC} and @key{DEL} (or
-@key{S-SPC}) and see what they do. At the end are instructions of
-what you should do next.
+Here are 40 lines of junk, so you can try @key{SPC} and @key{DEL} and
+see what they do. At the end are instructions of what you should do
+next.
@format
This is line 20
@end format
If you have managed to get here, go back to the beginning with
-@kbd{DEL} (or @key{S-SPC}), and come back here again, then you
-understand the about the @samp{Space} and @samp{Backspace} keys. So
-now type an @kbd{n}---just one character; don't type the quotes and
-don't type the Return key afterward---to get to the normal start of
-the course.
+@key{DEL} (or @key{BACKSPACE}), and come back here again, then you
+understand about the @samp{Space} and @samp{Backspace} keys. So now
+type an @kbd{n}---just one character; don't type the quotes and don't
+type the Return key afterward---to get to the normal start of the
+course.
@end ifinfo
@node Help
>> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of
the list until finished. Then type @key{SPC} several times. If
you are using Emacs, the help will then go away automatically.
+ If you are using the stand-alone Info reader, type @kbd{x} to
+ return here.
@end format
- (If you are using the stand-alone Info reader, type @kbd{C-x 0} to
-return here, that is---press and hold @key{CTRL}, type an @kbd{x},
-then release @key{CTRL} and @kbd{x}, and press @kbd{0}; that's a zero,
-not the letter ``o''.)
-
From now on, you will encounter large nodes without warning, and
will be expected to know how to use @key{SPC} and @key{BACKSPACE} to
move around in them without being told. Since not all terminals have
If you immediately want to go to that node, without having to scroll
to the bottom of the screen first, you can type @kbd{]}.
-Similarly, @kbd{@key{BACKSPACE}} (or @kbd{@key{S-SPC}}) carries you to
-the preceding node regardless of level, after you scrolled to the
-beginning of the present node. If you want to go to the preceding
-node immediately, you can type @kbd{[}.
+Similarly, @kbd{@key{BACKSPACE}} carries you to the preceding node
+regardless of level, after you scrolled to the beginning of the
+present node. If you want to go to the preceding node immediately,
+you can type @kbd{[}.
For instance, typing this sequence will come back here in three steps:
@kbd{[ n [}. To do the same backward, type @kbd{] p ]}.
@item Info-scroll-prefer-subnodes
If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or
-@key{DEL}, or @key{S-SPC}) keys in a menu visit subnodes of the
+@key{DEL}, or @kbd{S-@key{SPC}}) keys in a menu visit subnodes of the
current node before scrolling to its end or beginning, respectively.
For example, if the node's menu appears on the screen, the next
@key{SPC} moves to a subnode indicated by the following menu item.
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
@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
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
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.
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:
@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
@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.
- 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
@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
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.
@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}
ranges.
@table @kbd
-@item C-SPC
+@item C-@key{SPC}
@itemx C-@@
Set mark at point (@code{set-mark-command}).
@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.
@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
@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}.
@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
@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
@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.
@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
@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
or @kbd{Y}, but not @key{SPC}, as an affirmative answer. This is to
diminish the risk of unintentionally executing the command, which is
especially important with commands that do deletion, since there is no
-Todo command to undo a deletion. If you want to be able to use SPC for
+Todo command to undo a deletion. If you want to be able to use @key{SPC} for
confirmation, enable the option @code{todo-y-with-space}.
@end quotation
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
@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
already exists in the directory, Emacs will visit that file, and if not,
the file will be created. Emacs will use the file name (@file{vip.el}, in
this case) as the name of the buffer visiting the file. In order to make
-the buffer name unique, Emacs may append @samp{<2>}, @samp{<3>} etc., to
-the buffer name. As the @dfn{file name completion} is provided here, you
-can sometime save typing. For instance, suppose there is only one file in the
+the buffer name unique, Emacs may add a suffix (@pxref{Uniquify,,,
+emacs, The GNU Emacs Manual}). As @dfn{file name completion} is provided here, you
+can sometimes save typing. For instance, suppose there is only one file in the
default directory whose name starts with @samp{v}, that is @samp{vip.el}.
Then if you just type @kbd{v @key{TAB}} then it will be completed to
@samp{vip.el}. Thus, in this case, you just have to type @kbd{v v @key{TAB}
@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:
@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
Scroll the man page up the window (@code{scroll-up}).
@item @key{DEL}
-@itemx @key{S-SPC}
+@itemx @kbd{S-@key{SPC}}
@kindex DEL
@kindex S-SPC
@findex scroll-down
+2014-06-08 Leo Liu <sdl.web@gmail.com>
+
+ * themes/deeper-blue-theme.el: Use another fix. (Bug#17695)
+
2014-06-08 Juri Linkov <juri@jurta.org>
* themes/deeper-blue-theme.el (diff-added, diff-changed, diff-removed):
+++
** Uniquify is enabled by default, with `post-forward-angle-brackets' style.
+In other words, if you visit two files that have the same base name,
+then rather than creating buffers basename and basename<2>,
+Emacs uses basename<dirA> and basename<dirB>. To change this,
+customize `uniquify-buffer-name-style'. Set it to nil for the old behavior.
+++
** New command `C-x SPC' (`rectangle-mark-mode') makes a rectangular region.
`(cperl-hash-face ((,class (:foreground "coral1"))))
`(cursor ((,class (:background "green"))))
`(default ((,class (:background "#181a26" :foreground "gray80"))))
- `(diff-added ((,class (:foreground "white" :background "darkolivegreen"))))
- `(diff-changed ((,class (:foreground "white" :background "dodgerblue4"))))
+ ;; `(diff-added ((,class (nil))))
+ ;; `(diff-changed ((,class (nil))))
`(diff-context ((,class (:foreground "seashell4"))))
`(diff-file-header ((,class (:background "grey60"))))
`(diff-function ((,class (:inherit diff-header))))
`(diff-header ((,class (:background "grey45"))))
`(diff-hunk-header ((,class (:inherit diff-header))))
`(diff-index ((,class (:inherit diff-file-header))))
- `(diff-indicator-added ((,class (:inherit diff-added))))
- `(diff-indicator-changed ((,class (:inherit diff-changed))))
- `(diff-indicator-removed ((,class (:inherit diff-removed))))
+ `(diff-indicator-added ((,class (:foreground "white" :background "darkolivegreen"))))
+ `(diff-indicator-changed ((,class (:foreground "white" :background "dodgerblue4"))))
+ `(diff-indicator-removed ((,class (:foreground "white" :background "indianred4"))))
`(diff-refine-change ((,class (:background "skyblue4"))))
- `(diff-removed ((,class (:foreground "white" :background "indianred4"))))
+ ;; `(diff-removed ((,class (nil))))
`(dired-marked ((,class (:background "dodgerblue3" :foreground "white"))))
`(ediff-current-diff-A ((,class (:background "green4" :foreground "white"))))
`(ediff-current-diff-B ((,class (:background "darkorange3" :foreground "white"))))
+2014-06-08 Glenn Morris <rgm@gnu.org>
+
+ * startup.el (initial-buffer-choice): Doc fix.
+ Reset :version (adding an option does not merit a :version bump).
+
+ * bookmark.el (bookmark-load):
+ * uniquify.el (uniquify-buffer-name-style): Doc fixes.
+
2014-06-08 Juri Linkov <juri@jurta.org>
* desktop.el: Activate auto-saving on window configuration changes.
If you load a file containing bookmarks with the same names as
bookmarks already present in your Emacs, the new bookmarks will get
-unique numeric suffixes \"<2>\", \"<3>\", ... following the same
-method buffers use to resolve name collisions."
+unique numeric suffixes \"<2>\", \"<3>\", etc."
(interactive
(list (read-file-name
(format "Load bookmarks from: (%s) "
(let (kill-buffer-query-functions kill-buffer-hook)
(kill-buffer obuf))))))
\f
+;; FIXME we really need to fold the uniquify stuff in here by default,
+;; not using advice, and add it to the doc string.
(defun create-file-buffer (filename)
"Create a suitably named buffer for visiting FILENAME, and return it.
FILENAME (sans directory) is used unchanged if that name is free;
"Buffer to show after starting Emacs.
If the value is nil and `inhibit-startup-screen' is nil, show the
startup screen. If the value is a string, switch to a buffer
-visiting the file or directory specified by that string. If the
-value is a function, switch to the buffer returned by that
-function. If t, open the `*scratch*' buffer.
+visiting the file or directory that the string specifies. If the
+value is a function, call it with no arguments and switch to the buffer
+that it returns. If t, open the `*scratch*' buffer.
-A string value also causes emacsclient to open the specified file
-or directory when no target file is specified."
+If you use `emacsclient' with no target file, then it obeys any
+string or function value that this variable has."
:type '(choice
(const :tag "Startup screen" nil)
(directory :tag "Directory" :value "~/")
(file :tag "File" :value "~/.emacs")
- (const :tag "Notes buffer" remember-notes)
+ ;; Note sure about hard-coding this as an option...
+ (const :tag "Remember Mode notes buffer" remember-notes)
(function :tag "Function")
(const :tag "Lisp scratch buffer" t))
- :version "24.4"
+ :version "23.1"
:group 'initialization)
(defcustom inhibit-startup-screen nil
;;; Commentary:
-;; Emacs's standard method for making buffer names unique adds <2>, <3>,
+;; Emacs's traditional method for making buffer names unique adds <2>, <3>,
;; etc. to the end of (all but one of) the buffers. This file replaces
;; that behavior, for buffers visiting files and dired buffers, with a
;; uniquification that adds parts of the file name until the buffer names
(defcustom uniquify-buffer-name-style 'post-forward-angle-brackets
- "If non-nil, buffer names are uniquified with parts of directory name.
-The value determines the buffer name style and is one of `forward',
-`reverse', `post-forward', or `post-forward-angle-brackets'.
-For example, files `/foo/bar/mumble/name' and `/baz/quux/mumble/name'
+ "How to construct unique buffer names for files with the same base name.
+The value can be one of: `forward', `reverse', `post-forward',
+`post-forward-angle-brackets', or nil.
+
+For example, the files `/foo/bar/mumble/name' and `/baz/quux/mumble/name'
would have the following buffer names in the various styles:
- forward bar/mumble/name quux/mumble/name
- reverse name\\mumble\\bar name\\mumble\\quux
- post-forward name|bar/mumble name|quux/mumble
- post-forward-angle-brackets name<bar/mumble> name<quux/mumble>
- nil name name<2>
-Of course, the \"mumble\" part may be stripped as well, depending on the setting
-of `uniquify-strip-common-suffix'."
+
+ forward bar/mumble/name quux/mumble/name
+ reverse name\\mumble\\bar name\\mumble\\quux
+ post-forward name|bar/mumble name|quux/mumble
+ post-forward-angle-brackets name<bar/mumble> name<quux/mumble>
+ nil name name<2>
+
+The \"mumble\" part may be stripped as well, depending on the
+setting of `uniquify-strip-common-suffix'. For more options that
+you can set, browse the `uniquify' custom group."
:type '(radio (const forward)
(const reverse)
(const post-forward)
(const post-forward-angle-brackets)
- (const :tag "standard Emacs behavior (nil)" nil))
+ (const :tag "numeric suffixes" nil))
:version "24.4"
:require 'uniquify
:group 'uniquify)
+2014-06-08 Glenn Morris <rgm@gnu.org>
+
+ * fileio.c (write-region-inhibit-fsync): Doc tweak.
+
+ * data.c (Flss, Fgtr, Fleq, Fgeq): Doc tweaks.
+
2014-06-08 Paul Eggert <eggert@cs.ucla.edu>
If a C name must be extern on some platforms, make it extern on all.
}
DEFUN ("<", Flss, Slss, 1, MANY, 0,
- doc: /* Return t if each arg is less than the next arg. All must be numbers or markers.
+ doc: /* Return t if each arg (a number or marker), is less than the next arg.
usage: (< NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
(ptrdiff_t nargs, Lisp_Object *args)
{
}
DEFUN (">", Fgtr, Sgtr, 1, MANY, 0,
- doc: /* Return t if each arg is greater than the next arg. All must be numbers or markers.
+ doc: /* Return t if each arg (a number or marker) is greater than the next arg.
usage: (> NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
(ptrdiff_t nargs, Lisp_Object *args)
{
}
DEFUN ("<=", Fleq, Sleq, 1, MANY, 0,
- doc: /* Return t if each arg is less than or equal to the next arg.
-All must be numbers or markers.
+ doc: /* Return t if each arg (a number or marker) is less than or equal to the next.
usage: (<= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
(ptrdiff_t nargs, Lisp_Object *args)
{
}
DEFUN (">=", Fgeq, Sgeq, 1, MANY, 0,
- doc: /* Return t if each arg is greater than or equal to the next arg.
-All must be numbers or markers.
+ doc: /* Return t if each arg (a number or marker) is greater than or equal to the next.
usage: (>= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
(ptrdiff_t nargs, Lisp_Object *args)
{
doc: /* Non-nil means don't call fsync in `write-region'.
This variable affects calls to `write-region' as well as save commands.
Setting this to nil may avoid data loss if the system loses power or
-the operating system crashes. */);
+the operating system crashes. By default, it is non-nil in batch mode. */);
write_region_inhibit_fsync = 0; /* See also `init_fileio' above. */
DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash,