When Abbrev mode is enabled, an abbrev expands whenever it is
present in the buffer just before point and you type a self-inserting
-whitespace or punctuation character (@key{SPC}, comma, etc.@:). More
+whitespace or punctuation character (@key{SPC}, comma, etc.). More
precisely, any character that is not a word constituent expands an
abbrev, and any word-constituent character can be part of an abbrev.
The most common way to use an abbrev is to insert it and then insert a
@acronym{ASCII} art with a mouse or with keyboard keys.
@item
-Jay K.@: Adams wrote @file{jka-compr.el} and @file{jka-cmpr-hook.el},
+Jay K. Adams wrote @file{jka-compr.el} and @file{jka-cmpr-hook.el},
providing automatic decompression and recompression for compressed
files.
Emacs.
@item
-Steven L.@: Baur wrote @file{footnote.el} which lets you include
+Steven L. Baur wrote @file{footnote.el} which lets you include
footnotes in email messages; and @file{gnus-audio.el} and
@file{earcon.el}, which provide sound effects for Gnus. He also wrote
@file{gnus-setup.el}.
@item
-Alexander L.@: Belikoff, Sergey Berezin, Sacha Chua, David Edmondson,
+Alexander L. Belikoff, Sergey Berezin, Sacha Chua, David Edmondson,
Noah Friedman, Andreas Fuchs, Mario Lang, Ben Mesander, Lawrence
Mitchell, Gergely Nagy, Michael Olson, Per Persson, Jorgen Schaefer,
Alex Schroeder, and Tom Tromey wrote ERC, an advanced Internet Relay
NeXTstep port of Emacs.
@item
-Anna M.@: Bigatti wrote @file{cal-html.el}, which produces HTML calendars.
+Anna M. Bigatti wrote @file{cal-html.el}, which produces HTML calendars.
@item
Ray Blaak and Simon South wrote @file{delphi.el}, a mode for editing
build process up to the GNU coding standards, and contributed to the
frame support and multi-face support. Jim also wrote @file{tvi970.el},
terminal support for the TeleVideo 970 terminals; and co-wrote
-@file{wyse50.el} (q.v.@:).
+@file{wyse50.el} (q.v.).
@item
Per Bothner wrote @file{term.el}, a terminal emulator in an Emacs
buffer.
@item
-Terrence M.@: Brannon wrote @file{landmark.el}, a neural-network robot
+Terrence M. Brannon wrote @file{landmark.el}, a neural-network robot
that learns landmarks.
@item
Emacs's outline modes.
@item
-David M.@: Brown wrote @file{array.el}, for editing arrays and other
+David M. Brown wrote @file{array.el}, for editing arrays and other
tabular data.
@item
Lisp.
@item
-Chris Chase, Carsten Dominik, and J.@: D.@: Smith wrote IDLWAVE mode,
+Chris Chase, Carsten Dominik, and J. D. Smith wrote IDLWAVE mode,
for editing IDL and WAVE CL.
@item
@item
Carsten Dominik wrote Ref@TeX{}, a package for setting up labels and
cross-references in @LaTeX{} documents; and co-wrote IDLWAVE mode
-(q.v.@:). He was the original author of Org mode, for maintaining notes,
+(q.v.). He was the original author of Org mode, for maintaining notes,
todo lists, and project planning. Bastien Guerry subsequently took
over maintainership. Benjamin Andresen, Thomas Baumann, Joel Boehland, Jan Böcker, Lennart
-Borgman, Baoqiu Cui, Dan Davison, Christian Egli, Eric S.@: Fraga, Daniel German, Chris Gray, Konrad Hinsen, Tassilo Horn, Philip
+Borgman, Baoqiu Cui, Dan Davison, Christian Egli, Eric S. Fraga, Daniel German, Chris Gray, Konrad Hinsen, Tassilo Horn, Philip
Jackson, Martyn Jago, Thorsten Jolitz, Jambunathan K, Tokuya Kameshima, Sergey Litvinov, David Maus, Ross Patterson, Juan Pechiar, Sebastian Rose, Eric Schulte,
Paul Sexton, Ulf Stegemann, Andy Stewart, Christopher Suckling, David O'Toole, John Wiegley, Zhang Weize,
Piotr Zielinski, and others also wrote various Org mode components.
@item
Bastien Guerry wrote @file{gnus-bookmark.el}, bookmark support for Gnus;
-as well as helping to maintain Org mode (q.v.@:).
+as well as helping to maintain Org mode (q.v.).
@item
Henry Guillaume wrote @file{find-file.el}, a package to visit files
Alexandru Harsanyi wrote a library for accessing SOAP web services.
@item
-K.@: Shane Hartman wrote @file{chistory.el} and @file{echistory.el},
+K. Shane Hartman wrote @file{chistory.el} and @file{echistory.el},
packages for browsing command history lists; @file{electric.el} and
@file{helper.el}, which provide an alternative command loop and
appropriate help facilities; @file{emacsbug.el}, a package for
on-the-fly syntax checking.
@item
-David M.@: Koppelman wrote @file{hi-lock.el}, a minor mode for
+David M. Koppelman wrote @file{hi-lock.el}, a minor mode for
interactive automatic highlighting of parts of the buffer text.
@item
@item
Sebastian Kremer wrote @code{dired-mode}, with contributions by Lawrence
-R.@: Dodd. He also wrote @file{ls-lisp.el}, a Lisp emulation of the
+R. Dodd. He also wrote @file{ls-lisp.el}, a Lisp emulation of the
@code{ls} command for platforms that don't have @code{ls} as a standard
program.
Emacs Lisp; @file{cl-specs.el}, specifications to help @code{edebug}
debug code written using David Gillespie's Common Lisp support; and
@file{isearch.el}, Emacs's incremental search minor mode. He also
-co-wrote @file{hideif.el} (q.v.@:).
+co-wrote @file{hideif.el} (q.v.).
@item
Karl Landstrom and Daniel Colascione wrote @file{js.el}, a mode for
@item
Lars Lindberg wrote @file{msb.el}, which provides more flexible menus
-for buffer selection; co-wrote @file{imenu.el} (q.v.@:); and rewrote
+for buffer selection; co-wrote @file{imenu.el} (q.v.); and rewrote
@file{dabbrev.el}, originally written by Don Morrison.
@item
Michael McNamara and Wilson Snyder wrote Verilog mode.
@item
-Christopher J.@: Madsen wrote @file{decipher.el}, a package for cracking
+Christopher J. Madsen wrote @file{decipher.el}, a package for cracking
simple substitution ciphers.
@item
-Neil M.@: Mager wrote @file{appt.el}, functions to notify users of their
+Neil M. Mager wrote @file{appt.el}, functions to notify users of their
appointments. It finds appointments recorded in the diary files
used by the @code{calendar} package.
@file{parse-time.el}, for parsing time strings.
@item
-Takahashi Naoto co-wrote @file{quail.el} (q.v.@:), and wrote
+Takahashi Naoto co-wrote @file{quail.el} (q.v.), and wrote
@file{robin.el}, another input method.
@item
embedded text-based tables.
@item
-Pieter E.@: J.@: Pareit wrote @file{mixal-mode.el}, an editing mode for
+Pieter E. J. Pareit wrote @file{mixal-mode.el}, an editing mode for
the MIX assembly language.
@item
the ``Towers of Hanoi'' puzzle.
@item
-William M.@: Perry wrote @file{mailcap.el} (with Lars Magne
+William M. Perry wrote @file{mailcap.el} (with Lars Magne
Ingebrigtsen), a MIME media types configuration facility;
@file{mwheel.el}, a package for supporting mouse wheels; co-wrote (with
Dave Love) @file{socks.el}, a Socks v5 client; and developed the URL
(q.v.@:) and @file{ada-stmt.el}.
@item
-Richard L.@: Pieri wrote @file{pop3.el}, a Post Office Protocol (RFC
+Richard L. Pieri wrote @file{pop3.el}, a Post Office Protocol (RFC
1460) interface for Emacs.
@item
structures.
@item
-Francesco A.@: Potorti wrote @file{cmacexp.el}, providing a command which
+Francesco A. Potorti wrote @file{cmacexp.el}, providing a command which
runs the C preprocessor on a region of a file and displays the results.
He also expanded and redesigned the @code{etags} program.
@item
-Michael D.@: Prange and Steven A.@: Wood wrote @file{fortran.el}, a mode
+Michael D. Prange and Steven A. Wood wrote @file{fortran.el}, a mode
for editing Fortran code.
@item
bibliography files by keyword.
@item
-Eric S.@: Raymond wrote @file{vc.el}, an interface to the RCS and SCCS
+Eric S. Raymond wrote @file{vc.el}, an interface to the RCS and SCCS
source code version control systems, with Paul Eggert; @file{gud.el},
a package for running source-level debuggers like GDB and SDB in
Emacs; @file{asm-mode.el}, a mode for editing assembly language code;
which each lisp function loaded into Emacs came.
@item
-Edward M.@: Reingold wrote the calendar and diary support,
+Edward M. Reingold wrote the calendar and diary support,
with contributions from Stewart Clamen (@file{cal-mayan.el}), Nachum
Dershowitz (@file{cal-hebrew.el}), Paul Eggert (@file{cal-dst.el}),
Steve Fisk (@file{cal-tex.el}), Michael Kifer (@file{cal-x.el}), Lara
-Rios (@file{cal-menu.el}), and Denis B.@: Roegel (@file{solar.el}).
+Rios (@file{cal-menu.el}), and Denis B. Roegel (@file{solar.el}).
Andy Oram contributed to its documentation. Reingold also contributed
to @file{tex-mode.el}, a mode for editing @TeX{} files, as did William
-F.@: Schelter, Dick King, Stephen Gildea, Michael Prange, and Jacob
+F. Schelter, Dick King, Stephen Gildea, Michael Prange, and Jacob
Gore.
@item
@item
Nick Roberts wrote @file{t-mouse.el}, for mouse support in text
-terminals; and @file{gdb-ui.el}, a graphical user interface to GDB.
+terminals; and @file{gdb-ui.el}, a graphical user interface to GDB@.
Together with Dmitry Dzhus, he wrote @file{gdb-mi.el}, the successor to
@file{gdb-ui.el}.
Markus Rost wrote @file{cus-test.el}, a testing framework for customize.
@item
-Guillermo J.@: Rozas wrote @file{scheme.el}, a mode for editing Scheme and
+Guillermo J. Rozas wrote @file{scheme.el}, a mode for editing Scheme and
DSSSL code.
@item
references in Info files.
@item
-James B.@: Salem and Brewster Kahle wrote @file{completion.el}, providing
+James B. Salem and Brewster Kahle wrote @file{completion.el}, providing
dynamic word completion.
@item
editing Modula-2 code, based on work by Mick Jordan and Peter Robinson.
@item
-Ronald S.@: Schnell wrote @file{dunnet.el}, a text adventure game.
+Ronald S. Schnell wrote @file{dunnet.el}, a text adventure game.
@item
Philippe Schnoebelen wrote @file{gomoku.el}, a Go Moku game played
@file{cus-theme.el}, an interface for custom themes; @file{master.el}, a
package for making a buffer @samp{master} over another; and
@file{spam-stat.el}, for statistical detection of junk email. He also
-wrote parts of the IRC client ERC (q.v.@:).
+wrote parts of the IRC client ERC (q.v.).
@item
Randal Schwartz wrote @file{pp.el}, a pretty-printer for lisp objects.
Lisp interpreter as a subprocess.
@item
-Paul D.@: Smith wrote @file{snmp-mode.el}.
+Paul D. Smith wrote @file{snmp-mode.el}.
@item
William Sommerfeld wrote @file{scribe.el}, a mode for editing Scribe
Ken Stevens wrote @file{ispell.el}, a spell-checker interface.
@item
-Kim F.@: Storm made many improvements to the Emacs display engine,
+Kim F. Storm made many improvements to the Emacs display engine,
process support, and networking support. He also wrote
@file{bindat.el}, a package for encoding and decoding binary data;
CUA mode, which allows Emacs to emulate the standard CUA key
time zones.
@item
-Neil W.@: Van Dyke wrote @file{webjump.el}, a ``hot links'' package.
+Neil W. Van Dyke wrote @file{webjump.el}, a ``hot links'' package.
@item
Didier Verna wrote @file{rect.el}, a package of functions for
operations on rectangle regions of text. He also contributed to Gnus
-(q.v.@:).
+(q.v.).
@item
Joakim Verona implemented ImageMagick support.
for use under MS-DOS.
@item
-Joe Wells wrote the original version of @file{apropos.el} (q.v.@:);
+Joe Wells wrote the original version of @file{apropos.el} (q.v.);
@file{resume.el}, support for processing command-line arguments after
resuming a suspended Emacs job; and @file{mail-extr.el}, a package for
extracting names and addresses from mail headers, with contributions
@file{remember.el}, a mode for jotting down things to remember;
@file{eudcb-mab.el}, an address book backend for the Emacs Unified
Directory Client; and @code{eshell}, a command shell implemented
-entirely in Emacs Lisp. He also contributed to Org mode (q.v.@:).
+entirely in Emacs Lisp. He also contributed to Org mode (q.v.).
@item
Mike Williams wrote @file{thingatpt.el}, a library of functions for
@item
Bill Wohler wrote MH-E, the Emacs interface to the MH mail system;
-making use of earlier work by James R.@: Larus. Satyaki Das, Peter S.@:
-Galbraith, Stephen Gildea, and Jeffrey C.@: Honig also wrote various
+making use of earlier work by James R. Larus. Satyaki Das, Peter S.
+Galbraith, Stephen Gildea, and Jeffrey C. Honig also wrote various
MH-E components.
@item
-Dale R.@: Worley wrote @file{emerge.el}, a package for interactively
+Dale R. Worley wrote @file{emerge.el}, a package for interactively
merging two versions of a file.
@item
-Francis J.@: Wright wrote @file{woman.el}, a package for browsing
+Francis J. Wright wrote @file{woman.el}, a package for browsing
manual pages without the @code{man} command.
@item
other Gnus components.
@item
-Ian T.@: Zimmerman wrote @file{gametree.el}.
+Ian T. Zimmerman wrote @file{gametree.el}.
@item
Reto Zimmermann wrote @file{vera-mode.el}.
@item
-Neal Ziring and Felix S.@: T.@: Wu wrote @file{vi.el}, an emulation of the
+Neal Ziring and Felix S. T. Wu wrote @file{vi.el}, an emulation of the
VI text editor.
@item
@menu
* Auto Reverting the Buffer Menu:: Auto Revert of the Buffer Menu.
* Auto Reverting Dired:: Auto Revert of Dired buffers.
-* Supporting additional buffers:: How to add more Auto Revert support.
+* Supporting additional buffers:: How to add more Auto Revert support.
@end menu
@node Auto Reverting the Buffer Menu
systems.
Dired buffers only auto-revert when the file list of the buffer's main
-directory changes (e.g. when a new file is added). They do not
+directory changes (e.g., when a new file is added). They do not
auto-revert when information about a particular file changes
-(e.g. when the size changes) or when inserted subdirectories change.
+(e.g., when the size changes) or when inserted subdirectories change.
To be sure that @emph{all} listed information is up to date, you have
to manually revert using @kbd{g}, @emph{even} if auto-reverting is
enabled in the Dired buffer. Sometimes, you might get the impression
of a character, using the minibuffer. If you enter a name, the
command provides completion (@pxref{Completion}). If you enter a
code-point, it should be as a hexadecimal number (the convention for
-Unicode), or a number with a specified radix, e.g.@: @code{#o23072}
+Unicode), or a number with a specified radix, e.g., @code{#o23072}
(octal); @xref{Integer Basics,,, elisp, The Emacs Lisp Reference
Manual}. The command then inserts the corresponding character into
the buffer. For example, both of the following insert the infinity
properly. @xref{DEL Does Not Delete}, if you encounter this problem.
The @key{delete} (@code{delete-forward-char}) command deletes in the
-``opposite direction'': it deletes the character after point, i.e. the
+``opposite direction'': it deletes the character after point, i.e., the
character under the cursor. If point was at the end of a line, this
joins the following line onto this one. Like @kbd{@key{DEL}}, it
deletes the text in the region if the region is active (@pxref{Mark}).
by the largest buffer position representable by @dfn{Emacs integers}.
This is because Emacs tracks buffer positions using that data type.
For typical 64-bit machines, this maximum buffer size is @math{2^61 -
-2} bytes, or about 2 EiB. For typical 32-bit machines, the maximum is
-usually @math{2^29 - 2} bytes, or about 512 MiB. Buffer sizes are
+2} bytes, or about 2 EiB@. For typical 32-bit machines, the maximum is
+usually @math{2^29 - 2} bytes, or about 512 MiB@. Buffer sizes are
also limited by the amount of memory in the system.
@menu
@vindex uniquify-buffer-name-style
Other methods work by adding parts of each file's directory to the
-buffer name. To select one, load the library @file{uniquify} (e.g.
+buffer name. To select one, load the library @file{uniquify} (e.g.,
using @code{(require 'uniquify)}), and customize the variable
@code{uniquify-buffer-name-style} (@pxref{Easy Customization}).
@findex next-error-follow-minor-mode
You can type @kbd{C-c C-f} to toggle Next Error Follow mode. In
this minor mode, ordinary cursor motion in the compilation buffer
-automatically updates the source buffer, i.e.@: moving the cursor over
+automatically updates the source buffer, i.e., moving the cursor over
an error message causes the locus of that error to be displayed.
The features of Compilation mode are also available in a minor mode
@ifnottex
On the MS-DOS ``operating system'', asynchronous subprocesses are
not supported, so @kbd{M-x compile} runs the compilation command
-synchronously (i.e.@: you must wait until the command finishes before
+synchronously (i.e., you must wait until the command finishes before
you can do anything else in Emacs). @xref{MS-DOS}.
@end ifnottex
@findex gud-tooltip-mode
@vindex gud-tooltip-echo-area
GUD Tooltip mode is a global minor mode that adds tooltip support to
-GUD. To toggle this mode, type @kbd{M-x gud-tooltip-mode}. It is
+GUD@. To toggle this mode, type @kbd{M-x gud-tooltip-mode}. It is
disabled by default. If enabled, you can move the mouse cursor over a
variable, a function, or a macro (collectively called
@dfn{identifiers}) to show their values in tooltips
@kbd{C-x @key{SPC}} (@code{gud-break}), when called in a source
buffer, sets a debugger breakpoint on the current source line. This
-command is available only after starting GUD. If you call it in a
+command is available only after starting GUD@. If you call it in a
buffer that is not associated with any debugger subprocess, it signals
a error.
that makes sense.
Because @key{TAB} serves as a completion command, you can't use it to
-enter a tab as input to the program you are debugging with GDB.
+enter a tab as input to the program you are debugging with GDB@.
Instead, type @kbd{C-q @key{TAB}} to enter a tab.
@node GUD Customization
you are using DBX; @code{sdb-mode-hook}, if you are using SDB;
@code{xdb-mode-hook}, if you are using XDB; @code{perldb-mode-hook},
for Perl debugging mode; @code{pdb-mode-hook}, for PDB;
-@code{jdb-mode-hook}, for JDB. @xref{Hooks}.
+@code{jdb-mode-hook}, for JDB@. @xref{Hooks}.
The @code{gud-def} Lisp macro (@pxref{Defining Macros,,, elisp, the
Emacs Lisp Reference Manual}) provides a convenient way to define an
@code{holiday-bahai-holidays}, @code{holiday-christian-holidays},
@code{holiday-hebrew-holidays}, @code{holiday-islamic-holidays},
@code{holiday-oriental-holidays}, and @code{holiday-other-holidays}.
-The names should be self-explanatory; e.g.@: @code{holiday-solar-holidays}
+The names should be self-explanatory; e.g., @code{holiday-solar-holidays}
lists sun- and moon-related holidays.
You can customize these lists of holidays to your own needs, deleting or
variables @code{diary-comment-start} and @code{diary-comment-end} to
strings that delimit comments. The fancy display does not print
comments. You might want to put meta-data for the use of other packages
-(e.g.@: the appointment package,
+(e.g., the appointment package,
@iftex
@pxref{Appointments,,,emacs, the Emacs Manual})
@end iftex
2445---Internet Calendaring and Scheduling Core Object Specification
(iCalendar)'' (as well as the earlier vCalendar format).
-@c Importing works for ``ordinary'' (i.e. non-recurring) events, but
+@c Importing works for ``ordinary'' (i.e., non-recurring) events, but
@c (at present) may not work correctly (if at all) for recurring events.
@c Exporting of diary files into iCalendar files should work correctly
@c for most diary entries. This feature is a work in progress, so the
This specifies the current time zone and possibly also daylight
saving time information. On MS-DOS, if @env{TZ} is not set in the
environment when Emacs starts, Emacs defines a default value as
-appropriate for the country code returned by DOS. On MS-Windows, Emacs
+appropriate for the country code returned by DOS@. On MS-Windows, Emacs
does not use @env{TZ} at all.
@item USER
The user's login name. See also @env{LOGNAME}. On MS-DOS, this
When passing a font name to Emacs on the command line, you may need to
``quote'' it, by enclosing it in quotation marks, if it contains
-characters that the shell treats specially (e.g.@: spaces). For
+characters that the shell treats specially (e.g., spaces). For
example:
@smallexample
Depending on your terminal's capabilities, Emacs might be able to turn
on a color mode for 8, 16, 88, or 256 as the value of @var{num}. If
there is no mode that supports @var{num} colors, Emacs acts as if
-@var{num} were 0, i.e.@: it uses the terminal's default color support
+@var{num} were 0, i.e., it uses the terminal's default color support
mode.
@end table
If @var{mode} is omitted, it defaults to @var{ansi8}.
By default, Emacs uses an icon containing the Emacs logo. On
desktop environments such as Gnome, this icon is also displayed in
-other contexts, e.g.@: when switching into an Emacs frame. The
+other contexts, e.g., when switching into an Emacs frame. The
@samp{-nbi} or @samp{--no-bitmap-icon} option tells Emacs to let the
window manager choose what sort of icon to use---usually just a small
rectangle containing the frame's title.
to this as @kbd{C-a} for short. Similarly @kbd{Meta-a}, or @kbd{M-a}
for short, is entered by holding down the @key{Alt} key and pressing
@kbd{a}. Modifier keys can also be applied to non-alphanumerical
-characters, e.g. @kbd{C-@key{F1}} or @kbd{M-@key{left}}.
+characters, e.g., @kbd{C-@key{F1}} or @kbd{M-@key{left}}.
@cindex @key{ESC} replacing @key{Meta} key
You can also type Meta characters using two-character sequences
@vindex custom-enabled-themes
Setting or saving Custom themes actually works by customizing the
variable @code{custom-enabled-themes}. The value of this variable is
-a list of Custom theme names (as Lisp symbols, e.g.@: @code{tango}).
+a list of Custom theme names (as Lisp symbols, e.g., @code{tango}).
Instead of using the @file{*Custom Themes*} buffer to set
@code{custom-enabled-themes}, you can customize the variable using the
-usual customization interface, e.g.@: with @kbd{M-x customize-option}.
+usual customization interface, e.g., with @kbd{M-x customize-option}.
Note that Custom themes are not allowed to set
@code{custom-enabled-themes} themselves.
@cindex loading Lisp libraries automatically
@cindex autoload Lisp libraries
Tell Emacs to find the definition for the function @code{myfunction}
-by loading a Lisp library named @file{mypackage} (i.e.@: a file
+by loading a Lisp library named @file{mypackage} (i.e., a file
@file{mypackage.elc} or @file{mypackage.el}):
@example
More precisely, Emacs first determines which user's init file to use.
It gets your user name from the environment variables @env{LOGNAME} and
-@env{USER}; if neither of those exists, it uses effective user-ID.
+@env{USER}; if neither of those exists, it uses effective user-ID@.
If that user name matches the real user-ID, then Emacs uses @env{HOME};
otherwise, it looks up the home directory corresponding to that user
name in the system's data base of users.
shown in a buffer using Diff mode (@pxref{Comparing Files}).
If the region is active, the default for the file read using the
-minibuffer is the file at the mark (i.e.@: the ordinary Emacs mark,
+minibuffer is the file at the mark (i.e., the ordinary Emacs mark,
not a Dired mark; @pxref{Setting Mark}). Otherwise, if the file at
point has a backup file (@pxref{Backup}), that is the default.
position of point after scrolling. The value of
@code{scroll-up-aggressively} should be either @code{nil} (the
default), or a floating point number @var{f} between 0 and 1. The
-latter means that when point goes below the bottom window edge (i.e.@:
+latter means that when point goes below the bottom window edge (i.e.,
scrolling forward), Emacs scrolls the window so that point is @var{f}
parts of the window height from the bottom window edge. Thus, larger
@var{f} means more aggressive scrolling: more new text is brought into
view. The default value, @code{nil}, is equivalent to 0.5.
Likewise, @code{scroll-down-aggressively} is used when point goes
-above the bottom window edge (i.e.@: scrolling backward). The value
+above the bottom window edge (i.e., scrolling backward). The value
specifies how far point should be from the top margin of the window
after scrolling. Thus, as with @code{scroll-up-aggressively}, a
larger value is more aggressive.
they lack this image. To enable this feature, set the buffer-local
variable @code{indicate-empty-lines} to a non-@code{nil} value. You
can enable or disable this feature for all new buffers by setting the
-default value of this variable, e.g.@: @code{(setq-default
+default value of this variable, e.g., @code{(setq-default
indicate-empty-lines t)}.
@cindex Whitespace mode
Here @var{hh} and @var{mm} are the hour and minute, followed always by
@samp{am} or @samp{pm}. @var{l.ll} is the average number, collected
for the last few minutes, of processes in the whole system that were
-either running or ready to run (i.e.@: were waiting for an available
+either running or ready to run (i.e., were waiting for an available
processor). (Some fields may be missing if your operating system
cannot support them.) If you prefer time display in 24-hour format,
set the variable @code{display-time-24hr-format} to @code{t}.
Some non-@acronym{ASCII} characters have the same appearance as an
@acronym{ASCII} space or hyphen (minus) character. Such characters
can cause problems if they are entered into a buffer without your
-realization, e.g.@: by yanking; for instance, source code compilers
+realization, e.g., by yanking; for instance, source code compilers
typically do not treat non-@acronym{ASCII} spaces as whitespace
characters. To deal with this problem, Emacs displays such characters
specially: it displays @code{U+00A0} (no-break space) with the
If you find GNU Emacs useful, please @strong{send a donation} to the
Free Software Foundation to support our work. Donations to the Free
-Software Foundation are tax deductible in the US. If you use GNU Emacs
+Software Foundation are tax deductible in the US@. If you use GNU Emacs
at your workplace, please suggest that the company make a donation.
For more information on how you can help, see
@url{http://www.gnu.org/help/help.html}.
We also sell hardcopy versions of this manual and @cite{An
-Introduction to Programming in Emacs Lisp}, by Robert J.@: Chassell.
+Introduction to Programming in Emacs Lisp}, by Robert J. Chassell.
You can visit our online store at @url{http://shop.fsf.org/}.
The income from sales goes to support the foundation's purpose: the
development of new free software, and improvements to our existing
@unnumberedsec Acknowledgments
Contributors to GNU Emacs include Jari Aalto, Per Abrahamsen, Tomas
-Abrahamsson, Jay K.@: Adams, Alon Albert, Michael Albinus, Nagy
+Abrahamsson, Jay K. Adams, Alon Albert, Michael Albinus, Nagy
Andras, Benjamin Andresen, Ralf Angeli, Dmitry Antipov, Joe Arceneaux, Emil Åström,
Miles Bader, David Bakhash, Juanma Barranquero, Eli Barzilay, Thomas
-Baumann, Steven L.@: Baur, Jay Belanger, Alexander L.@: Belikoff,
+Baumann, Steven L. Baur, Jay Belanger, Alexander L. Belikoff,
Thomas Bellman, Scott Bender, Boaz Ben-Zvi, Sergey Berezin, Karl
-Berry, Anna M.@: Bigatti, Ray Blaak, Martin Blais, Jim Blandy, Johan
+Berry, Anna M. Bigatti, Ray Blaak, Martin Blais, Jim Blandy, Johan
Bockgård, Jan Böcker, Joel Boehland, Lennart Borgman, Per Bothner,
Terrence Brannon, Frank Bresz, Peter Breton, Emmanuel Briot, Kevin
-Broadey, Vincent Broman, Michael Brouwer, David M.@: Brown, Stefan Bruda,
+Broadey, Vincent Broman, Michael Brouwer, David M. Brown, Stefan Bruda,
Georges Brun-Cottan, Joe Buehler, Scott Byer, W@l{}odek Bzyl,
Bill Carpenter, Per Cederqvist, Hans Chalupsky, Chris Chase, Bob
Chassell, Andrew Choi, Chong Yidong, Sacha Chua, Stewart Clamen, James
Toby Cubitt, Baoqiu Cui, Doug Cutting, Mathias Dahl, Julien Danjou, Satyaki
Das, Vivek Dasmohapatra, Dan Davison, Michael DeCorte, Gary Delp, Nachum
Dershowitz, Dave Detlefs, Matthieu Devin, Christophe de Dinechin, Eri
-Ding, Jan Djärv, Lawrence R.@: Dodd, Carsten Dominik, Scott Draves,
+Ding, Jan Djärv, Lawrence R. Dodd, Carsten Dominik, Scott Draves,
Benjamin Drieu, Viktor Dukhovni, Jacques Duthen, Dmitry Dzhus, John
Eaton, Rolf Ebert, Carl Edman, David Edmondson, Paul Eggert, Stephen
Eglen, Christian Egli, Torbjörn Einarsson, Tsugutomo Enami, David
Engster, Hans Henrik Eriksen, Michael Ernst, Ata Etemadi, Frederick
Farnbach, Oscar Figueiredo, Fred Fish, Steve Fisk, Karl Fogel, Gary
-Foster, Eric S.@: Fraga, Romain Francoise, Noah Friedman, Andreas
-Fuchs, Shigeru Fukaya, Hallvard Furuseth, Keith Gabryelski, Peter S.@:
+Foster, Eric S. Fraga, Romain Francoise, Noah Friedman, Andreas
+Fuchs, Shigeru Fukaya, Hallvard Furuseth, Keith Gabryelski, Peter S.
Galbraith, Kevin Gallagher, Kevin Gallo, Juan León Lahoz García,
Howard Gayle, Daniel German, Stephen Gildea, Julien Gilles, David
Gillespie, Bob Glickstein, Deepak Goel, David De La Harpe Golden, Boris
Goldowsky, David Goodger, Chris Gray, Kevin Greiner, Michelangelo Grigni, Odd
Gripenstam, Kai Großjohann, Michael Gschwind, Bastien Guerry, Henry
Guillaume, Doug Gwyn, Bruno Haible, Ken'ichi Handa, Lars Hansen, Chris
-Hanson, Jesper Harder, Alexandru Harsanyi, K.@: Shane Hartman, John
-Heidemann, Jon K.@: Hellan, Magnus Henoch, Markus Heritsch, Dirk
+Hanson, Jesper Harder, Alexandru Harsanyi, K. Shane Hartman, John
+Heidemann, Jon K. Hellan, Magnus Henoch, Markus Heritsch, Dirk
Herrmann, Karl Heuer, Manabu Higashida, Konrad Hinsen, Anders Holst,
-Jeffrey C.@: Honig, Tassilo Horn, Kurt Hornik, Tom Houlder, Joakim
+Jeffrey C. Honig, Tassilo Horn, Kurt Hornik, Tom Houlder, Joakim
Hove, Denis Howe, Lars Ingebrigtsen, Andrew Innes, Seiichiro Inoue,
Philip Jackson, Martyn Jago, Pavel Janik, Paul Jarc, Ulf Jasper,
-Thorsten Jolitz, Michael K.@: Johnson, Kyle Jones, Terry Jones, Simon
+Thorsten Jolitz, Michael K. Johnson, Kyle Jones, Terry Jones, Simon
Josefsson, Alexandre Julliard, Arne Jørgensen, Tomoji Kagatani,
Brewster Kahle, Tokuya Kameshima, Lute Kamstra, Ivan Kanis, David
Kastrup, David Kaufman, Henry Kautz, Taichi Kawabata, Taro Kawagishi,
Howard Kaye, Michael Kifer, Richard King, Peter Kleiweg, Karel
-Klí@v{c}, Shuhei Kobayashi, Pavel Kobyakov, Larry K.@: Kolodney, David
-M.@: Koppelman, Koseki Yoshinori, Robert Krawitz, Sebastian Kremer,
+Klí@v{c}, Shuhei Kobayashi, Pavel Kobyakov, Larry K. Kolodney, David
+M. Koppelman, Koseki Yoshinori, Robert Krawitz, Sebastian Kremer,
Ryszard Kubiak, Igor Kuzmin, David Kågedal, Daniel LaLiberte, Karl
-Landstrom, Mario Lang, Aaron Larson, James R.@: Larus, Vinicius Jose
+Landstrom, Mario Lang, Aaron Larson, James R. Larus, Vinicius Jose
Latorre, Werner Lemberg, Frederic Lepied, Peter Liljenberg, Christian
Limpach, Lars Lindberg, Chris Lindblad, Anders Lindgren, Thomas Link,
-Juri Linkov, Francis Litterio, Sergey Litvinov, Emilio C.@: Lopes,
+Juri Linkov, Francis Litterio, Sergey Litvinov, Emilio C. Lopes,
Martin Lorentzon, Dave Love, Eric Ludlam, Károly L@H{o}rentey, Sascha
Lüdecke, Greg McGary, Roland McGrath, Michael McNamara, Alan Mackenzie,
-Christopher J.@: Madsen, Neil M.@: Mager, Ken Manheimer, Bill Mann,
+Christopher J. Madsen, Neil M. Mager, Ken Manheimer, Bill Mann,
Brian Marick, Simon Marshall, Bengt Martensson, Charlie Martin,
Yukihiro Matsumoto, Tomohiro Matsuyama, David Maus, Thomas May, Will Mengarini, David
-Megginson, Stefan Merten, Ben A.@: Mesander, Wayne Mesard, Brad
+Megginson, Stefan Merten, Ben A. Mesander, Wayne Mesard, Brad
Miller, Lawrence Mitchell, Richard Mlynarik, Gerd Moellmann, Stefan
Monnier, Keith Moore, Jan Moringen, Morioka Tomohiko, Glenn Morris,
Don Morrison, Diane Murray, Riccardo Murri, Sen Nagata, Erik Naggum,
Jurgen Nickelsen, Dan Nicolaescu, Hrvoje Niksic, Jeff Norden,
Andrew Norman, Kentaro Ohkouchi, Christian Ohler,
Kenichi Okada, Alexandre Oliva, Bob Olson, Michael Olson, Takaaki Ota,
-Pieter E.@: J.@: Pareit, Ross Patterson, David Pearson, Juan Pechiar,
-Jeff Peck, Damon Anton Permezel, Tom Perrine, William M.@: Perry, Per
-Persson, Jens Petersen, Daniel Pfeiffer, Justus Piater, Richard L.@:
+Pieter E. J. Pareit, Ross Patterson, David Pearson, Juan Pechiar,
+Jeff Peck, Damon Anton Permezel, Tom Perrine, William M. Perry, Per
+Persson, Jens Petersen, Daniel Pfeiffer, Justus Piater, Richard L.
Pieri, Fred Pierresteguy, François Pinard, Daniel Pittman, Christian
-Plaunt, Alexander Pohoyda, David Ponce, Francesco A.@: Potorti,
-Michael D.@: Prange, Mukesh Prasad, Ken Raeburn, Marko Rahamaa, Ashwin
-Ram, Eric S.@: Raymond, Paul Reilly, Edward M.@: Reingold, David
+Plaunt, Alexander Pohoyda, David Ponce, Francesco A. Potorti,
+Michael D. Prange, Mukesh Prasad, Ken Raeburn, Marko Rahamaa, Ashwin
+Ram, Eric S. Raymond, Paul Reilly, Edward M. Reingold, David
Reitter, Alex Rezinsky, Rob Riepel, Lara Rios, Adrian Robert, Nick
-Roberts, Roland B.@: Roberts, John Robinson, Denis B.@: Roegel, Danny
+Roberts, Roland B. Roberts, John Robinson, Denis B. Roegel, Danny
Roozendaal, Sebastian Rose, William Rosenblatt, Markus Rost, Guillermo
-J.@: Rozas, Martin Rudalics, Ivar Rummelhoff, Jason Rumney, Wolfgang
-Rupprecht, Benjamin Rutt, Kevin Ryde, James B.@: Salem, Masahiko Sato,
+J. Rozas, Martin Rudalics, Ivar Rummelhoff, Jason Rumney, Wolfgang
+Rupprecht, Benjamin Rutt, Kevin Ryde, James B. Salem, Masahiko Sato,
Timo Savola, Jorgen Schaefer, Holger Schauer, William Schelter, Ralph
-Schleicher, Gregor Schmid, Michael Schmidt, Ronald S.@: Schnell,
+Schleicher, Gregor Schmid, Michael Schmidt, Ronald S. Schnell,
Philippe Schnoebelen, Jan Schormann, Alex Schroeder, Stefan Schoef,
Rainer Schoepf, Raymond Scholz, Eric Schulte, Andreas Schwab, Randal
Schwartz, Oliver Seidel, Manuel Serrano, Paul Sexton, Hovav Shacham,
Stanislav Shalunov, Marc Shapiro, Richard Sharman, Olin Shivers, Tibor
@v{S}imko, Espen Skoglund, Rick Sladkey, Lynn Slater, Chris Smith,
-David Smith, Paul D.@: Smith, Wilson Snyder, William Sommerfeld, Simon
+David Smith, Paul D. Smith, Wilson Snyder, William Sommerfeld, Simon
South, Andre Spiegel, Michael Staats, Thomas Steffen, Ulf Stegemann,
Reiner Steib, Sam Steingold, Ake Stenhoff, Peter Stephenson, Ken
-Stevens, Andy Stewart, Jonathan Stigelman, Martin Stjernholm, Kim F.@:
+Stevens, Andy Stewart, Jonathan Stigelman, Martin Stjernholm, Kim F.
Storm, Steve Strassmann, Christopher Suckling, Olaf Sylvester, Naoto
Takahashi, Steven Tamm, Luc Teirlinck, Jean-Philippe Theberge, Jens
-T.@: Berger Thielemann, Spencer Thomas, Jim Thompson, Toru Tomabechi,
+T. Berger Thielemann, Spencer Thomas, Jim Thompson, Toru Tomabechi,
David O'Toole, Markus Triska, Tom Tromey, Enami Tsugutomo, Eli
Tziperman, Daiki Ueno, Masanobu Umeda, Rajesh Vaidheeswarran, Neil
-W.@: Van Dyke, Didier Verna, Joakim Verona, Ulrik Vieth, Geoffrey
+W. Van Dyke, Didier Verna, Joakim Verona, Ulrik Vieth, Geoffrey
Voelker, Johan Vromans, Inge Wallin, John Paul Wallington, Colin
Walters, Barry Warsaw, Christoph Wedler, Ilja Weis, Zhang Weize,
Morten Welinder, Joseph Brian Wells, Rodney Whitby, John Wiegley,
Sascha Wilde, Ed Wilkinson, Mike Williams, Roland Winkler, Bill
-Wohler, Steven A.@: Wood, Dale R.@: Worley, Francis J.@: Wright, Felix
-S.@: T.@: Wu, Tom Wurgler, Yamamoto Mitsuharu, Katsumi Yamaoka,
+Wohler, Steven A. Wood, Dale R. Worley, Francis J. Wright, Felix
+S. T. Wu, Tom Wurgler, Yamamoto Mitsuharu, Katsumi Yamaoka,
Masatake Yamato, Jonathan Yavner, Ryan Yeske, Ilya Zakharevich, Milan
Zamazal, Victor Zandy, Eli Zaretskii, Jamie Zawinski, Andrew Zhilin,
-Shenghuo Zhu, Piotr Zielinski, Ian T.@: Zimmermann, Reto Zimmermann,
+Shenghuo Zhu, Piotr Zielinski, Ian T. Zimmermann, Reto Zimmermann,
Neal Ziring, Teodor Zlatanov, and Detlev Zundel.
@end iftex
which one alternative is ``preferred'' (see below).
When you select a difference, its state changes from default-A or
-default-B to plain A or B. Thus, the selected difference never has
+default-B to plain A or B@. Thus, the selected difference never has
state default-A or default-B, and these states are never displayed in
the mode line.
The command @kbd{d a} chooses default-A as the default state, and @kbd{d
-b} chooses default-B. This chosen default applies to all differences
+b} chooses default-B@. This chosen default applies to all differences
that you have never selected and for which no alternative is preferred.
If you are moving through the merge sequentially, the differences you
haven't selected are those following the selected one. Thus, while
alternative versions, you can specify the strings to use by setting
the variable @code{emerge-combine-versions-template} to a string of your
choice. In the string, @samp{%a} says where to put version A, and
-@samp{%b} says where to put version B. The default setting, which
+@samp{%b} says where to put version B@. The default setting, which
produces the results shown above, looks like this:
@example
inhibit this insertion by changing the variable
@code{insert-default-directory} to @code{nil} (@pxref{Minibuffer
File}). Regardless, Emacs always assumes that any relative file name
-is relative to the default directory, e.g. entering a file name
+is relative to the default directory, e.g., entering a file name
without a directory specifies a file in the default directory.
@findex cd
multiple names, Emacs does not prevent two users from editing it
simultaneously under different names.
- A lock file cannot be written in some circumstances, e.g. if Emacs
+ A lock file cannot be written in some circumstances, e.g., if Emacs
lacks the system permissions or the system does not support symbolic
links. In these cases, Emacs can still detect the collision when you
try to save a file, by checking the file's last-modification date. If
@code{imagemagick-enabled-types} lists the image types that Emacs may
render using ImageMagick; each element in the list should be an
internal ImageMagick name for an image type, as a symbol or an
-equivalent string (e.g.@: @code{BMP} for @file{.bmp} images). To
+equivalent string (e.g., @code{BMP} for @file{.bmp} images). To
enable ImageMagick for all possible image types, change
@code{imagemagick-enabled-types} to @code{t}. The variable
@code{imagemagick-types-inhibit} lists the image types which should
@item C-c C-p
Move to the beginning of the previous statement
(@code{fortran-previous-statement}/@code{f90-previous-statement}).
-If there is no previous statement (i.e. if called from the first
+If there is no previous statement (i.e., if called from the first
statement in the buffer), move to the start of the buffer.
@kindex C-c C-e @r{(F90 mode)}
@chapter Frames and Graphical Displays
@cindex frames
- When Emacs is started on a graphical display, e.g.@: on the X Window
+ When Emacs is started on a graphical display, e.g., on the X Window
System, it occupies a graphical system-level ``window''. In this
manual, we call this a @dfn{frame}, reserving the word ``window'' for
the part of the frame used for displaying a buffer. A frame initially
@vindex mouse-highlight
Some Emacs buffers include @dfn{buttons}, or @dfn{hyperlinks}:
-pieces of text that perform some action (e.g.@: following a reference)
-when activated (e.g.@: by clicking on them). Usually, a button's text
+pieces of text that perform some action (e.g., following a reference)
+when activated (e.g., by clicking on them). Usually, a button's text
is visually highlighted: it is underlined, or a box is drawn around
it. If you move the mouse over a button, the shape of the mouse
cursor changes and the button lights up. If you change the variable
@cindex X Logical Font Description
The third way to specify a font is to use an @dfn{XLFD} (@dfn{X
Logical Font Description}). This is the traditional method for
-specifying fonts under X. Each XLFD consists of fourteen words or
+specifying fonts under X@. Each XLFD consists of fourteen words or
numbers, separated by dashes, like this:
@example
character. However, matching is implementation-dependent, and can be
inaccurate when wildcards match dashes in a long name. For reliable
results, supply all 14 dashes and use wildcards only within a field.
-Case is insignificant in an XLFD. The syntax for an XLFD is as
+Case is insignificant in an XLFD@. The syntax for an XLFD is as
follows:
@example
@item maker
The name of the font manufacturer.
@item family
-The name of the font family (e.g.@: @samp{courier}).
+The name of the font family (e.g., @samp{courier}).
@item weight
The font weight---normally either @samp{bold}, @samp{medium} or
@samp{light}. Some font names support other values.
face, and by X resources (@pxref{X Resources}).
@dfn{GUD tooltips} are special tooltips that show the values of
-variables when debugging a program with GUD. @xref{Debugger
+variables when debugging a program with GUD@. @xref{Debugger
Operation}.
@node Mouse Avoidance
@xref{Abbrevs}.
@item Aborting
-Aborting means getting out of a recursive edit (q.v.@:). The
+Aborting means getting out of a recursive edit (q.v.). The
commands @kbd{C-]} and @kbd{M-x top-level} are used for this.
@xref{Quitting}.
@item Backtrace
A backtrace is a trace of a series of function calls showing how a
program arrived at a certain point. It is used mainly for finding and
-correcting bugs (q.v.@:). Emacs can display a backtrace when it signals
+correcting bugs (q.v.). Emacs can display a backtrace when it signals
an error or when you type @kbd{C-g} (@pxref{Glossary - Quitting}).
@xref{Checklist}.
@item Balanced Expressions
A balanced expression is a syntactically recognizable expression, such
as a symbol, number, string constant, block, or parenthesized expression
-in C. @xref{Expressions,Balanced Expressions}.
+in C@. @xref{Expressions,Balanced Expressions}.
@item Balloon Help
@xref{Glossary - Tooltips}.
@item Base Buffer
A base buffer is a buffer whose text is shared by an indirect buffer
-(q.v.@:).
+(q.v.).
@item Bidirectional Text
Some human languages, such as English, are written from left to right.
is `bidirectional text'. @xref{Bidirectional Editing}.
@item Bind
-To bind a key sequence means to give it a binding (q.v.@:).
+To bind a key sequence means to give it a binding (q.v.).
@xref{Rebinding}.
@anchor{Glossary - Binding}
@item Binding
A key sequence gets its meaning in Emacs by having a binding, which is a
-command (q.v.@:), a Lisp function that is run when you type that
+command (q.v.), a Lisp function that is run when you type that
sequence. @xref{Commands,Binding}. Customization often involves
rebinding a character to a different command function. The bindings of
-all key sequences are recorded in the keymaps (q.v.@:). @xref{Keymaps}.
+all key sequences are recorded in the keymaps (q.v.). @xref{Keymaps}.
@item Blank Lines
Blank lines are lines that contain only whitespace. Emacs has several
internal border that surrounds the text windows, their scroll bars
and fringes, and separates them from the menu bar and tool bar. You
can customize both borders with options and resources (@pxref{Borders
-X}). Borders are not the same as fringes (q.v.@:).
+X}). Borders are not the same as fringes (q.v.).
@item Buffer
The buffer is the basic editing unit; one buffer corresponds to one text
being edited. You normally have several buffers, but at any time you are
editing only one, the `current buffer', though several can be visible
-when you are using multiple windows or frames (q.v.@:). Most buffers
+when you are using multiple windows or frames (q.v.). Most buffers
are visiting (q.v.@:) some file. @xref{Buffers}.
@item Buffer Selection History
@item Clipboard
A clipboard is a buffer provided by the window system for transferring
text between applications. On the X Window System, the clipboard is
-provided in addition to the primary selection (q.v.@:); on MS-Windows and Mac,
+provided in addition to the primary selection (q.v.); on MS-Windows and Mac,
the clipboard is used @emph{instead} of the primary selection.
@xref{Clipboard}.
@item Command
A command is a Lisp function specially defined to be able to serve as a
-key binding in Emacs. When you type a key sequence (q.v.@:), its
+key binding in Emacs. When you type a key sequence (q.v.), its
binding (q.v.@:) is looked up in the relevant keymaps (q.v.@:) to find
the command to run. @xref{Commands}.
A complete key is a key sequence that fully specifies one action to be
performed by Emacs. For example, @kbd{X} and @kbd{C-f} and @kbd{C-x m}
are complete keys. Complete keys derive their meanings from being bound
-(q.v.@:) to commands (q.v.@:). Thus, @kbd{X} is conventionally bound to
+(q.v.@:) to commands (q.v.). Thus, @kbd{X} is conventionally bound to
a command to insert @samp{X} in the buffer; @kbd{C-x m} is
conventionally bound to a command to begin composing a mail message.
@xref{Keys}.
screen line when displayed. We say that the text line is continued, and all
screen lines used for it after the first are called continuation
lines. @xref{Continuation Lines}. A related Emacs feature is
-`filling' (q.v.@:).
+`filling' (q.v.).
@item Control Character
A control character is a character that you type by holding down the
@item Deletion
Deletion means erasing text without copying it into the kill ring
-(q.v.@:). The alternative is killing (q.v.@:). @xref{Killing,Deletion}.
+(q.v.). The alternative is killing (q.v.). @xref{Killing,Deletion}.
@anchor{Glossary - Deletion of Files}
@item Deletion of Files
confusing for beginning users. @xref{Disabling}.
@item Down Event
-Short for `button down event' (q.v.@:).
+Short for `button down event' (q.v.).
@item Drag Event
A drag event is the kind of input event (q.v.@:) generated when you
@item Electric
We say that a character is electric if it is normally self-inserting
-(q.v.@:), but the current major mode (q.v.@:) redefines it to do something
+(q.v.), but the current major mode (q.v.@:) redefines it to do something
else as well. For example, some programming language major modes define
particular delimiter characters to reindent the line, or insert one or
more newlines in addition to self-insertion.
@item End Of Line
End of line is a character or a sequence of characters that indicate
the end of a text line. On GNU and Unix systems, this is a newline
-(q.v.@:), but other systems have other conventions. @xref{Coding
+(q.v.), but other systems have other conventions. @xref{Coding
Systems,end-of-line}. Emacs can recognize several end-of-line
conventions in files and convert between them.
An error occurs when an Emacs command cannot execute in the current
circumstances. When an error occurs, execution of the command stops
(unless the command has been programmed to do otherwise) and Emacs
-reports the error by displaying an error message (q.v.@:).
+reports the error by displaying an error message (q.v.).
@c Not helpful?
@c Type-ahead is discarded. Then Emacs is ready to read another
@c editing command.
of which directory is current. On GNU and Unix systems, an absolute
file name starts with a slash (the root directory) or with @samp{~/} or
@samp{~@var{user}/} (a home directory). On MS-Windows/MS-DOS, an
-absolute file name can also start with a drive letter and a colon, e.g.
+absolute file name can also start with a drive letter and a colon, e.g.,
@samp{@var{d}:}.
Some people use the term ``pathname'' for file names, but we do not;
-we use the word ``path'' only in the term ``search path'' (q.v.@:).
+we use the word ``path'' only in the term ``search path'' (q.v.).
@item File-Name Component
A file-name component names a file directly within a particular
@item Frame
A frame is a rectangular cluster of Emacs windows. Emacs starts out
with one frame, but you can create more. You can subdivide each frame
-into Emacs windows (q.v.@:). When you are using a window system
-(q.v.@:), more than one frame can be visible at the same time.
+into Emacs windows (q.v.). When you are using a window system
+(q.v.), more than one frame can be visible at the same time.
@xref{Frames}. Some other editors use the term ``window'' for this,
but in Emacs a window means something else.
@item Free Software
Free software is software that gives you the freedom to share, study
and modify it. Emacs is free software, part of the GNU project
-(q.v.@:), and distributed under a copyleft (q.v.@:) license called the
+(q.v.), and distributed under a copyleft (q.v.@:) license called the
GNU General Public License. @xref{Copying}.
@anchor{Glossary - Free Software Foundation}
@item Free Software Foundation
The Free Software Foundation (FSF) is a charitable foundation
-dedicated to promoting the development of free software (q.v.@:).
+dedicated to promoting the development of free software (q.v.).
For more information, see @uref{http://fsf.org/, the FSF website}.
@item Fringe
-On a graphical display (q.v.@:), there's a narrow portion of the frame
+On a graphical display (q.v.), there's a narrow portion of the frame
(q.v.@:) between the text area and the window's border. These
``fringes'' are used to display symbols that provide information about
the buffer text (@pxref{Fringes}). Emacs displays the fringe using a
@item FTP
FTP is an acronym for File Transfer Protocol. This is one standard
-method for retrieving remote files (q.v.@:).
+method for retrieving remote files (q.v.).
@item Function Key
A function key is a key on the keyboard that sends input but does not
@item Global
Global means ``independent of the current environment; in effect
-throughout Emacs''. It is the opposite of local (q.v.@:). Particular
+throughout Emacs''. It is the opposite of local (q.v.). Particular
examples of the use of `global' appear below.
@item Global Abbrev
@item Global Keymap
The global keymap (q.v.@:) contains key bindings that are in effect
everywhere, except when overridden by local key bindings in a major
-mode's local keymap (q.v.@:). @xref{Keymaps}.
+mode's local keymap (q.v.). @xref{Keymaps}.
@item Global Mark Ring
The global mark ring records the series of buffers you have recently
@item GNU
GNU is a recursive acronym for GNU's Not Unix, and it refers to a
-Unix-compatible operating system which is free software (q.v.@:).
+Unix-compatible operating system which is free software (q.v.).
@xref{Manifesto}. GNU is normally used with Linux as the kernel since
Linux works better than the GNU kernel. For more information, see
@uref{http://www.gnu.org/, the GNU website}.
@item Graphical Display
A graphical display is one that can display images and multiple fonts.
-Usually it also has a window system (q.v.@:).
+Usually it also has a window system (q.v.).
@item Highlighting
Highlighting text means displaying it with a different foreground and/or
the mouse pointer is located on portions of display that require some
explanations. Emacs displays help echo for menu items, parts of the
mode line, tool-bar buttons, etc. On graphical displays, the messages
-can be displayed as tooltips (q.v.@:). @xref{Tooltips}.
+can be displayed as tooltips (q.v.). @xref{Tooltips}.
@item Home Directory
Your home directory contains your personal files. On a multi-user GNU
@item Indirect Buffer
An indirect buffer is a buffer that shares the text of another buffer,
-called its base buffer (q.v.@:). @xref{Indirect Buffers}.
+called its base buffer (q.v.). @xref{Indirect Buffers}.
@item Info
Info is the hypertext format used by the GNU project for writing
@item Input Method
An input method is a system for entering non-@acronym{ASCII} text characters by
-typing sequences of @acronym{ASCII} characters (q.v.@:). @xref{Input Methods}.
+typing sequences of @acronym{ASCII} characters (q.v.). @xref{Input Methods}.
@item Insertion
Insertion means adding text into the buffer, either from the keyboard
@item Key Sequence
A key sequence (key, for short) is a sequence of input events (q.v.@:)
that are meaningful as a single unit. If the key sequence is enough to
-specify one action, it is a complete key (q.v.@:); if it is not enough,
-it is a prefix key (q.v.@:). @xref{Keys}.
+specify one action, it is a complete key (q.v.); if it is not enough,
+it is a prefix key (q.v.). @xref{Keys}.
@item Keymap
The keymap is the data structure that records the bindings (q.v.@:) of
@item Kill Ring
The kill ring is where all text you have killed (@pxref{Glossary - Killing})
recently is saved. You can reinsert any of the killed text still in
-the ring; this is called yanking (q.v.@:). @xref{Yanking}.
+the ring; this is called yanking (q.v.). @xref{Yanking}.
@anchor{Glossary - Killing}
@item Killing
Killing means erasing text and saving it on the kill ring so it can be
yanked (q.v.@:) later. Some other systems call this ``cutting''.
Most Emacs commands that erase text perform killing, as opposed to
-deletion (q.v.@:). @xref{Killing}.
+deletion (q.v.). @xref{Killing}.
@item Killing a Job
Killing a job (such as, an invocation of Emacs) means making it cease
@item Language Environment
Your choice of language environment specifies defaults for the input
-method (q.v.@:) and coding system (q.v.@:). @xref{Language
+method (q.v.@:) and coding system (q.v.). @xref{Language
Environments}. These defaults are relevant if you edit
non-@acronym{ASCII} text (@pxref{International}).
Local means ``in effect only in a particular context''; the relevant
kind of context is a particular function execution, a particular
buffer, or a particular major mode. It is the opposite of `global'
-(q.v.@:). Specific uses of `local' in Emacs terminology appear below.
+(q.v.). Specific uses of `local' in Emacs terminology appear below.
@item Local Abbrev
A local abbrev definition is effective only if a particular major mode
@item @kbd{M-C-}
@kbd{M-C-} in the name of a character is an abbreviation for
-Control-Meta; it means the same thing as `@kbd{C-M-}' (q.v.@:).
+Control-Meta; it means the same thing as `@kbd{C-M-}' (q.v.).
@item @kbd{M-x}
@kbd{M-x} is the key sequence that is used to call an Emacs command by
@item Mark
The mark points to a position in the text. It specifies one end of the
-region (q.v.@:), point being the other end. Many commands operate on
+region (q.v.), point being the other end. Many commands operate on
all the text from point to the mark. Each buffer has its own mark.
@xref{Mark}.
@item Mark Ring
The mark ring is used to hold several recent previous locations of the
mark, in case you want to move back to them. Each buffer has its
-own mark ring; in addition, there is a single global mark ring (q.v.@:).
+own mark ring; in addition, there is a single global mark ring (q.v.).
@xref{Mark Ring}.
@item Menu Bar
@item Minibuffer
The minibuffer is the window that appears when necessary inside the
-echo area (q.v.@:), used for reading arguments to commands.
+echo area (q.v.), used for reading arguments to commands.
@xref{Minibuffer}.
@anchor{Glossary - Minibuffer History}
@item Minor Mode
A minor mode is an optional feature of Emacs, which can be switched on
or off independently of all other features. Each minor mode has a
-command to turn it on or off. Some minor modes are global (q.v.@:),
-and some are local (q.v.@:). @xref{Minor Modes}.
+command to turn it on or off. Some minor modes are global (q.v.),
+and some are local (q.v.). @xref{Minor Modes}.
@item Minor Mode Keymap
A minor mode keymap is a keymap that belongs to a minor mode and is
precedence over the global keymap. @xref{Keymaps}.
@item Mode Line
-The mode line is the line at the bottom of each window (q.v.@:), giving
+The mode line is the line at the bottom of each window (q.v.), giving
status information on the buffer displayed in that window. @xref{Mode
Line}.
@item MULE
MULE refers to the Emacs features for editing multilingual
-non-@acronym{ASCII} text using multibyte characters (q.v.@:).
+non-@acronym{ASCII} text using multibyte characters (q.v.).
@xref{International}.
@item Multibyte Character
@xref{International Chars, International Characters}.
@item Named Mark
-A named mark is a register (q.v.@:), in its role of recording a
+A named mark is a register (q.v.), in its role of recording a
location in text so that you can move point to that location.
@xref{Registers}.
@end ignore
@item Primary Selection
-The primary selection is one particular X selection (q.v.@:); it is the
+The primary selection is one particular X selection (q.v.); it is the
selection that most X applications use for transferring text to and from
other applications.
@item Prompt
A prompt is text used to ask you for input. Displaying a prompt
is called prompting. Emacs prompts always appear in the echo area
-(q.v.@:). One kind of prompting happens when the minibuffer is used to
+(q.v.). One kind of prompting happens when the minibuffer is used to
read an argument (@pxref{Minibuffer}); the echoing that happens when
you pause in the middle of typing a multi-character key sequence is also
a kind of prompting (@pxref{Echo Area}).
@xref{Glossary - Regular Expression}.
@item Region
-The region is the text between point (q.v.@:) and the mark (q.v.@:).
+The region is the text between point (q.v.@:) and the mark (q.v.).
Many commands operate on the text of the region. @xref{Mark,Region}.
@item Register
Registers are named slots in which text, buffer positions, or
rectangles can be saved for later use. @xref{Registers}. A related
-Emacs feature is `bookmarks' (q.v.@:).
+Emacs feature is `bookmarks' (q.v.).
@anchor{Glossary - Regular Expression}
@item Regular Expression
@item Restriction
A buffer's restriction is the amount of text, at the beginning or the
end of the buffer, that is temporarily inaccessible. Giving a buffer a
-nonzero amount of restriction is called narrowing (q.v.@:); removing
-a restriction is called widening (q.v.@:). @xref{Narrowing}.
+nonzero amount of restriction is called narrowing (q.v.); removing
+a restriction is called widening (q.v.). @xref{Narrowing}.
@item @key{RET}
@key{RET} is a character that in Emacs runs the command to insert a
newline into the text. It is also used to terminate most arguments
-read in the minibuffer (q.v.@:). @xref{User Input,Return}.
+read in the minibuffer (q.v.). @xref{User Input,Return}.
@item Reverting
Reverting means returning to the original state. Emacs lets you
holds a search path for finding Lisp library files. @xref{Lisp Libraries}.
@item Secondary Selection
-The secondary selection is one particular X selection (q.v.@:); some X
+The secondary selection is one particular X selection (q.v.); some X
applications can use it for transferring text to and from other
applications. Emacs has special mouse commands for transferring text
using the secondary selection. @xref{Secondary Selection}.
selections that other programs have set up. This is the principal way
of transferring text between window applications. Emacs has commands to
work with the primary (q.v.@:) selection and the secondary (q.v.@:)
-selection, and also with the clipboard (q.v.@:).
+selection, and also with the clipboard (q.v.).
@item Self-Documentation
Self-documentation is the feature of Emacs that can tell you what any
@item Suspending
Suspending Emacs means stopping it temporarily and returning control
to its parent process, which is usually a shell. Unlike killing a job
-(q.v.@:), you can later resume the suspended Emacs job without losing
+(q.v.), you can later resume the suspended Emacs job without losing
your buffers, unsaved edits, undo history, etc. @xref{Exiting}.
@item @key{TAB}
@item Theme
A theme is a set of customizations (q.v.@:) that give Emacs a
particular appearance or behavior. For example, you might use a theme
-for your favorite set of faces (q.v.@:).
+for your favorite set of faces (q.v.).
@item Tool Bar
The tool bar is a line (sometimes multiple lines) of icons at the top
of an Emacs frame. Clicking on one of these icons executes a command.
-You can think of this as a graphical relative of the menu bar (q.v.@:).
+You can think of this as a graphical relative of the menu bar (q.v.).
@xref{Tool Bars}.
@anchor{Glossary - Tooltips}
Top level is the normal state of Emacs, in which you are editing the
text of the file you have visited. You are at top level whenever you
are not in a recursive editing level (q.v.@:) or the minibuffer
-(q.v.@:), and not in the middle of a command. You can get back to top
-level by aborting (q.v.@:) and quitting (q.v.@:). @xref{Quitting}.
+(q.v.), and not in the middle of a command. You can get back to top
+level by aborting (q.v.@:) and quitting (q.v.). @xref{Quitting}.
@c FIXME? Transient Mark Mode
Unix is a class of multi-user computer operating systems with a long
history. There are several implementations today. The GNU project
(q.v.@:) aims to develop a complete Unix-like operating system that
-is free software (q.v.@:).
+is free software (q.v.).
@item User Option
A user option is a face (q.v.@:) or a variable (q.v.@:) that exists so
@item Version Control
Version control systems keep track of multiple versions of a source file.
-They provide a more powerful alternative to keeping backup files (q.v.@:).
+They provide a more powerful alternative to keeping backup files (q.v.).
@xref{Version Control}.
@item Visiting
@item Widening
Widening is removing any restriction (q.v.@:) on the current buffer;
-it is the opposite of narrowing (q.v.@:). @xref{Narrowing}.
+it is the opposite of narrowing (q.v.). @xref{Narrowing}.
@item Window
Emacs divides a frame (q.v.@:) into one or more windows, each of which
@item Window System
A window system is software that operates on a graphical display
-(q.v.@:), to subdivide the screen so that multiple applications can
+(q.v.), to subdivide the screen so that multiple applications can
have their] own windows at the same time. All modern operating systems
include a window system.
@anchor{Glossary - Yanking}
@item Yanking
-Yanking means reinserting text previously killed (q.v.@:). It can be
+Yanking means reinserting text previously killed (q.v.). It can be
used to undo a mistaken kill, or for copying or moving text. Some
other systems call this ``pasting''. @xref{Yanking}.
@end table
ways to contribute, see @uref{http://www.gnu.org/help}.
@end quotation
-@unnumberedsec What's GNU? Gnu's Not Unix!
+@unnumberedsec What's GNU@? Gnu's Not Unix!
GNU, which stands for Gnu's Not Unix, is the name for the complete
Unix-compatible software system which I am writing so that I can give it
sophisticated cooling or power.
I have found very many programmers eager to contribute part-time work for
-GNU. For most projects, such part-time distributed work would be very hard
+GNU@. For most projects, such part-time distributed work would be very hard
to coordinate; the independently-written parts would not work together.
But for the particular task of replacing Unix, this problem is absent. A
complete Unix system contains hundreds of utility programs, each of which
@end quotation
There are various forms of free or very cheap publicity that can be used to
-inform numbers of computer users about something like GNU. But it may be
+inform numbers of computer users about something like GNU@. But it may be
true that one can reach more microcomputer users with advertising. If this
is really so, a business which advertises the service of copying and
mailing GNU for a fee ought to be successful enough to pay for its
On the other hand, if many people get GNU from their friends, and such
companies don't succeed, this will show that advertising was not really
-necessary to spread GNU. Why is it that free market advocates don't
+necessary to spread GNU@. Why is it that free market advocates don't
want to let the free market decide this?@footnote{The Free Software
Foundation raises most of its funds from a distribution service,
although it is a charity rather than a company. If @emph{no one}
This command can be used to remove all indentation from the lines in
the region, by invoking it with a large negative argument,
-e.g. @kbd{C-u -1000 C-x @key{TAB}}.
+e.g., @kbd{C-u -1000 C-x @key{TAB}}.
@end table
@node Tab Stops
@cindex deletion
Most commands which erase text from the buffer save it in the kill
ring. These are known as @dfn{kill} commands, and their names
-normally contain the word @samp{kill} (e.g. @code{kill-line}). The
+normally contain the word @samp{kill} (e.g., @code{kill-line}). The
kill ring stores several recent kills, not just the last one, so
killing is a very safe operation: you don't have to worry much about
losing text that you previously killed. The kill ring is shared by
With a plain prefix argument (@kbd{C-u C-y}), the command instead
leaves the cursor in front of the inserted text, and sets the mark at
the end. Using any other prefix argument specifies an earlier kill;
-e.g. @kbd{C-u 4 C-y} reinserts the fourth most recent kill.
+e.g., @kbd{C-u 4 C-y} reinserts the fourth most recent kill.
@xref{Earlier Kills}.
On graphical displays, @kbd{C-y} first checks if another application
Under X, whenever the region is active (@pxref{Mark}), the text in
the region is saved in the primary selection. This applies regardless
of whether the region was made by dragging or clicking the mouse
-(@pxref{Mouse Commands}), or by keyboard commands (e.g. by typing
+(@pxref{Mouse Commands}), or by keyboard commands (e.g., by typing
@kbd{C-@key{SPC}} and moving point; @pxref{Setting Mark}).
@vindex select-active-regions
If you change the variable @code{select-active-regions} to
@code{only}, Emacs saves only temporarily active regions to the
-primary selection, i.e. those made with the mouse or with shift
+primary selection, i.e., those made with the mouse or with shift
selection (@pxref{Shift Selection}). If you change
@code{select-active-regions} to @code{nil}, Emacs avoids saving active
regions to the primary selection entirely.
To enter an Emacs command like @kbd{C-x C-f} while the mark is
active, use one of the following methods: either hold @kbd{Shift}
-together with the prefix key, e.g. @kbd{S-C-x C-f}, or quickly type
-the prefix key twice, e.g. @kbd{C-x C-x C-f}.
+together with the prefix key, e.g., @kbd{S-C-x C-f}, or quickly type
+the prefix key twice, e.g., @kbd{C-x C-x C-f}.
To disable the overriding of standard Emacs binding by CUA mode,
while retaining the other features of CUA mode described below, set
With CUA you can easily copy text and rectangles into and out of
registers by providing a one-digit numeric prefix to the kill, copy,
-and yank commands, e.g. @kbd{C-1 C-c} copies the region into register
+and yank commands, e.g., @kbd{C-1 C-c} copies the region into register
@code{1}, and @kbd{C-2 C-v} yanks the contents of register @code{2}.
@cindex global mark
For example, to copy words from various buffers into a word list in
a given buffer, set the global mark in the target buffer, then
-navigate to each of the words you want in the list, mark it (e.g. with
+navigate to each of the words you want in the list, mark it (e.g., with
@kbd{S-M-f}), copy it to the list with @kbd{C-c} or @kbd{M-w}, and
insert a newline after the word in the target list by pressing
@key{RET}.
time of each version, who made it, and a description of what was
changed.
- The Emacs version control interface is called @dfn{VC}. VC commands
+ The Emacs version control interface is called @dfn{VC}@. VC commands
work with several different version control systems; currently, it
supports GNU Arch, Bazaar, CVS, Git, Mercurial, Monotone, RCS,
SCCS/CSSC, and Subversion. Of these, the GNU project distributes CVS,
control operations.
Some uncommon or intricate version control operations, such as
-altering repository settings, are not supported in VC. You should
-perform such tasks outside Emacs, e.g.@: via the command line.
+altering repository settings, are not supported in VC@. You should
+perform such tasks outside Emacs, e.g., via the command line.
This section provides a general overview of version control, and
describes the version control systems that VC supports. You can skip
@item
SCCS was the first version control system ever built, and was long ago
superseded by more advanced ones. VC compensates for certain features
-missing in SCCS (e.g.@: tag names for releases) by implementing them
+missing in SCCS (e.g., tag names for releases) by implementing them
itself. Other VC features, such as multiple branches, are simply
unavailable. Since SCCS is non-free, we recommend avoiding it.
@cindex CSSC
@item
-CSSC is a free replacement for SCCS. You should use CSSC only if, for
+CSSC is a free replacement for SCCS@. You should use CSSC only if, for
some reason, you cannot use a more recent and better-designed version
control system.
@node VC With A Merging VCS
@subsubsection Basic Version Control with Merging
- On a merging-based version control system (i.e.@: most modern ones;
+ On a merging-based version control system (i.e., most modern ones;
@pxref{VCS Merging}), @kbd{C-x v v} does the following:
@itemize @bullet
@item
If none of the files in the VC fileset are registered with a version
-control system, register the VC fileset, i.e.@: place it under version
+control system, register the VC fileset, i.e., place it under version
control. @xref{Registering}. If Emacs cannot find a system to
register under, it prompts for a repository type, creates a new
repository, and registers the VC fileset with it.
Otherwise, if using CVS or RCS, you can specify a revision ID.
If the fileset is modified (or locked), this makes Emacs commit with
-that revision ID. You can create a new branch by supplying an
+that revision ID@. You can create a new branch by supplying an
appropriate revision ID (@pxref{Branches}).
If the fileset is unmodified (and unlocked), this checks the specified
revision into the working tree. You can also specify a revision on
another branch by giving its revision or branch ID (@pxref{Switching
-Branches}). An empty argument (i.e.@: @kbd{C-u C-x v v @key{RET}})
+Branches}). An empty argument (i.e., @kbd{C-u C-x v v @key{RET}})
checks out the latest (``head'') revision on the current branch.
This signals an error on a decentralized version control system.
prompts for two revision IDs (@pxref{VCS Concepts}), and displays a
diff between those versions of the fileset. This will not work
reliably for multi-file VC filesets, if the version control system is
-file-based rather than changeset-based (e.g.@: CVS), since then
+file-based rather than changeset-based (e.g., CVS), since then
revision IDs for different files would not be related in any
meaningful way.
@findex vc-root-diff
@kindex C-x v D
@kbd{C-x v D} (@code{vc-root-diff}) is similar to @kbd{C-x v =}, but
-it displays the changes in the entire current working tree (i.e.@: the
+it displays the changes in the entire current working tree (i.e., the
working tree containing the current VC fileset). If you invoke this
command from a Dired buffer, it applies to the working tree containing
the directory.
@code{vc-@var{backend}-diff-switches}, @code{vc-diff-switches}, and
@code{diff-switches} (@pxref{Comparing Files}), in that order. Here,
@var{backend} stands for the relevant version control system,
-e.g.@: @code{bzr} for Bazaar. Since @code{nil} means to check the
+e.g., @code{bzr} for Bazaar. Since @code{nil} means to check the
next variable in the sequence, either of the first two may use the
value @code{t} to mean no switches at all. Most of the
@code{vc-@var{backend}-diff-switches} variables default to @code{nil},
@table @kbd
@item p
-Annotate the previous revision, i.e.@: the revision before the one
+Annotate the previous revision, i.e., the revision before the one
currently annotated. A numeric prefix argument is a repeat count, so
@kbd{C-u 10 p} would take you back 10 revisions.
@item n
-Annotate the next revision, i.e.@: the revision after the one
+Annotate the next revision, i.e., the revision after the one
currently annotated. A numeric prefix argument is a repeat count.
@item j
revision.
@item @key{RET}
-In a compact-style log buffer (e.g.@: the one created by @kbd{C-x v
+In a compact-style log buffer (e.g., the one created by @kbd{C-x v
L}), toggle between showing and hiding the full log entry for the
revision at point.
@end table
@pindex cvs
@cindex CVS directory mode
In addition to the VC Directory buffer, Emacs has a similar facility
-called PCL-CVS which is specialized for CVS. @xref{Top, , About
+called PCL-CVS which is specialized for CVS@. @xref{Top, , About
PCL-CVS, pcl-cvs, PCL-CVS --- The Emacs Front-End to CVS}.
@end ifnottex
and their version control statuses. It lists files in the current
directory (the one specified when you called @kbd{C-x v d}) and its
subdirectories, but only those with a ``noteworthy'' status. Files
-that are up-to-date (i.e.@: the same as in the repository) are
+that are up-to-date (i.e., the same as in the repository) are
omitted. If all the files in a subdirectory are up-to-date, the
subdirectory is not listed either. As an exception, if a file has
become up-to-date as a direct result of a VC command, it is listed.
@code{vc-cvs-stay-local} (for CVS) to @code{nil} (@pxref{CVS
Options}), then Emacs avoids contacting a remote repository when
generating the VC Directory buffer (it will still contact it when
-necessary, e.g.@: when doing a commit). This may be desirable if you
+necessary, e.g., when doing a commit). This may be desirable if you
are working offline or the network is slow.
@end ifnottex
branch created from revision 1.2 has revision IDs 1.2.2.1, 1.2.2.2,
@dots{}, and so forth. You can also specify the @dfn{branch ID},
which is a branch revision ID omitting its final component
-(e.g.@: 1.2.1), to switch to the latest revision on that branch.
+(e.g., 1.2.1), to switch to the latest revision on that branch.
On a locking-based system, switching to a different branch also
unlocks (write-protects) the working tree.
To produce a tags table, you run the @command{etags} shell command
on a document or the source code file. The @samp{etags} program
writes the tags to a @dfn{tags table file}, or @dfn{tags file} in
-short. The conventional name for a tags file is @file{TAGS}.
+short. The conventional name for a tags file is @file{TAGS}@.
@xref{Create Tags Table}.
Emacs provides many commands for searching and replacing using the
packages only.
In Ada, the same name can be used for different kinds of entity
-(e.g.@:, for a procedure and for a function). Also, for things like
-packages, procedures and functions, there is the spec (i.e.@: the
-interface) and the body (i.e.@: the implementation). To make it
+(e.g., for a procedure and for a function). Also, for things like
+packages, procedures and functions, there is the spec (i.e., the
+interface) and the body (i.e., the implementation). To make it
easier to pick the definition you want, Ada tag name have suffixes
indicating the type of entity:
@dfn{group buffer}, the @dfn{summary buffer} and the @dfn{article
buffer}.
- The @dfn{group buffer} contains a list of article sources (e.g.@:
+ The @dfn{group buffer} contains a list of article sources (e.g.,
newsgroups and email inboxes), which are collectively referred to as
@dfn{groups}. This is the first buffer Gnus displays when it starts
up. It normally displays only the groups to which you subscribe and
@cindex unsubscribe groups
@item u
Toggle the subscription status of the group on the current line
-(i.e.@: turn a subscribed group into an unsubscribed group, or vice
+(i.e., turn a subscribed group into an unsubscribed group, or vice
versa). Invoking this on a killed or zombie group turns it into an
unsubscribed group.
type @kbd{M-! gunzip foo.gz @key{RET}}. That shell command normally
creates the file @file{foo} and produces no terminal output.
- A numeric argument to @code{shell-command}, e.g.@: @kbd{M-1 M-!},
+ A numeric argument to @code{shell-command}, e.g., @kbd{M-1 M-!},
causes it to insert terminal output into the current buffer instead of
a separate buffer. It puts point before the output, and sets the mark
after the output. For instance, @kbd{M-1 M-! gunzip < foo.gz
While the subshell is waiting or running a command, you can switch
windows or buffers and perform other editing in Emacs. Emacs inserts
the output from the subshell into the Shell buffer whenever it has
-time to process it (e.g.@: while waiting for keyboard input).
+time to process it (e.g., while waiting for keyboard input).
@cindex @code{comint-highlight-input} face
@cindex @code{comint-highlight-prompt} face
@xref{Faces}.
To make multiple subshells, invoke @kbd{M-x shell} with a prefix
-argument (e.g. @kbd{C-u M-x shell}). Then the command will read a
+argument (e.g., @kbd{C-u M-x shell}). Then the command will read a
buffer name, and create (or reuse) a subshell in that buffer. You can
also rename the @file{*shell*} buffer using @kbd{M-x rename-uniquely},
then create a new @file{*shell*} buffer using plain @kbd{M-x shell}.
@cindex @env{EMACS} environment variable
Emacs sets the environment variable @env{INSIDE_EMACS} in the
subshell to @samp{@var{version},comint}, where @var{version} is the
-Emacs version (e.g.@: @samp{24.1}). Programs can check this variable
+Emacs version (e.g., @samp{24.1}). Programs can check this variable
to determine whether they are running inside an Emacs subshell. (It
also sets the @env{EMACS} environment variable to @code{t}, if that
environment variable is not already defined. However, this
@cindex Rlogin
You can login to a remote computer, using whatever commands you
-would from a regular terminal (e.g.@: using the @code{telnet} or
+would from a regular terminal (e.g., using the @code{telnet} or
@code{rlogin} commands), from a Term window.
A program that asks you for a password will normally suppress
Create a new graphical @dfn{client frame}, instead of using an
existing Emacs frame. See below for the special behavior of @kbd{C-x
C-c} in a client frame. If Emacs cannot create a new graphical frame
-(e.g.@: if it cannot connect to the X server), it tries to create a
+(e.g., if it cannot connect to the X server), it tries to create a
text terminal client frame, as though you had supplied the @samp{-t}
option instead.
in a client frame, that command does not kill the Emacs session as it
normally does (@pxref{Exiting}). Instead, Emacs deletes the client
frame; furthermore, if the client frame has an @command{emacsclient}
-waiting to regain control (i.e.@: if you did not supply the @samp{-n}
+waiting to regain control (i.e., if you did not supply the @samp{-n}
option), Emacs deletes all other frames of the same client, and marks
the client's server buffers as finished, as though you had typed
@kbd{C-x #} in all of them. If it so happens that there are no
printer program, customize the variable @code{lpr-command}. To
specify extra switches to give the printer program, customize the list
variable @code{lpr-switches}. Its value should be a list of option
-strings, each of which should start with @samp{-} (e.g.@: the option
+strings, each of which should start with @samp{-} (e.g., the option
string @code{"-w80"} specifies a line width of 80 columns). The
default is the empty list, @code{nil}.
It can be useful to add @code{goto-address-mode} to mode hooks and
hooks for displaying an incoming message
-(e.g.@: @code{rmail-show-message-hook} for Rmail, and
+(e.g., @code{rmail-show-message-hook} for Rmail, and
@code{mh-show-mode-hook} for MH-E). This is not needed for Gnus,
which has a similar feature of its own.
@findex animate-birthday-present
@cindex animate
- The @code{animate} package makes text dance (e.g. @kbd{M-x
+ The @code{animate} package makes text dance (e.g., @kbd{M-x
animate-birthday-present}).
@findex blackbox
@vindex major-mode
The value of the buffer-local variable @code{major-mode} is a symbol
-with the same name as the major mode command (e.g. @code{lisp-mode}).
+with the same name as the major mode command (e.g., @code{lisp-mode}).
This variable is set automatically; you should not change it yourself.
The default value of @code{major-mode} determines the major mode to
Every major mode, apart from Fundamental mode, defines a @dfn{mode
hook}, a customizable list of Lisp functions to run each time the mode
is enabled in a buffer. @xref{Hooks}, for more information about
-hooks. Each mode hook is named after its major mode, e.g. Fortran
+hooks. Each mode hook is named after its major mode, e.g., Fortran
mode has @code{fortran-mode-hook}. Furthermore, all text-based major
modes run @code{text-mode-hook}, and all programming language modes
run @code{prog-mode-hook}, prior to running their own mode hooks.
@kindex BS @r{(MS-DOS)}
The key that is called @key{DEL} in Emacs (because that's how it is
designated on most workstations) is known as @key{BS} (backspace) on a
-PC. That is why the PC-specific terminal initialization remaps the
+PC@. That is why the PC-specific terminal initialization remaps the
@key{BS} key to act as @key{DEL}; the @key{DELETE} key is remapped to act
as @kbd{C-d} for the same reasons.
so the bar cursor is horizontal, and the @code{@var{width}} parameter,
if specified by the frame parameters, actually determines its height.
For this reason, the @code{bar} and @code{hbar} cursor types produce
-the same effect on MS-DOS. As an extension, the bar cursor
+the same effect on MS-DOS@. As an extension, the bar cursor
specification can include the starting scan line of the cursor as well
as its width, like this:
@ifnottex
(@pxref{Init File})
@end ifnottex
-is called @file{_emacs} on MS-DOS. Excess characters before or after
+is called @file{_emacs} on MS-DOS@. Excess characters before or after
the period are generally ignored by MS-DOS itself; thus, if you visit
the file @file{LongFileName.EvenLongerExtension}, you will silently
get @file{longfile.eve}, but Emacs will still display the long file
asynchronous subprocesses are not available. In particular, Shell
mode and its variants do not work. Most Emacs features that use
asynchronous subprocesses also don't work on MS-DOS, including
-Shell mode and GUD. When in doubt, try and see; commands that
+Shell mode and GUD@. When in doubt, try and see; commands that
don't work output an error message saying that asynchronous processes
aren't supported.
Pressing @kbd{C-c} or @kbd{C-@key{BREAK}} might sometimes help in these
cases.
- Accessing files on other machines is not supported on MS-DOS. Other
+ Accessing files on other machines is not supported on MS-DOS@. Other
network-oriented commands such as sending mail, Web browsing, remote
login, etc., don't work either, unless network access is built into
MS-DOS with some network redirector.
data; this is only useful on NTFS volumes. @code{uid} means display
the numerical identifier of the user who owns the file. @code{gid}
means display the numerical identifier of the file owner's group. The
-default value is @code{(links uid gid)} i.e.@: all the 3 optional
+default value is @code{(links uid gid)} i.e., all the 3 optional
attributes are displayed.
@vindex ls-lisp-emulation
Emulate Unix systems. Like @code{GNU}, but sets
@code{ls-lisp-verbosity} to @code{(links uid)}.
@item MacOS
-Emulate MacOS. Sets @code{ls-lisp-ignore-case} to @code{t}, and
+Emulate MacOS@. Sets @code{ls-lisp-ignore-case} to @code{t}, and
@code{ls-lisp-dirs-first} and @code{ls-lisp-verbosity} to @code{nil}.
@item MS-Windows
Emulate MS-Windows. Sets @code{ls-lisp-ignore-case} and
@code{ls-lisp-dirs-first} to @code{t}, and @code{ls-lisp-verbosity} to
-@code{(links)} on Windows NT/2K/XP/2K3 and to @code{nil} on Windows 9X.
+@code{(links)} on Windows NT/2K/XP/2K3 and to @code{nil} on Windows 9X@.
Note that the default emulation is @emph{not} @code{MS-Windows}, even
on Windows, since many users of Emacs on those platforms prefer the
@sc{gnu} defaults.
@file{C:\Users\@var{username}\AppData\Roaming} on Windows
Vista/7/2008, and either @file{C:\WINDOWS\Application Data} or
@file{C:\WINDOWS\Profiles\@var{username}\Application Data} on Windows
-9X/ME. If this directory does not exist or cannot be accessed, Emacs
+9X/ME@. If this directory does not exist or cannot be accessed, Emacs
falls back to @file{C:\} as the default value of @code{HOME}.
You can override this default value of @code{HOME} by explicitly
subprocess should continue normally. However, if the second subprocess
is synchronous, Emacs itself will be hung until the first subprocess
finishes. If it will not finish without user input, then you have no
-choice but to reboot if you are running on Windows 9X. If you are
+choice but to reboot if you are running on Windows 9X@. If you are
running on Windows NT/2K/XP, you can use a process viewer application to kill
the appropriate instance of NTVDM instead (this will terminate both DOS
subprocesses).
customized commands that run MS-Windows applications registered to
handle a certain standard Windows operation for a specific type of
document or file. This function is a wrapper around the Windows
-@code{ShellExecute} API. See the MS-Windows API documentation for
+@code{ShellExecute} API@. See the MS-Windows API documentation for
more details.
@end ifnottex
its name at the prompt.)
@c It seems that select-message-coding-system does this.
-@c Both sendmail.el and smptmail.el call it; i.e. smtpmail.el still
+@c Both sendmail.el and smptmail.el call it; i.e., smtpmail.el still
@c obeys sendmail-coding-system.
@vindex sendmail-coding-system
When you send a mail message (@pxref{Sending Mail}),
@findex set-buffer-file-coding-system
The command @kbd{C-x @key{RET} f}
(@code{set-buffer-file-coding-system}) sets the file coding system for
-the current buffer (i.e.@: the coding system to use when saving or
+the current buffer (i.e., the coding system to use when saving or
reverting the file). You specify which coding system using the
minibuffer. You can also invoke this command by clicking with
@kbd{Mouse-3} on the coding system indicator in the mode line
server about the location of the newly installed fonts with commands
such as:
@c FIXME? I feel like this may be out of date.
-@c Eg the intlfonts tarfile is ~ 10 years old.
+@c E.g., the intlfonts tarfile is ~ 10 years old.
@example
xset fp+ /usr/local/share/emacs/fonts
If you use Latin-1 characters but your terminal can't display
Latin-1, you can arrange to display mnemonic @acronym{ASCII} sequences
-instead, e.g.@: @samp{"o} for o-umlaut. Load the library
+instead, e.g., @samp{"o} for o-umlaut. Load the library
@file{iso-ascii} to do this.
@vindex latin1-display
accented letters and punctuation needed by various European languages
(and some non-European ones). Note that Emacs considers bytes with
codes in this range as raw bytes, not as characters, even in a unibyte
-buffer, i.e.@: if you disable multibyte characters. However, Emacs
+buffer, i.e., if you disable multibyte characters. However, Emacs
can still handle these character codes as if they belonged to
@emph{one} of the single-byte character sets at a time. To specify
@emph{which} of these codes to use, invoke @kbd{M-x
Each paragraph of bidirectional text can have its own @dfn{base
direction}, either right-to-left or left-to-right. (Paragraph
@c paragraph-separate etc have no influence on this?
-boundaries are empty lines, i.e.@: lines consisting entirely of
+boundaries are empty lines, i.e., lines consisting entirely of
whitespace characters.) Text in left-to-right paragraphs begins on
the screen at the left margin of the window and is truncated or
continued when it reaches the right margin. By contrast, text in
@itemize @bullet
@item
-The package name (e.g. @samp{auctex}).
+The package name (e.g., @samp{auctex}).
@item
-The package's version number (e.g. @samp{11.86}).
+The package's version number (e.g., @samp{11.86}).
@item
The package's status---normally one of @samp{available} (can be
Fortran, Icon, IDL (CORBA), IDLWAVE, Java, Javascript, Metafont
(@TeX{}'s companion for font creation), Modula2, Objective-C, Octave,
Pascal, Perl, Pike, PostScript, Prolog, Python, Ruby, Simula, Tcl, and
-VHDL. An alternative mode for Perl is called CPerl mode. Modes are
+VHDL@. An alternative mode for Perl is called CPerl mode. Modes are
also available for the scripting languages of the common GNU and Unix
shells, VMS DCL, and MS-DOS/MS-Windows @samp{BAT} files, and for
makefiles, DNS master files, and various sorts of configuration files.
@end ifinfo
@ifnotinfo
The Emacs distribution contains Info manuals for the major modes for
-Ada, C/C++/Objective C/Java/Corba IDL/Pike/AWK, and IDLWAVE. For
+Ada, C/C++/Objective C/Java/Corba IDL/Pike/AWK, and IDLWAVE@. For
Fortran mode, @pxref{Fortran,,, emacs-xtra, Specialized Emacs Features}.
@end ifnotinfo
To either enable or disable Which Function mode, use the command
@kbd{M-x which-function-mode}. Which Function mode is a global minor
mode. By default, it takes effect in all major modes major modes that
-know how to support it (i.e.@: all the major modes that support
+know how to support it (i.e., all the major modes that support
Imenu). You can restrict it to a specific list of major modes by
changing the value of the variable @code{which-func-modes} from
@code{t} (which means to support all available major modes) to a list
When indenting a line that starts within a parenthetical grouping,
Emacs usually places the start of the line under the preceding line
within the group, or under the text after the parenthesis. If you
-manually give one of these lines a nonstandard indentation (e.g.@: for
+manually give one of these lines a nonstandard indentation (e.g., for
aesthetic purposes), the lines below will follow it.
The indentation commands for most programming language modes assume
To reindent the contents of a single parenthetical grouping,
position point before the beginning of the grouping and type
@kbd{C-M-q}. This changes the relative indentation within the
-grouping, without affecting its overall indentation (i.e.@: the
+grouping, without affecting its overall indentation (i.e., the
indentation of the line where the grouping starts). The function that
@kbd{C-M-q} runs depends on the major mode; it is
@code{indent-pp-sexp} in Lisp mode, @code{c-indent-exp} in C mode,
@findex backward-sexp
To move forward over a balanced expression, use @kbd{C-M-f}
(@code{forward-sexp}). If the first significant character after point
-is an opening delimiter (e.g.@: @samp{(}, @samp{[} or @samp{@{} in C),
+is an opening delimiter (e.g., @samp{(}, @samp{[} or @samp{@{} in C),
this command moves past the matching closing delimiter. If the
character begins a symbol, string, or number, the command moves over
that.
If the region is not active, and there is no existing comment on the
current line, @kbd{M-;} adds a new comment to the current line. If
-the line is blank (i.e.@: empty or containing only whitespace
+the line is blank (i.e., empty or containing only whitespace
characters), the comment is indented to the same position where
@key{TAB} would indent to (@pxref{Basic Indent}). If the line is
non-blank, the comment is placed after the last non-whitespace
breaks the current line, and inserts the necessary comment delimiters
and indentation to continue the comment.
- For languages with closing comment delimiters (e.g.@: @samp{*/} in
+ For languages with closing comment delimiters (e.g., @samp{*/} in
C), the exact behavior of @kbd{M-j} depends on the value of the
variable @code{comment-multi-line}. If the value is @code{nil}, the
command closes the comment on the old line and starts a new comment on
commands recognize upper case letters in
@samp{StudlyCapsIdentifiers} as word boundaries. This is indicated by
the flag @samp{/w} on the mode line after the mode name
-(e.g. @samp{C/law}). You can even use @kbd{M-x subword-mode} in
+(e.g., @samp{C/law}). You can even use @kbd{M-x subword-mode} in
non-CC Mode buffers.
In the GNU project, we recommend using underscores to separate words
to @kbd{C-d}. Note that the Rmail summary versions of these commands
behave slightly differently (@pxref{Rmail Summary Edit}).
-@c mention other hooks, eg show message hook?
+@c mention other hooks, e.g., show message hook?
@vindex rmail-delete-message-hook
Whenever Rmail deletes a message, it runs the hook
@code{rmail-delete-message-hook}. When the hook functions are invoked,
@c FIXME mention --with-hesiod "support Hesiod to get the POP server host"?
@cindex IMAP mailboxes
- Another method for accessing remote mailboxes is IMAP. This method is
+ Another method for accessing remote mailboxes is IMAP@. This method is
supported only by the Mailutils @code{movemail}. To specify an IMAP
mailbox in the inbox list, use the following mailbox @acronym{URL}:
@samp{imap://@var{username}[:@var{password}]@@@var{hostname}}. The
When the current match is on a history element, that history element
is pulled into the minibuffer. If you exit the incremental search
-normally (e.g. by typing @key{RET}), it remains in the minibuffer
+normally (e.g., by typing @key{RET}), it remains in the minibuffer
afterwards. Canceling the search, with @kbd{C-g}, restores the
contents of the minibuffer when you began the search.
@vindex user-full-name
@vindex user-mail-address
The @samp{From} header field identifies the person sending the email
-(i.e.@: you). This should be a valid mailing address, as replies are
+(i.e., you). This should be a valid mailing address, as replies are
normally sent there. The default contents of this header field are
computed from the variables @code{user-full-name} (which specifies
your full name) and @code{user-mail-address} (your email address). On
Text mode turns off the features concerned with comments except when
you explicitly invoke them. It changes the syntax table so that
-single-quotes are considered part of words (e.g.@: @samp{don't} is
+single-quotes are considered part of words (e.g., @samp{don't} is
considered one word). However, if a word starts with a single-quote,
it is treated as a prefix for the purposes of capitalization
-(e.g.@: @kbd{M-c} converts @samp{'hello'} into @samp{'Hello'}, as
+(e.g., @kbd{M-c} converts @samp{'hello'} into @samp{'Hello'}, as
expected).
@cindex Paragraph-Indent Text mode
current heading line as well as all the bodies in its subtree; the
subheadings themselves are left visible. The command @kbd{C-c C-k}
(@code{show-branches}) reveals the subheadings, if they had previously
-been hidden (e.g.@: by @kbd{C-c C-d}). The command @kbd{C-c C-i}
+been hidden (e.g., by @kbd{C-c C-d}). The command @kbd{C-c C-i}
(@code{show-children}) is a weaker version of this; it reveals just
-the direct subheadings, i.e.@: those one level down.
+the direct subheadings, i.e., those one level down.
@findex hide-other
@kindex C-c C-o @r{(Outline mode)}
When zooming in on a heading, to see only the child subheadings specify
a numeric argument: @kbd{C-u C-c C-z}. The number of levels of children
-can be specified too (compare @kbd{M-x show-children}), e.g.@: @kbd{M-2
+can be specified too (compare @kbd{M-x show-children}), e.g., @kbd{M-2
C-c C-z} exposes two levels of child subheadings. Alternatively, the
body can be specified with a negative argument: @kbd{M-- C-c C-z}. The
whole subtree can be expanded, similarly to @kbd{C-c C-s} (@kbd{M-x
Once you have some TODO items planned in an Org file, you can add
that file to the list of @dfn{agenda files} by typing @kbd{C-c [}
(@code{org-agenda-file-to-front}). Org mode is designed to let you
-easily maintain multiple agenda files, e.g.@: for organizing different
+easily maintain multiple agenda files, e.g., for organizing different
aspects of your life. The list of agenda files is stored in the
variable @code{org-agenda-files}.
export and publication. To export the current buffer, type @kbd{C-c
C-e} (@code{org-export}) anywhere in an Org buffer. This command
prompts for an export format; currently supported formats include
-HTML, @LaTeX{}, OpenDocument (@file{.odt}), and PDF. Some formats,
+HTML, @LaTeX{}, OpenDocument (@file{.odt}), and PDF@. Some formats,
such as PDF, require certain system tools to be installed.
@vindex org-publish-project-alist
@subsection @TeX{} Printing Commands
You can invoke @TeX{} as an subprocess of Emacs, supplying either
-the entire contents of the buffer or just part of it (e.g.@: one
+the entire contents of the buffer or just part of it (e.g., one
chapter of a larger document).
@table @kbd
shell command strings described in the preceding paragraph. For
example, if @code{tex-dvi-view-command} is @code{"xdvi"}, @kbd{C-c
C-v} runs @command{xdvi @var{output-file-name}}. In some cases,
-however, the file name needs to be embedded in the command, e.g.@: if
+however, the file name needs to be embedded in the command, e.g., if
you need to provide the file name as an argument to one command whose
output is piped to another. You can specify where to put the file
name with @samp{*} in the command string. For example,
@vindex sgml-xml-mode
You may choose to use the less powerful SGML mode for editing XML,
-since XML is a strict subset of SGML. To enable SGML mode in an
+since XML is a strict subset of SGML@. To enable SGML mode in an
existing buffer, type @kbd{M-x sgml-mode}. On enabling SGML mode,
Emacs examines the buffer to determine whether it is XML; if so, it
sets the variable @code{sgml-xml-mode} to a non-@code{nil} value.
@findex nroff-mode
@vindex nroff-mode-hook
Nroff mode, a major mode derived from Text mode, is
-specialized for editing nroff files (e.g.@: Unix man pages). Type
+specialized for editing nroff files (e.g., Unix man pages). Type
@kbd{M-x nroff-mode} to enter this mode. Entering Nroff mode runs the
hook @code{text-mode-hook}, then @code{nroff-mode-hook}
(@pxref{Hooks}).
@findex table-insert-sequence
@kbd{M-x table-insert-sequence} inserts a string into each cell.
-Each string is a part of a sequence i.e.@: a series of increasing
+Each string is a part of a sequence i.e., a series of increasing
integer numbers.
@cindex table for HTML and LaTeX
Optionally, Emacs can generate a @dfn{core dump} when it crashes. A
core dump is a file containing voluminous data about the state of the
program prior to the crash, usually examined by loading it into a
-debugger such as GDB. On many platforms, core dumps are disabled by
+debugger such as GDB@. On many platforms, core dumps are disabled by
default, and you must explicitly enable them by running the shell
-command @samp{ulimit -c unlimited} (e.g.@: in your shell startup
+command @samp{ulimit -c unlimited} (e.g., in your shell startup
script).
@node After a Crash
@file{core.emacs}, so that another crash won't overwrite it.
To use this script, run @code{gdb} with the file name of your Emacs
-executable and the file name of the core dump, e.g. @samp{gdb
+executable and the file name of the core dump, e.g., @samp{gdb
/usr/bin/emacs core.emacs}. At the @code{(gdb)} prompt, load the
recovery script: @samp{source /usr/src/emacs/etc/emacs-buffer.gdb}.
Then type the command @code{ybuffer-list} to see which buffers are
you can generate change log entries from the version control log
entries of previous commits.
- Note that this only works with RCS or CVS. This procedure would be
+ Note that this only works with RCS or CVS@. This procedure would be
particularly incorrect on a modern changeset-based version control
system, where changes to the @file{ChangeLog} file would normally be
committed as part of a changeset. In that case, you should write the
or two tagged versions against each other.
On SCCS, VC implements tags itself; these tags are visible only
-through VC. Most later systems (including CVS, Subversion, bzr, git,
+through VC@. Most later systems (including CVS, Subversion, bzr, git,
and hg) have a native tag facility, and VC uses it where available;
those tags will be visible even when you bypass VC.
@vindex vc-@var{backend}-header
To insert a suitable header string into the current buffer, type
@kbd{C-x v h} (@code{vc-insert-headers}). This command works only on
-Subversion, CVS, RCS, and SCCS. The variable
+Subversion, CVS, RCS, and SCCS@. The variable
@code{vc-@var{backend}-header} contains the list of keywords to insert
into the version header; for instance, CVS uses @code{vc-cvs-header},
whose default value is @code{'("\$Id\$")}. (The extra backslashes
Then VC always checks the master file to determine the file's status.
VC determines the version control state of files under SCCS much as
-with RCS. It does not consider SCCS version headers, though. Thus,
+with RCS@. It does not consider SCCS version headers, though. Thus,
the variable @code{vc-mistrust-permissions} affects SCCS use, but
@code{vc-consult-headers} does not.
network interactions to a minimum. This is controlled by the variable
@code{vc-cvs-stay-local}. There is another variable,
@code{vc-stay-local}, which enables the feature also for other back
-ends that support it, including CVS. In the following, we will talk
+ends that support it, including CVS@. In the following, we will talk
only about @code{vc-cvs-stay-local}, but everything applies to
@code{vc-stay-local} as well.
without changing the height of the frame. With a positive numeric
argument, this command increases the window height by that many lines;
with a negative argument, it reduces the height by that many lines.
-If there are no vertically adjacent windows (i.e. the window is at the
+If there are no vertically adjacent windows (i.e., the window is at the
full frame height), that signals an error. The command also signals
an error if you attempt to reduce the height of any window below a
certain minimum number of lines, specified by the variable
@findex display-buffer
Some commands try to display ``intelligently'', trying not to take
-over the selected window, e.g. by splitting off a new window and
+over the selected window, e.g., by splitting off a new window and
displaying the desired buffer there. Such commands, which include the
various help commands (@pxref{Help}), work by calling
@code{display-buffer} internally. @xref{Window Choice}, for details.
@cindex undoing window configuration changes
@cindex window configuration changes, undoing
Winner mode is a global minor mode that records the changes in the
-window configuration (i.e. how the frames are partitioned into
+window configuration (i.e., how the frames are partitioned into
windows), so that you can ``undo'' them. You can toggle Winner mode
with @kbd{M-x winner-mode}, or by customizing the variable
@code{winner-mode}. When the mode is enabled, @kbd{C-c left}
@cindex @file{~/.emacs.d/gtkrc} file
If Emacs is compiled with GTK+ toolkit support, the simplest way to
-customize its GTK+ widgets (e.g.@: menus, dialogs, tool bars and
+customize its GTK+ widgets (e.g., menus, dialogs, tool bars and
scroll bars) is to choose an appropriate GTK+ theme, for example with
the GNOME theme selector.
(for Emacs-specific GTK+ resources), or @file{~/.gtkrc-2.0} (for
general GTK+ resources). We recommend using @file{~/.emacs.d/gtkrc},
since GTK+ seems to ignore @file{~/.gtkrc-2.0} when running GConf with
-GNOME. Note, however, that some GTK themes may override
+GNOME@. Note, however, that some GTK themes may override
customizations in @file{~/.emacs.d/gtkrc}; there is nothing we can do
about this. GTK+ resources do not affect aspects of Emacs unrelated
to GTK+ widgets, such as fonts and colors in the main Emacs window;
@noindent
Note that in this case the font name must be supplied as a GTK font
pattern (also called a @dfn{Pango font name}), not as a
-Fontconfig-style font name or XLFD. @xref{Fonts}.
+Fontconfig-style font name or XLFD@. @xref{Fonts}.
To customize widgets you first define a @dfn{style}, and then apply
the style to the widgets. Here is an example that sets the font for
A GTK+ widget is specified by a @dfn{widget name} and a @dfn{widget
class}. The widget name refers to a specific widget
-(e.g.@: @samp{emacs-menuitem}), while the widget class refers to a
-collection of similar widgets (e.g.@: @samp{GtkMenuItem}). A widget
+(e.g., @samp{emacs-menuitem}), while the widget class refers to a
+collection of similar widgets (e.g., @samp{GtkMenuItem}). A widget
always has a class, but need not have a name.
@dfn{Absolute names} are sequences of widget names or widget
This is the default state for widgets.
@item ACTIVE
This is the state for a widget that is ready to do something. It is
-also for the trough of a scroll bar, i.e.@: @code{bg[ACTIVE] = "red"}
+also for the trough of a scroll bar, i.e., @code{bg[ACTIVE] = "red"}
sets the scroll bar trough to red. Buttons that have been pressed but
not released yet (``armed'') are in this state.
@item PRELIGHT
@item bg_pixmap[@var{state}] = "@var{pixmap}"
This specifies an image background (instead of a background color).
@var{pixmap} should be the image file name. GTK can use a number of
-image file formats, including XPM, XBM, GIF, JPEG and PNG. If you
+image file formats, including XPM, XBM, GIF, JPEG and PNG@. If you
want a widget to use the same image as its parent, use
@samp{<parent>}. If you don't want any image, use @samp{<none>}.
@samp{<none>} is the way to cancel a background image inherited from a
the pixmap file in directories specified in @code{pixmap_path}.
@code{pixmap_path} is a colon-separated list of directories within
double quotes, specified at the top level in a @file{gtkrc} file
-(i.e.@: not inside a style definition; see example above):
+(i.e., not inside a style definition; see example above):
@smallexample
pixmap_path "/usr/share/pixmaps:/usr/include/X11/pixmaps"
There are three ways to specify a color: a color name, an RGB
triplet, or a GTK-style RGB triplet. @xref{Colors}, for a description
of color names and RGB triplets. Color names should be enclosed with
-double quotes, e.g.@: @samp{"red"}. RGB triplets should be written
-without double quotes, e.g.@: @samp{#ff0000}. GTK-style RGB triplets
+double quotes, e.g., @samp{"red"}. RGB triplets should be written
+without double quotes, e.g., @samp{#ff0000}. GTK-style RGB triplets
have the form @w{@code{@{ @var{r}, @var{g}, @var{b} @}}}, where
@var{r}, @var{g} and @var{b} are either integers in the range 0-65535
or floats in the range 0.0-1.0.
My thanks to all who helped me with this book. My especial thanks to
@r{Jim Blandy}, @r{Noah Friedman}, @w{Jim Kingdon}, @r{Roland
-McGrath}, @w{Frank Ritter}, @w{Randy Smith}, @w{Richard M.@:
+McGrath}, @w{Frank Ritter}, @w{Randy Smith}, @w{Richard M.
Stallman}, and @w{Melissa Weisshaus}. My thanks also go to both
@w{Philip Johnson} and @w{David Stampe} for their patient
encouragement. My mistakes are my own.
@c has been already used, duplicate ignored
@c I guess that is harmless (what happens if a later part of the text
@c makes a link to something in the first 4 pages though?).
-@c Note that eg the Emacs manual has a preface, but does not bother
+@c E.g., note that the Emacs manual has a preface, but does not bother
@c resetting the page numbers back to 1 after that.
@iftex
@headings off
language. When you write functions' definitions, you will write them in
Emacs Lisp and use other functions as your building blocks. Some of the
functions you will use will themselves be written in Emacs Lisp (perhaps
-by you) and some will be primitives written in C. The primitive
+by you) and some will be primitives written in C@. The primitive
functions are used exactly like those written in Emacs Lisp and behave
like them. They are written in C so we can easily run GNU Emacs on any
computer that has sufficient power and can run C.
copied string to whatever facility exists for copying and pasting
among different programs running in a windowing system. In the X
Windowing system, for example, the @code{x-select-text} function takes
-the string and stores it in memory operated by X. You can paste the
+the string and stores it in memory operated by X@. You can paste the
string in another program, such as an Xterm.
@need 1200
@noindent
In the diagram, each box represents a word of computer memory that
holds a Lisp object, usually in the form of a memory address. The boxes,
-i.e.@: the addresses, are in pairs. Each arrow points to what the address
+i.e., the addresses, are in pairs. Each arrow points to what the address
is the address of, either an atom or another pair of addresses. The
first box is the electronic address of @samp{rose} and the arrow points
to @samp{rose}; the second box is the address of the next pair of boxes,
(load "~/emacs/slowsplit")
@end smallexample
-This evaluates, i.e.@: loads, the @file{slowsplit.el} file or if it
+This evaluates, i.e., loads, the @file{slowsplit.el} file or if it
exists, the faster, byte compiled @file{slowsplit.elc} file from the
@file{emacs} sub-directory of your home directory. The file contains
the function @code{split-window-quietly}, which John Robinson wrote in
@item
While running Edebug, type @kbd{?} to see a list of all the Edebug commands.
-(The @code{global-edebug-prefix} is usually @kbd{C-x X}, i.e.@:
+(The @code{global-edebug-prefix} is usually @kbd{C-x X}, i.e.,
@kbd{@key{CTRL}-x} followed by an upper case @kbd{X}; use this prefix
for commands made outside of the Edebug debugging buffer.)
When a major mode defines a system abbrev, it should call
@code{define-abbrev} and specify @code{t} for the @code{:system}
property. Be aware that any saved non-``system'' abbrevs are restored
-at startup, i.e. before some major modes are loaded. Therefore, major
+at startup, i.e., before some major modes are loaded. Therefore, major
modes should not assume that their abbrev tables are empty when they
are first loaded.
After Emacs reads your init file, it initializes
@code{auto-save-list-file-name} (if you have not already set it
non-@code{nil}) based on this prefix, adding the host name and process
-ID. If you set this to @code{nil} in your init file, then Emacs does
+ID@. If you set this to @code{nil} in your init file, then Emacs does
not initialize @code{auto-save-list-file-name}.
@end defopt
(@pxref{Supporting additional buffers,,, emacs}).
@end ifnottex
@end defvar
-
Lisp code, you must supply the file name string as an ordinary Lisp
function argument.
- If the command is a keyboard macro (i.e.@: a string or vector),
+ If the command is a keyboard macro (i.e., a string or vector),
Emacs executes it using @code{execute-kbd-macro} (@pxref{Keyboard
Macros}).
@defun read-char &optional prompt inherit-input-method seconds
This function reads and returns a character of command input. If the
-user generates an event which is not a character (i.e. a mouse click or
+user generates an event which is not a character (i.e., a mouse click or
function key event), @code{read-char} signals an error. The arguments
work as in @code{read-event}.
most recently unread will be reread first.
Events read from this list are not normally added to the current
-command's key sequence (as returned by e.g. @code{this-command-keys}),
+command's key sequence (as returned by, e.g., @code{this-command-keys}),
as the events will already have been added once as they were read for
the first time. An element of the form @code{(@code{t} . @var{event})}
forces @var{event} to be added to the current command's key sequence.
@var{seconds} is rounded down.
The expression @code{(sit-for 0)} is equivalent to @code{(redisplay)},
-i.e. it requests a redisplay, without any delay, if there is no pending input.
+i.e., it requests a redisplay, without any delay, if there is no pending input.
@xref{Forcing Redisplay}.
If @var{nodisp} is non-@code{nil}, then @code{sit-for} does not
11 sub1 ; @r{Pop @code{integer}, decrement value,}
; @r{push new value onto stack.}
12 call 1 ; @r{Call function @code{factorial} using first}
- ; @r{(i.e. top) stack element as argument;}
+ ; @r{(i.e., top) stack element as argument;}
; @r{push returned value onto stack.}
@end group
@group
4 sub1 ; @r{Subtract 1 from top of stack.}
@end group
@group
-5 dup ; @r{Duplicate top of stack; i.e. copy the top}
+5 dup ; @r{Duplicate top of stack; i.e., copy the top}
; @r{of the stack and push copy onto stack.}
6 varset n ; @r{Pop the top of the stack,}
; @r{and bind @code{n} to the value.}
17 return ; @r{Return value of the top of stack.}
@end group
@end example
-
@code{:version}.
@var{package} should be the official name of the package, as a symbol
-(e.g.@: @code{MH-E}). @var{version} should be a string. If the
+(e.g., @code{MH-E}). @var{version} should be a string. If the
package @var{package} is released as part of Emacs, @var{package} and
@var{version} should appear in the value of
@code{customize-package-emacs-version-alist}.
group's @code{:prefix} keyword are omitted from tag names, whenever
the user customizes the group.
-The default value is @code{nil}, i.e.@: the prefix-discarding feature
+The default value is @code{nil}, i.e., the prefix-discarding feature
is disabled. This is because discarding prefixes often leads to
confusing names for options and faces.
@end defopt
is allowed to take, etc.
@defmac defcustom option standard doc [keyword value]@dots{}
-This macro declares @var{option} as a user option (i.e.@: a
+This macro declares @var{option} as a user option (i.e., a
customizable variable). You should not quote @var{option}.
The argument @var{standard} is an expression that specifies the
If you put a @code{defcustom} in a pre-loaded Emacs Lisp file
(@pxref{Building Emacs}), the standard value installed at dump time
-might be incorrect, e.g.@: because another variable that it depends on
+might be incorrect, e.g., because another variable that it depends on
has not been assigned the right value yet. In that case, use
@code{custom-reevaluate-setting}, described below, to re-evaluate the
standard value after Emacs starts up.
@defun custom-theme-p theme
This function return a non-@code{nil} value if @var{theme} (a symbol)
-is the name of a Custom theme (i.e.@: a Custom theme which has been
+is the name of a Custom theme (i.e., a Custom theme which has been
loaded into Emacs, whether or not the theme is enabled). Otherwise,
it returns @code{nil}.
@end defun
instead of being preempted, even if input is pending and the variable
@code{redisplay-dont-pause} is @code{nil} (see below). If
@code{redisplay-dont-pause} is non-@code{nil} (the default), this
-function redisplays in any case, i.e.@: @var{force} does nothing.
+function redisplays in any case, i.e., @var{force} does nothing.
The function returns @code{t} if it actually tried to redisplay, and
@code{nil} otherwise. A value of @code{t} does not mean that
beyond the right edge of the window are truncated; otherwise, they are
continued. As a special exception, the variable
@code{truncate-partial-width-windows} takes precedence in
-@dfn{partial-width} windows (i.e.@: windows that do not occupy the
+@dfn{partial-width} windows (i.e., windows that do not occupy the
entire frame width).
@end defopt
@kindex mouse-face @r{(overlay property)}
This property is used instead of @code{face} when the mouse is within
the range of the overlay. However, Emacs ignores all face attributes
-from this property that alter the text size (e.g. @code{:height},
+from this property that alter the text size (e.g., @code{:height},
@code{:weight}, and @code{:slant}). Those attributes are always the
same as in the unhighlighted text.
@defun char-width char
This function returns the width in columns of the character
-@var{char}, if it were displayed in the current buffer (i.e.@: taking
+@var{char}, if it were displayed in the current buffer (i.e., taking
into account the buffer's display table, if any; @pxref{Display
Tables}). The width of a tab character is usually @code{tab-width}
(@pxref{Usual Display}).
the ordinary definition of @var{face}.
@var{remapping} may be any face specification suitable for a
-@code{face} text property: either a face (i.e.@: a face name or a
+@code{face} text property: either a face (i.e., a face name or a
property list of attribute/value pairs), or a list of faces. For
details, see the description of the @code{face} text property in
@ref{Special Properties}. @var{remapping} serves as the complete
@itemx underline
@itemx fixed-pitch
@itemx variable-pitch
-These have the attributes indicated by their names (e.g. @code{bold}
+These have the attributes indicated by their names (e.g., @code{bold}
has a bold @code{:weight} attribute), with all other attributes
unspecified (and so given by @code{default}).
@xref{Fringe Bitmaps}, for a list of standard bitmap symbols and how
to define your own. In addition, @code{nil} represents the empty
-bitmap (i.e.@: an indicator that is not shown).
+bitmap (i.e., an indicator that is not shown).
When @code{fringe-indicator-alist} has a buffer-local value, and
there is no bitmap defined for a logical indicator, or the bitmap is
property'' means all the consecutive characters that have the same
Lisp object as their @code{display} property; these characters are
replaced as a single unit. If two characters have different Lisp
-objects as their @code{display} properties (i.e.@: objects which are
+objects as their @code{display} properties (i.e., objects which are
not @code{eq}), they are handled separately.
Here is an example which illustrates this point. A string serves as
@item :index
@c Doesn't work: http://debbugs.gnu.org/7978
This has the same meaning as it does for GIF images (@pxref{GIF Images}),
-i.e. it specifies which image to view inside an image bundle file format
-such as DJVM. You can use the @code{image-metadata} function to
+i.e., it specifies which image to view inside an image bundle file format
+such as DJVM@. You can use the @code{image-metadata} function to
retrieve the total number of images in an image bundle.
@end table
depending on image type. All specifications must at least contain the
properties @code{:type @var{type}} and either @w{@code{:file @var{file}}}
or @w{@code{:data @var{DATA}}}, where @var{type} is a symbol specifying
-the image type, e.g.@: @code{xbm}, @var{file} is the file to load the
+the image type, e.g., @code{xbm}, @var{file} is the file to load the
image from, and @var{data} is a string containing the actual image data.
The first specification in the list whose @var{type} is supported, and
@var{file} exists, is used to construct the image specification to be
@defun image-animated-p image
This function returns non-@code{nil} if @var{image} can be animated.
-The actual return value is a cons @code{(@var{nimages} . @var{delay})},
+The actual return value is a cons @code{(@var{nimages} . @var{delay})},
where @var{nimages} is the number of frames and @var{delay} is the
delay in seconds between them.
@end defun
(@pxref{Text Properties}) to hold the button properties. Such buttons
do not add markers to the buffer, so editing in the buffer does not
slow down if there is an extremely large numbers of buttons. However,
-if there is an existing face text property on the text (e.g.@: a face
+if there is an existing face text property on the text (e.g., a face
assigned by Font Lock mode), the button face may not be visible. Both
of these functions return the starting position of the new button.
@code{ctl-arrow}. If this variable is non-@code{nil} (the default),
these characters are displayed as sequences of two glyphs, where the
first glyph is @samp{^} (a display table can specify a glyph to use
-instead of @samp{^}); e.g.@: the @key{DEL} character is displayed as
+instead of @samp{^}); e.g., the @key{DEL} character is displayed as
@samp{^?}.
If @code{ctl-arrow} is @code{nil}, these characters are displayed as
@cindex glyphless characters
@dfn{Glyphless characters} are characters which are displayed in a
-special way, e.g.@: as a box containing a hexadecimal code, instead of
+special way, e.g., as a box containing a hexadecimal code, instead of
being displayed literally. These include characters which are
explicitly defined to be glyphless, as well as characters for which
there is no available font (on a graphical display), and characters
from right to left. Furthermore, segments of Latin script and digits
embedded in right-to-left text are displayed left-to-right, while
segments of right-to-left script embedded in left-to-right text
-(e.g.@: Arabic or Hebrew text in comments or strings in a program
+(e.g., Arabic or Hebrew text in comments or strings in a program
source file) are appropriately displayed right-to-left. We call such
mixtures of left-to-right and right-to-left text @dfn{bidirectional
text}. This section describes the facilities and options for editing
@cindex unicode bidirectional algorithm
@cindex bidirectional reordering
Text is stored in Emacs buffers and strings in @dfn{logical} (or
-@dfn{reading}) order, i.e.@: the order in which a human would read
+@dfn{reading}) order, i.e., the order in which a human would read
each character. In right-to-left and bidirectional text, the order in
which characters are displayed on the screen (called @dfn{visual
order}) is not the same as logical order; the characters' screen
arguments. @xref{Defining Macros}, for more explanation of
the @code{declare} form.
-@c See eg http://debbugs.gnu.org/10577
+@c See, e.g., http://debbugs.gnu.org/10577
@c FIXME Maybe there should be an Edebug option to get it to
@c automatically load the entire source file containing the function
@c being instrumented. That would avoid this.
condition @code{error}, because quitting is not considered an error.
@c You can grep for "(put 'foo 'error-conditions ...) to find
-@c examples defined in Lisp. Eg soap-client.el, sasl.el.
+@c examples defined in Lisp. E.g., soap-client.el, sasl.el.
Most of these error symbols are defined in C (mainly @file{data.c}),
but some are defined in Lisp. For example, the file @file{userlock.el}
defines the @code{file-locked} and @code{file-supersession} errors.
@item end-of-file
The message is @samp{End of file during parsing}. Note that this is
not a subcategory of @code{file-error}, because it pertains to the
-Lisp reader, not to file I/O. @xref{Input Functions}.
+Lisp reader, not to file I/O@. @xref{Input Functions}.
@item file-already-exists
This is a subcategory of @code{file-error}. @xref{Writing to Files}.
@defvar find-file-literally
This buffer-local variable, if set to a non-@code{nil} value, makes
@code{save-buffer} behave as if the buffer were visiting its file
-literally, i.e. without conversions of any kind. The command
+literally, i.e., without conversions of any kind. The command
@code{find-file-literally} sets this variable's local value, but other
-equivalent functions and commands can do that as well, e.g.@: to avoid
+equivalent functions and commands can do that as well, e.g., to avoid
automatic addition of a newline at the end of the file. This variable
is permanent local, so it is unaffected by changes of major modes.
@end defvar
The predicate is passed the candidate file name as its single
argument. If @var{predicate} is @code{nil} or omitted,
@code{locate-file} uses @code{file-readable-p} as the predicate.
-@xref{Kinds of Files}, for other useful predicates, e.g.@:
+@xref{Kinds of Files}, for other useful predicates, e.g.,
@code{file-executable-p} and @code{file-directory-p}.
For compatibility, @var{predicate} can also be one of the symbols
@var{modes} into the equivalent integer value. If the symbolic
specification is based on an existing file, that file's mode bits are
taken from the optional argument @var{base-modes}; if that argument is
-omitted or @code{nil}, it defaults to 0, i.e.@: no access rights at
+omitted or @code{nil}, it defaults to 0, i.e., no access rights at
all.
@end defun
@defun terminal-live-p object
This predicate returns a non-@code{nil} value if @var{object} is a
-terminal that is live (i.e.@: not deleted), and @code{nil} otherwise.
+terminal that is live (i.e., not deleted), and @code{nil} otherwise.
For live terminals, the return value indicates what kind of frames are
displayed on that terminal; the list of possible values is the same as
for @code{framep} above.
@itemize @bullet
@item
-The name of the device used by the terminal (e.g.@: @samp{:0.0} or
+The name of the device used by the terminal (e.g., @samp{:0.0} or
@file{/dev/tty}).
@item
@item
The kind of display associated with the terminal. This is the symbol
-returned by the function @code{terminal-live-p} (i.e.@: @code{x},
+returned by the function @code{terminal-live-p} (i.e., @code{x},
@code{t}, @code{w32}, @code{ns}, or @code{pc}). @xref{Frames}.
@item
Before creating the frame, this function ensures that Emacs is ``set
up'' to display graphics. For instance, if Emacs has not processed X
-resources (e.g.@: if it was started on a text terminal), it does so at
+resources (e.g., if it was started on a text terminal), it does so at
this time. In all other respects, this function behaves like
@code{make-frame} (@pxref{Creating Frames}).
@end deffn
@defopt minibuffer-frame-alist
This variable's value is an alist of parameter values used when
-creating an initial minibuffer-only frame (i.e.@: the minibuffer-only
+creating an initial minibuffer-only frame (i.e., the minibuffer-only
frame that Emacs creates if @code{initial-frame-alist} specifies a
frame with no minibuffer).
@end defopt
@end defun
@c FIXME? Belongs more in Emacs manual than here?
-@c But eg fit-window-to-buffer is in this manual.
+@c But, e.g., fit-window-to-buffer is in this manual.
@deffn Command fit-frame-to-buffer &optional frame max-height min-height
This command adjusts the height of @var{frame} (the default is the
selected frame) to fit its contents. The optional arguments
@cindex frames, scanning all
@defun frame-list
-This function returns a list of all the live frames, i.e.@: those that
+This function returns a list of all the live frames, i.e., those that
have not been deleted. It is analogous to @code{buffer-list} for
buffers, and includes frames on all terminals. The list that you get
is newly created, so modifying the list doesn't have any effect on the
@cindex raising a frame
@cindex lowering a frame
Most window systems use a desktop metaphor. Part of this metaphor
-is the idea that system-level windows (e.g.@: Emacs frames) are
+is the idea that system-level windows (e.g., Emacs frames) are
stacked in a notional third dimension perpendicular to the screen
surface. Where two overlap, the one higher up covers the one
underneath. You can @dfn{raise} or @dfn{lower} a frame using the
@vindex dnd-protocol-alist
When an URL is dropped on Emacs it may be a file, but it may also be
another URL type (ftp, http, etc.). Emacs first checks
-@code{dnd-protocol-alist} to determine what to do with the URL. If
+@code{dnd-protocol-alist} to determine what to do with the URL@. If
there is no match there and if @code{browse-url-browser-function} is
an alist, Emacs looks for a match there. If no match is found the
text for the URL is inserted. If you want to alter Emacs behavior,
In most computer languages, every function has a name. But in Lisp,
a function in the strictest sense has no name: it is an object which
-can @emph{optionally} be associated with a symbol (e.g.@: @code{car})
+can @emph{optionally} be associated with a symbol (e.g., @code{car})
that serves as the function name. @xref{Function Names}. When a
function has been given a name, we usually also refer to that symbol
-as a ``function'' (e.g.@: we refer to ``the function @code{car}'').
+as a ``function'' (e.g., we refer to ``the function @code{car}'').
In this manual, the distinction between a function name and the
function object itself is usually unimportant, but we will take note
wherever it is relevant.
@table @dfn
@item lambda expression
-A function (in the strict sense, i.e.@: a function object) which is
+A function (in the strict sense, i.e., a function object) which is
written in Lisp. These are described in the following section.
@ifnottex
@xref{Lambda Expressions}.
@cindex primitive
@cindex subr
@cindex built-in function
-A function which is callable from Lisp but is actually written in C.
+A function which is callable from Lisp but is actually written in C@.
Primitives are also called @dfn{built-in functions}, or @dfn{subrs}.
Examples include functions like @code{car} and @code{append}. In
addition, all special forms (see below) are also considered
primitives.
Usually, a function is implemented as a primitive because it is a
-fundamental part of Lisp (e.g.@: @code{car}), or because it provides a
+fundamental part of Lisp (e.g., @code{car}), or because it provides a
low-level interface to operating system services, or because it needs
to run fast. Unlike functions defined in Lisp, primitives can be
modified or added only by changing the C sources and recompiling
@defun functionp object
This function returns @code{t} if @var{object} is any kind of
-function, i.e.@: can be passed to @code{funcall}. Note that
+function, i.e., can be passed to @code{funcall}. Note that
@code{functionp} returns @code{t} for symbols that are function names,
and returns @code{nil} for special forms.
@end defun
A symbol can serve as the name of a function. This happens when the
symbol's @dfn{function cell} (@pxref{Symbol Components}) contains a
-function object (e.g.@: a lambda expression). Then the symbol itself
+function object (e.g., a lambda expression). Then the symbol itself
becomes a valid, callable function, equivalent to the function object
in its function cell.
define or alter functions, like @code{defadvice} (@pxref{Advising
Functions}). (If @code{defun} were not a primitive, it could be
written as a Lisp macro using @code{fset}.) You can also use it to
-give a symbol a function definition that is not a list, e.g.@: a
+give a symbol a function definition that is not a list, e.g., a
keyboard macro (@pxref{Keyboard Macros}):
@example
As explained in @ref{Variable Scoping}, Emacs can optionally enable
lexical binding of variables. When lexical binding is enabled, any
-named function that you create (e.g.@: with @code{defun}), as well as
+named function that you create (e.g., with @code{defun}), as well as
any anonymous function that you create using the @code{lambda} macro
or the @code{function} special form or the @code{#'} syntax
(@pxref{Anonymous Functions}), is automatically converted into a
without error.
There are some function definitions that @samp{check-declare} does not
-understand (e.g. @code{defstruct} and some other macros). In such cases,
+understand (e.g., @code{defstruct} and some other macros). In such cases,
you can pass a non-@code{nil} @var{fileonly} argument to
@code{declare-function}, meaning to only check that the file exists, not
that it actually defines the function. Note that to do this without
@cindex safety of functions
Some major modes, such as SES, call functions that are stored in user
-files. (@inforef{Top, ,ses}, for more information on SES.) User
+files. (@inforef{Top, ,ses}, for more information on SES@.) User
files sometimes have poor pedigrees---you can get a spreadsheet from
someone you've just met, or you can get one through email from someone
you've never met. So it is risky to call a function whose source code
Emacs notation for keyboard input. A normal printing character
appears as itself, but a control character turns into a string
starting with @samp{C-}, a meta character turns into a string starting
-with @samp{M-}, and space, tab, etc.@: appear as @samp{SPC},
+with @samp{M-}, and space, tab, etc., appear as @samp{SPC},
@samp{TAB}, etc. A function key symbol appears inside angle brackets
@samp{<@dots{}>}. An event that is a list appears as the name of the
symbol in the @sc{car} of the list, inside angle brackets.
echo area at first, and display the longer @var{help-text} strings only
if the user types the help character again.
@end defopt
-
@c I tried to include words in a cindex that give the context of the entry,
@c particularly if there is more than one entry for the same concept.
@c For example, "nil in keymap"
-@c Similarly for explicit findex and vindex entries, e.g. "print example".
+@c Similarly for explicit findex and vindex entries, e.g., "print example".
-@c Error codes are given cindex entries, e.g. "end-of-file error".
+@c Error codes are given cindex entries, e.g., "end-of-file error".
@c pindex is used for .el files and Unix programs
@c Print the indices
@printindex fn
-
-
@cindex primitive function internals
@cindex writing Emacs primitives
- Lisp primitives are Lisp functions implemented in C. The details of
+ Lisp primitives are Lisp functions implemented in C@. The details of
interfacing the C function so that Lisp can call it are handled by a few
C macros. The only way to really understand how to write new C code is
to read the source, but we can explain some things here.
@end smallexample
Note that C code cannot call functions by name unless they are defined
-in C. The way to call a function written in Lisp is to use
+in C@. The way to call a function written in Lisp is to use
@code{Ffuncall}, which embodies the Lisp function @code{funcall}. Since
the Lisp function @code{funcall} accepts an unlimited number of
arguments, in C it takes two: the number of Lisp-level arguments, and a
@cindex buffer internals
Two structures (see @file{buffer.h}) are used to represent buffers
-in C. The @code{buffer_text} structure contains fields describing the
+in C@. The @code{buffer_text} structure contains fields describing the
text of a buffer; the @code{buffer} structure holds other fields. In
the case of indirect buffers, two or more @code{buffer} structures
reference the same @code{buffer_text} structure.
respectively. @code{hchild} is used if the window is subdivided
horizontally by child windows, and @code{vchild} if it is subdivided
vertically. In a live window, only one of @code{hchild}, @code{vchild},
-and @code{buffer} (q.v.) is non-@code{nil}.
+and @code{buffer} (q.v.@:) is non-@code{nil}.
@item next
@itemx prev
@cindex Common Lisp
Dozens of Lisp implementations have been built over the years, each
with its own idiosyncrasies. Many of them were inspired by Maclisp,
-which was written in the 1960s at MIT's Project MAC. Eventually the
+which was written in the 1960s at MIT's Project MAC@. Eventually the
implementers of the descendants of Maclisp came together and developed a
standard for Lisp systems, called Common Lisp. In the meantime, Gerry
Sussman and Guy Steele at MIT developed a simplified but very powerful
@end defun
By convention, any argument whose name contains the name of a type
-(e.g.@: @var{integer}, @var{integer1} or @var{buffer}) is expected to
+(e.g., @var{integer}, @var{integer1} or @var{buffer}) is expected to
be of that type. A plural of a type (such as @var{buffers}) often
means a list of objects of that type. An argument named @var{object}
may be of any type. (For a list of Emacs object types, @pxref{Lisp
Data Types}.) An argument with any other sort of name
-(e.g.@: @var{new-file}) is specific to the function; if the function
+(e.g., @var{new-file}) is specific to the function; if the function
has a documentation string, the type of the argument should be
described there (@pxref{Documentation}).
@end defun
@code{current-local-map} returns a reference to the local keymap, not
-a copy of it; if you use @code{define-key} or other functions on it
+a copy of it; if you use @code{define-key} or other functions on it
you will alter local bindings.
@defun current-minor-mode-maps
remapped to @code{my-kill-line}; if an ordinary binding specifies
@code{my-kill-line}, it is remapped to @code{my-other-kill-line}.
-To undo the remapping of a command, remap it to @code{nil}; e.g.
+To undo the remapping of a command, remap it to @code{nil}; e.g.,
@smallexample
(define-key my-mode-map [remap kill-line] nil)
after @code{input-decode-map} and before @code{key-translation-map}.
Entries in @code{local-function-key-map} are ignored if they conflict
-with bindings made in the minor mode, local, or global keymaps. I.e.
+with bindings made in the minor mode, local, or global keymaps. I.e.,
the remapping only applies if the original key sequence would
otherwise not have any binding.
the menu's commands. Emacs displays the overall prompt string as the
menu title in some cases, depending on the toolkit (if any) used for
displaying menus.@footnote{It is required for menus which do not use a
-toolkit, e.g.@: under MS-DOS.} Keyboard menus also display the
+toolkit, e.g., under MS-DOS.} Keyboard menus also display the
overall prompt string.
The easiest way to construct a keymap with a prompt string is to
and @code{:visible} for a menu separator:
@code{(menu-item @var{separator-type} nil . @var{item-property-list})}
-
+
For example:
-
+
@example
(menu-item "--" nil :visible (boundp 'foo))
@end example
The same magic comment can copy any kind of form into
@file{loaddefs.el}. The form following the magic comment is copied
verbatim, @emph{except} if it is one of the forms which the autoload
-facility handles specially (e.g.@: by conversion into an
+facility handles specially (e.g., by conversion into an
@code{autoload} call). The forms which are not copied verbatim are
the following:
@defun featurep feature &optional subfeature
This function returns @code{t} if @var{feature} has been provided in
-the current Emacs session (i.e.@:, if @var{feature} is a member of
+the current Emacs session (i.e., if @var{feature} is a member of
@code{features}.) If @var{subfeature} is non-@code{nil}, then the
function returns @code{t} only if that subfeature is provided as well
-(i.e.@: if @var{subfeature} is a member of the @code{subfeature}
+(i.e., if @var{subfeature} is a member of the @code{subfeature}
property of the @var{feature} symbol.)
@end defun
(eval-after-load "foo/bar/my_inst.elc" @dots{})
@end example
-@var{library} can also be a feature (i.e.@: a symbol), in which case
+@var{library} can also be a feature (i.e., a symbol), in which case
@var{form} is evaluated at the end of any file where
@code{(provide @var{library})} is called.
@section A Simple Example of a Macro
Suppose we would like to define a Lisp construct to increment a
-variable value, much like the @code{++} operator in C. We would like to
+variable value, much like the @code{++} operator in C@. We would like to
write @code{(inc x)} and have the effect of @code{(setq x (1+ x))}.
Here's a macro definition that does the job:
A sparse keymap used for the @kbd{M-o} prefix key.
@item function-key-map
-The parent keymap of all @code{local-function-key-map} (q.v.) instances.
+The parent keymap of all @code{local-function-key-map} (q.v.@:) instances.
@ignore
@c Doesn't exist.
@code{menu-bar-search-menu}, etc. @xref{Menu Bar}.
@ignore
TODO list all submenus?
-There are probably too many, and it would not be useful to do so, eg:
+There are probably too many, and it would not be useful to do so, e.g.:
The Edit menu includes @code{yank-menu}, @code{menu-bar-search-menu},
@code{menu-bar-replace-menu}, @code{menu-bar-goto-menu},
@code{menu-bar-bookmark-map}, and @code{facemenu-menu}.
There is also mule-menu-keymap, set-coding-system-map,
-setup-language-environment-map, describe-language-environment-map,
+setup-language-environment-map, describe-language-environment-map,
menu-bar-epatch-menu, menu-bar-ediff-merge-menu, menu-bar-ediff-menu, etc.
@end ignore
This function returns a list of all possible completions of
@var{string}. The arguments to this function
@c (aside from @var{nospace})
-are the same as those of @code{try-completion}, and it
+are the same as those of @code{try-completion}, and it
uses @code{completion-regexp-list} in the same way that
@code{try-completion} does.
@code{try-completion} (@pxref{Basic Completion}), and the @var{point}
argument is the position of point within @var{string}. Each function
should return a non-@code{nil} value if it performed its job, and
-@code{nil} if it did not (e.g.@: if there is no way to complete
+@code{nil} if it did not (e.g., if there is no way to complete
@var{string} according to the completion style).
When the user calls a completion command like
Apart from Fundamental mode, there are three major modes that other
major modes commonly derive from: Text mode, Prog mode, and Special
-mode. While Text mode is useful in its own right (e.g. for editing
+mode. While Text mode is useful in its own right (e.g., for editing
files ending in @file{.txt}), Prog mode and Special mode exist mainly to
let other modes derive from them.
As far as possible, new major modes should be derived, either directly
or indirectly, from one of these three modes. One reason is that this
allows users to customize a single mode hook
-(e.g. @code{prog-mode-hook}) for an entire family of relevant modes
-(e.g. all programming language modes).
+(e.g., @code{prog-mode-hook}) for an entire family of relevant modes
+(e.g., all programming language modes).
@deffn Command text-mode
Text mode is a major mode for editing human languages. It defines the
@cindex Tabulated List mode
Tabulated List mode is a major mode for displaying tabulated data,
-i.e.@: data consisting of @dfn{entries}, each entry occupying one row of
+i.e., data consisting of @dfn{entries}, each entry occupying one row of
text with its contents divided into columns. Tabulated List mode
provides facilities for pretty-printing rows and columns, and sorting
the rows according to the values in each column. It is derived from
line.
The derived mode should also define a @dfn{listing command}. This,
-not the mode command, is what the user calls (e.g.@: @kbd{M-x
+not the mode command, is what the user calls (e.g., @kbd{M-x
list-processes}). The listing command should create or switch to a
buffer, turn on the derived mode, specify the tabulated data, and
finally call @code{tabulated-list-print} to populate the buffer.
The mode command should accept one optional argument. If called
interactively with no prefix argument, it should toggle the mode
-(i.e.@: enable if it is disabled, and disable if it is enabled). If
+(i.e., enable if it is disabled, and disable if it is enabled). If
called interactively with a prefix argument, it should enable the mode
if the argument is positive and disable it otherwise.
-If the mode command is called from Lisp (i.e.@: non-interactively), it
+If the mode command is called from Lisp (i.e., non-interactively), it
should enable the mode if the argument is omitted or @code{nil}; it
should toggle the mode if the argument is the symbol @code{toggle};
otherwise it should treat the argument in the same way as for an
@item font-lock-comment-delimiter-face
@vindex font-lock-comment-delimiter-face
-for comments delimiters, like @samp{/*} and @samp{*/} in C. On most
+for comments delimiters, like @samp{/*} and @samp{*/} in C@. On most
terminals, this inherits from @code{font-lock-comment-face}.
@item font-lock-type-face
This variable is semi-obsolete; we usually recommend setting
@code{syntax-begin-function} instead. One of its uses is to tune the
-behavior of syntactic fontification, e.g.@: to ensure that different
+behavior of syntactic fontification, e.g., to ensure that different
kinds of strings or comments are highlighted differently.
The specified function is called with no arguments. It should leave
@item
A token can be an @code{opener} (something similar to an open-paren),
a @code{closer} (like a close-paren), or @code{neither} of the two
-(e.g. an infix operator, or an inner token like @code{"else"}).
+(e.g., an infix operator, or an inner token like @code{"else"}).
@end itemize
Precedence conflicts can be resolved via @var{resolvers}, which
restructure the grammar. Do not despair: while the parser cannot be
made more clever, you can make the lexer as smart as you want. So, the
solution is then to look at the tokens involved in the conflict and to
-split one of those tokens into 2 (or more) different tokens. E.g. if
+split one of those tokens into 2 (or more) different tokens. E.g., if
the grammar needs to distinguish between two incompatible uses of the
token @code{"begin"}, make the lexer return different tokens (say
@code{"begin-fun"} and @code{"begin-plain"}) depending on which kind of
By @emph{separator}, we mean here a token whose sole purpose is to
separate various elements within some enclosing syntactic construct, and
-which does not have any semantic significance in itself (i.e. it would
+which does not have any semantic significance in itself (i.e., it would
typically not exist as a node in an abstract syntax tree).
Such a token is expected to have an associative syntax and be closely
Here @var{desktop-buffer-misc} is the value returned by the function
optionally bound to @code{desktop-save-buffer}.
@end defvar
-
may be a symbol representing a compatibility formatting tag, such as
@code{small}@footnote{The Unicode specification writes these tag names
inside @samp{<..>} brackets, but the tag names in Emacs do not include
-the brackets; e.g.@: Unicode specifies @samp{<small>} where Emacs uses
+the brackets; e.g., Unicode specifies @samp{<small>} where Emacs uses
@samp{small}. }; the other elements are characters that give the
compatibility decomposition sequence of this character. For
unassigned codepoints, the value is the character itself.
Each element of @var{alist} is of the form @code{(@var{from}
. @var{to})}, where @var{from} and @var{to} are either characters or
vectors specifying a sequence of characters. If @var{from} is a
-character, that character is translated to @var{to} (i.e.@: to a
+character, that character is translated to @var{to} (i.e., to a
character or a character sequence). If @var{from} is a vector of
characters, that sequence is translated to @var{to}. The returned
table has a translation table for reverse mapping in the first extra
@defun detect-coding-region start end &optional highest
This function chooses a plausible coding system for decoding the text
from @var{start} to @var{end}. This text should be a byte sequence,
-i.e.@: unibyte text or multibyte text with only @acronym{ASCII} and
+i.e., unibyte text or multibyte text with only @acronym{ASCII} and
eight-bit characters (@pxref{Explicit Encoding}).
Normally this function returns a list of coding systems that could
infinity and negative infinity as floating point values. It also
provides for a class of values called NaN or ``not-a-number'';
numerical functions return such values in cases where there is no
-correct answer. For example, @code{(/ 0.0 0.0)} returns a NaN. (NaN
+correct answer. For example, @code{(/ 0.0 0.0)} returns a NaN@. (NaN
values can also carry a sign, but for practical purposes there's no
significant difference between different NaN values in Emacs Lisp.)
If @var{limit} is a positive integer, the value is chosen to be
nonnegative and less than @var{limit}. Otherwise, the value might be
-any integer representable in Lisp, i.e.@: an integer between
+any integer representable in Lisp, i.e., an integer between
@code{most-negative-fixnum} and @code{most-positive-fixnum}
(@pxref{Integer Basics}).
characters in Emacs strings: multibyte and unibyte (@pxref{Text
Representations}). Roughly speaking, unibyte strings store raw bytes,
while multibyte strings store human-readable text. Each character in
-a unibyte string is a byte, i.e.@: its value is between 0 and 255. By
+a unibyte string is a byte, i.e., its value is between 0 and 255. By
contrast, each character in a multibyte string may have a value
between 0 to 4194303 (@pxref{Character Type}). In both cases,
characters above 127 are non-@acronym{ASCII}.
octal escape sequences (@samp{\@var{n}}) in string constants.
@strong{But beware:} If a string constant contains hexadecimal or
octal escape sequences, and these escape sequences all specify unibyte
-characters (i.e.@: less than 256), and there are no other literal
+characters (i.e., less than 256), and there are no other literal
non-@acronym{ASCII} characters or Unicode-style escape sequences in
the string, then Emacs automatically assumes that it is a unibyte
string. That is to say, it assumes that all non-@acronym{ASCII}
redefinition of primitive functions}.
The term @dfn{function} refers to all Emacs functions, whether written
-in Lisp or C. @xref{Function Type}, for information about the
+in Lisp or C@. @xref{Function Type}, for information about the
functions written in Lisp.
Primitive functions have no read syntax and print in hash notation
Here we describe functions that test for equality between two
objects. Other functions test equality of contents between objects of
-specific types, e.g.@: strings. For these predicates, see the
+specific types, e.g., strings. For these predicates, see the
appropriate chapter describing the data type.
@defun eq object1 object2
the same object, and @code{nil} otherwise.
If @var{object1} and @var{object2} are integers with the same value,
-they are considered to be the same object (i.e.@: @code{eq} returns
+they are considered to be the same object (i.e., @code{eq} returns
@code{t}). If @var{object1} and @var{object2} are symbols with the
same name, they are normally the same object---but see @ref{Creating
-Symbols} for exceptions. For other types (e.g.@: lists, vectors,
+Symbols} for exceptions. For other types (e.g., lists, vectors,
strings), two arguments with the same contents or elements are not
necessarily @code{eq} to each other: they are @code{eq} only if they
are the same object, meaning that a change in the contents of one will
from the terminal's name the last hyphen or underscore and everything that follows
it, and tries again. This process is repeated until Emacs finds a
matching library, or until there are no more hyphens or underscores in the name
-(i.e.@: there is no terminal-specific library). For example, if the
+(i.e., there is no terminal-specific library). For example, if the
terminal name is @samp{xterm-256color} and there is no
@file{term/xterm-256color.el} library, Emacs tries to load
@file{term/xterm.el}. If necessary, the terminal library can evaluate
higher-level command @kbd{C-x C-c}
(@code{save-buffers-kill-terminal}). @xref{Exiting,,, emacs, The GNU
Emacs Manual}. It is also called automatically if Emacs receives a
-@code{SIGTERM} or @code{SIGHUP} operating system signal (e.g. when the
+@code{SIGTERM} or @code{SIGHUP} operating system signal (e.g., when the
controlling terminal is disconnected), or if it receives a
@code{SIGINT} signal while running in batch mode (@pxref{Batch Mode}).
This normal hook is run by @code{kill-emacs}, before it kills Emacs.
Because @code{kill-emacs} can be called in situations where user
-interaction is impossible (e.g. when the terminal is disconnected),
+interaction is impossible (e.g., when the terminal is disconnected),
functions on this hook should not attempt to interact with the user.
If you want to interact with the user when Emacs is shutting down, use
@code{kill-emacs-query-functions}, described below.
Silicon Graphics Irix system.
@item ms-dos
-Microsoft's DOS. Emacs compiled with DJGPP for MS-DOS binds
+Microsoft's DOS@. Emacs compiled with DJGPP for MS-DOS binds
@code{system-type} to @code{ms-dos} even when you run it on MS-Windows.
@item usg-unix-v
@item windows-nt
Microsoft Windows NT, 9X and later. The value of @code{system-type}
-is always @code{windows-nt}, e.g. even on Windows 7.
+is always @code{windows-nt}, e.g., even on Windows 7.
@end table
is absolutely necessary! In fact, we hope to eliminate some of these
alternatives in the future. If you need to make a finer distinction
than @code{system-type} allows for, you can test
-@code{system-configuration}, e.g. against a regexp.
+@code{system-configuration}, e.g., against a regexp.
@end defvar
@defun system-name
The return value of @code{current-time} represents time using four
integers, as do the timestamps in the return value of
@code{file-attributes} (@pxref{Definition of
-file-attributes}). In function arguments, e.g.@: the @var{time-value}
+file-attributes}). In function arguments, e.g., the @var{time-value}
argument to @code{current-time-string}, two-, three-, and four-integer
lists are accepted. You can convert times from the list
representation into standard human-readable strings using
Many 32-bit operating systems are limited to time values containing
32 bits of information; these systems typically handle only the times
-from 1901-12-13 20:45:52 UTC through 2038-01-19 03:14:07 UTC.
+from 1901-12-13 20:45:52 UTC through 2038-01-19 03:14:07 UTC@.
However, 64-bit and some 32-bit operating systems have larger time
values, and can represent times far in the past or future.
The integer number of seconds.
@item %z
Non-printing control flag. When it is used, other specifiers must be
-given in the order of decreasing size, i.e.@: years before days, hours
+given in the order of decreasing size, i.e., years before days, hours
before minutes, etc. Nothing will be produced in the result string to
the left of @samp{%z} until the first non-zero conversion is
encountered. For example, the default format used by
@table @asis
@item Name
-A short word (e.g. @samp{auctex}). This is usually also the symbol
+A short word (e.g., @samp{auctex}). This is usually also the symbol
prefix used in the program (@pxref{Coding Conventions}).
@item Version
A version number, in a form that the function @code{version-to-list}
-understands (e.g. @samp{11.86}). Each release of a package should be
+understands (e.g., @samp{11.86}). Each release of a package should be
accompanied by an increase in the version number.
@item Brief description
or via the Package Menu, creates a subdirectory of
@code{package-user-dir} named @file{@var{name}-@var{version}}, where
@var{name} is the package's name and @var{version} its version
-(e.g. @file{~/.emacs.d/elpa/auctex-11.86/}). We call this the
+(e.g., @file{~/.emacs.d/elpa/auctex-11.86/}). We call this the
package's @dfn{content directory}. It is where Emacs puts the
package's contents (the single Lisp file for a simple package, or the
files extracted from a multi-file package).
Thus, @code{"a-zA-Z"} skips over all letters, stopping before the
first nonletter, and @code{"^a-zA-Z"} skips nonletters stopping before
the first letter. See @xref{Regular Expressions}. Character classes
-can also be used, e.g. @code{"[:alnum:]"}. See @pxref{Char Classes}.
+can also be used, e.g., @code{"[:alnum:]"}. See @pxref{Char Classes}.
If @var{limit} is supplied (it must be a number or a marker), it
specifies the maximum position in the buffer that point can be skipped
@code{call-process}, above. If @var{destination} is the integer 0,
@code{call-process-region} discards the output and returns @code{nil}
immediately, without waiting for the subprocess to finish (this only
-works if asynchronous subprocesses are supported; i.e. not on MS-DOS).
+works if asynchronous subprocesses are supported; i.e., not on MS-DOS).
The remaining arguments, @var{args}, are strings that specify command
line arguments for the program.
possible to apply @code{process-filter} or @code{process-sentinel} to
the resulting process object. @xref{Filter Functions}, and @ref{Sentinels}.
-@c FIXME Can we find a better example (i.e. a more modern function
+@c FIXME Can we find a better example (i.e., a more modern function
@c that is actually documented).
Some file handlers may not support @code{start-file-process} (for
example the function @code{ange-ftp-hook-function}). In such cases,
@defun quit-process &optional process current-group
This function sends the signal @code{SIGQUIT} to the process
@var{process}. This signal is the one sent by the ``quit
-@c FIXME? Never heard of C-b being used for this. In readline, eg
+@c FIXME? Never heard of C-b being used for this. In readline, e.g.,
@c bash, that is backward-word.
character'' (usually @kbd{C-b} or @kbd{C-\}) when you are not inside
Emacs.
matches upper-case letters. Note that a range like @samp{[a-z]} is
not affected by the locale's collation sequence, it always represents
a sequence in @acronym{ASCII} order.
-@c This wasn't obvious to me, since eg the grep manual "Character
+@c This wasn't obvious to me, since, e.g., the grep manual "Character
@c Classes and Bracket Expressions" specifically notes the opposite
@c behavior. But by experiment Emacs seems unaffected by LC_COLLATE
@c in this regard.
their number implicitly, based on their position, which can be
inconvenient. This construct allows you to force a particular group
number. There is no particular restriction on the numbering,
-e.g.@: you can have several groups with the same number in which case
-the last one to match (i.e.@: the rightmost match) will win.
+e.g., you can have several groups with the same number in which case
+the last one to match (i.e., the rightmost match) will win.
Implicitly numbered groups always get the smallest integer larger than
the one of any previous group.
guarantee that its result is absolutely the most efficient form
possible. A hand-tuned regular expression can sometimes be slightly
more efficient, but is almost never worth the effort.}.
-@c See eg http://debbugs.gnu.org/2816
+@c E.g., see http://debbugs.gnu.org/2816
If the optional argument @var{paren} is non-@code{nil}, then the
returned regular expression is always enclosed by at least one
full backtracking specified by the POSIX standard for regular expression
matching. They continue backtracking until they have tried all
possibilities and found all matches, so they can report the longest
-match, as required by POSIX. This is much slower, so use these
+match, as required by POSIX@. This is much slower, so use these
functions only when you really need the longest match.
The POSIX search and match functions do not properly support the
may save and restore the match data (@pxref{Saving Match Data}) around
the call to functions that could perform another search. Or use the
functions that explicitly do not modify the match data;
-e.g. @code{string-match-p}.
+e.g., @code{string-match-p}.
@c This is an old comment and presumably there is no prospect of this
@c changing now. But still the advice stands.
@defvar print-quoted
If this is non-@code{nil}, that means to print quoted forms using
-abbreviated reader syntax, e.g.@: @code{(quote foo)} prints as
+abbreviated reader syntax, e.g., @code{(quote foo)} prints as
@code{'foo}, and @code{(function foo)} as @code{#'foo}.
@end defvar
@xref{Macros}.
As previously noted, Emacs Lisp allows the same symbol to be defined
-both as a variable (e.g.@: with @code{defvar}) and as a function or
-macro (e.g.@: with @code{defun}). Such definitions do not conflict.
+both as a variable (e.g., with @code{defvar}) and as a function or
+macro (e.g., with @code{defun}). Such definitions do not conflict.
These definition also act as guides for programming tools. For
example, the @kbd{C-h f} and @kbd{C-h v} commands create help buffers
The first character in a syntax descriptor must be a syntax class
designator character. The second character, if present, specifies a
-matching character (e.g.@: in Lisp, the matching character for
+matching character (e.g., in Lisp, the matching character for
@samp{(} is @samp{)}); a space specifies that there is no matching
character. Then come characters specifying additional syntax
properties (@pxref{Syntax Flags}).
otherwise, the parent is the standard syntax table.
In the new syntax table, all characters are initially given the
-``inherit'' (@samp{@@}) syntax class, i.e.@: their syntax is inherited
+``inherit'' (@samp{@@}) syntax class, i.e., their syntax is inherited
from the parent table (@pxref{Syntax Class Table}).
@end defun
The syntax is changed only for @var{table}, which defaults to the
current buffer's syntax table, and not in any other syntax table.
-The argument @var{syntax-descriptor} is a syntax descriptor, i.e.@: a
+The argument @var{syntax-descriptor} is a syntax descriptor, i.e., a
string whose first character is a syntax class designator and whose
second and subsequent characters optionally specify a matching
character and syntax flags. @xref{Syntax Descriptors}. An error is
expressions. We will refer to such expressions as @dfn{sexps},
following the terminology of Lisp, even though these functions can act
on languages other than Lisp. Basically, a sexp is either a balanced
-parenthetical grouping, a string, or a ``symbol'' (i.e.@: a sequence
+parenthetical grouping, a string, or a ``symbol'' (i.e., a sequence
of characters whose syntax is either word constituent or symbol
constituent). However, characters in the expression prefix syntax
class (@pxref{Syntax Class Table}) are treated as part of the sexp if
@code{filter-buffer-substring-functions}, and returns the result. The
obsolete variable @code{buffer-substring-filters} is also consulted.
If both of these variables are @code{nil}, the value is the unaltered
-text from the buffer, i.e.@: what @code{buffer-substring} would
+text from the buffer, i.e., what @code{buffer-substring} would
return.
If @var{delete} is non-@code{nil}, this function deletes the text
@code{filter-buffer-substring}.
The first hook function is passed a @var{fun} that is equivalent to
-the default operation of @code{filter-buffer-substring}, i.e. it
+the default operation of @code{filter-buffer-substring}, i.e., it
returns the buffer-substring between @var{start} and @var{end}
(processed by any @code{buffer-substring-filters}) and optionally
deletes the original text from the buffer. In most cases, the hook
A list of faces. This specifies a face which is an aggregate of the
attributes of each of the listed faces. Faces occurring earlier in
the list have higher priority. Each list element must have one of the
-two above forms (i.e.@: either a face name or a property list of face
+two above forms (i.e., either a face name or a property list of face
attributes).
@end itemize
@code{mouse-face} property value.
Emacs ignores all face attributes from the @code{mouse-face} property
-that alter the text size (e.g. @code{:height}, @code{:weight}, and
+that alter the text size (e.g., @code{:height}, @code{:weight}, and
@code{:slant}). Those attributes are always the same as for the
unhighlighted text.
@deffn Command base64-encode-region beg end &optional no-line-break
This function converts the region from @var{beg} to @var{end} into base
64 code. It returns the length of the encoded text. An error is
-signaled if a character in the region is multibyte, i.e.@: in a
+signaled if a character in the region is multibyte, i.e., in a
multibyte buffer the region must contain only characters from the
charsets @code{ascii}, @code{eight-bit-control} and
@code{eight-bit-graphic}.
Emacs has built-in support for computing @dfn{cryptographic hashes}.
A cryptographic hash, or @dfn{checksum}, is a digital ``fingerprint''
-of a piece of data (e.g.@: a block of text) which can be used to check
+of a piece of data (e.g., a block of text) which can be used to check
that you have an unaltered copy of that data.
@cindex message digest
SHA-1, SHA-2, SHA-224, SHA-256, SHA-384 and SHA-512. MD5 is the
oldest of these algorithms, and is commonly used in @dfn{message
digests} to check the integrity of messages transmitted over a
-network. MD5 is not ``collision resistant'' (i.e.@: it is possible to
+network. MD5 is not ``collision resistant'' (i.e., it is possible to
deliberately design different pieces of data which have the same MD5
hash), so you should not used it for anything security-related. A
similar theoretical weakness also exists in SHA-1. Therefore, for
@item
For consistency, phrase the verb in the first sentence of a function's
documentation string as an imperative---for instance, use ``Return the
-cons of A and B.'' in preference to ``Returns the cons of A and B@.''
+cons of A and B.@:'' in preference to ``Returns the cons of A and B@.''
Usually it looks good to do likewise for the rest of the first
paragraph. Subsequent paragraphs usually look better if each sentence
is indicative and has a proper subject.
@item
Write documentation strings in the active voice, not the passive, and in
the present tense, not the future. For instance, use ``Return a list
-containing A and B.'' instead of ``A list containing A and B will be
+containing A and B.@:'' instead of ``A list containing A and B will be
returned.''
@item
of one) comes back.
@cindex current binding
- A variable can have more than one local binding at a time (e.g.@: if
+ A variable can have more than one local binding at a time (e.g., if
there are nested @code{let} forms that bind the variable). The
@dfn{current binding} is the local binding that is actually in effect.
It determines the value returned by evaluating the variable symbol,
@code{void-variable} error rather than a value.
Under lexical binding rules, the value cell only holds the
-variable's global value, i.e.@: the value outside of any lexical
+variable's global value, i.e., the value outside of any lexical
binding construct. When a variable is lexically bound, the local value
is determined by the lexical environment; the variable may have a
local value if its symbol's value cell is unassigned.
If @var{symbol} is void and @var{value} is specified, @code{defvar}
evaluates @var{value} and sets @var{symbol} to the result. But if
-@var{symbol} already has a value (i.e.@: it is not void), @var{value}
+@var{symbol} already has a value (i.e., it is not void), @var{value}
is not even evaluated, and @var{symbol}'s value remains unchanged. If
@var{value} is omitted, the value of @var{symbol} is not changed in
any case.
reference, in the sense that there is no binding for @code{x} within
that @code{defun} construct itself. When we call @code{getx} from
within a @code{let} form in which @code{x} is (dynamically) bound, it
-retrieves the local value of @code{x} (i.e.@: 1). But when we call
+retrieves the local value of @code{x} (i.e., 1). But when we call
@code{getx} outside the @code{let} form, it retrieves the global value
-of @code{x} (i.e.@: -99).
+of @code{x} (i.e., -99).
Here is another example, which illustrates setting a dynamically
bound variable using @code{setq}:
@itemize @bullet
@item
If a variable has no global definition, use it as a local variable
-only within a binding construct, e.g.@: the body of the @code{let}
+only within a binding construct, e.g., the body of the @code{let}
form where the variable was bound, or the body of the function for an
argument variable. If this convention is followed consistently
throughout a program, the value of the variable will not affect, nor
Then you can bind the variable anywhere in a program, knowing reliably
what the effect will be. Wherever you encounter the variable, it will
-be easy to refer back to the definition, e.g.@: via the @kbd{C-h v}
+be easy to refer back to the definition, e.g., via the @kbd{C-h v}
command (provided the variable definition has been loaded into Emacs).
@xref{Name Help,,, emacs, The GNU Emacs Manual}.
Note that functions like @code{symbol-value}, @code{boundp}, and
@code{set} only retrieve or modify a variable's dynamic binding
-(i.e.@: the contents of its symbol's value cell). Also, the code in
+(i.e., the contents of its symbol's value cell). Also, the code in
the body of a @code{defun} or @code{defmacro} cannot refer to
surrounding lexical variables.
@defun special-variable-p SYMBOL
This function returns non-@code{nil} if @var{symbol} is a special
-variable (i.e.@: it has a @code{defvar}, @code{defcustom}, or
+variable (i.e., it has a @code{defvar}, @code{defcustom}, or
@code{defconst} variable definition). Otherwise, the return value is
@code{nil}.
@end defun
Ordinary Lisp variables can be assigned any value that is a valid
Lisp object. However, certain Lisp variables are not defined in Lisp,
-but in C. Most of these variables are defined in the C code using
+but in C@. Most of these variables are defined in the C code using
@code{DEFVAR_LISP}. Like variables defined in Lisp, these can take on
any value. However, some variables are defined using
@code{DEFVAR_INT} or @code{DEFVAR_BOOL}. @xref{Defining Lisp
caar get symbol-value
cadr gethash
cdr nth
-cdar nthcdr
+cdar nthcdr
@end smallexample
@item
@cindex valid windows
A @dfn{valid window} is one that is either live or internal. A valid
-window can be @dfn{deleted}, i.e. removed from its frame
+window can be @dfn{deleted}, i.e., removed from its frame
(@pxref{Deleting Windows}); then it is no longer valid, but the Lisp
object representing it might be still referenced from other Lisp
objects. A deleted window may be made valid again by restoring a saved
This function returns the parent window of @var{window}. If
@var{window} is omitted or @code{nil}, it defaults to the selected
window. The return value is @code{nil} if @var{window} has no parent
-(i.e. it is a minibuffer window or the root window of its frame).
+(i.e., it is a minibuffer window or the root window of its frame).
@end defun
Each internal window always has at least two child windows. If this
@defun window-full-height-p &optional window
This function returns non-@code{nil} if @var{window} has no other
-window above or below it in its frame, i.e. its total height equals
+window above or below it in its frame, i.e., its total height equals
the total height of the root window on that frame. If @var{window} is
omitted or @code{nil}, it defaults to the selected window.
@end defun
@defun window-full-width-p &optional window
This function returns non-@code{nil} if @var{window} has no other
-window to the left or right in its frame, i.e. its total width equals
+window to the left or right in its frame, i.e., its total width equals
that of the root window on that frame. If @var{window} is omitted or
@code{nil}, it defaults to the selected window.
@end defun
moves it as far as possible but does not signal a error.
This function tries to resize windows adjacent to the edge that is
-moved. If this is not possible for some reason (e.g. if that adjacent
+moved. If this is not possible for some reason (e.g., if that adjacent
window is fixed-size), it may resize other windows.
@end defun
This function removes @var{window} from display and returns
@code{nil}. If @var{window} is omitted or @code{nil}, it defaults to
the selected window. If deleting the window would leave no more
-windows in the window tree (e.g. if it is the only live window in the
+windows in the window tree (e.g., if it is the only live window in the
frame), an error is signaled.
By default, the space taken up by @var{window} is given to one of its
@defvar display-buffer-overriding-action
The value of this variable should be a display action, which is
treated with the highest priority by @code{display-buffer}. The
-default value is empty, i.e. @code{(nil . nil)}.
+default value is empty, i.e., @code{(nil . nil)}.
@end defvar
@defopt display-buffer-alist
@end itemize
This function can fail if no window splitting can be performed for some
-reason (e.g. if the selected frame has an @code{unsplittable} frame
+reason (e.g., if the selected frame has an @code{unsplittable} frame
parameter; @pxref{Buffer Parameters}).
@end defun
the horizontal scrolling of a window as necessary to ensure that point
is always visible. However, you can still set the horizontal
scrolling value explicitly. The value you specify serves as a lower
-bound for automatic scrolling, i.e. automatic scrolling will not
+bound for automatic scrolling, i.e., automatic scrolling will not
scroll a window to a column less than the specified one.
@deffn Command scroll-left &optional count set-minimum
Y coordinates increase rightward and downward respectively.
Except where noted, X and Y coordinates are reported in integer
-character units, i.e. numbers of lines and columns respectively. On a
+character units, i.e., numbers of lines and columns respectively. On a
graphical display, each ``line'' and ``column'' corresponds to the
height and width of a default character specified by the frame's
default font.
Similarly, the auth-source library supports multiple storage backend,
currently either the classic ``netrc'' backend, examples of which you
-can see later in this document, or the Secret Service API. This is
+can see later in this document, or the Secret Service API@. This is
done with EIEIO-based backends and you can write your own if you want.
@node Help for users
@end example
This will match any realm and authentication method (basic or digest)
-over HTTP. HTTPS is set up similarly. If you want finer controls,
+over HTTP@. HTTPS is set up similarly. If you want finer controls,
explore the url-auth source code and variables.
For Tramp authentication, use:
be available on most modern GNU/Linux systems).
The auth-source library uses the @file{secrets.el} library to connect
-through the Secret Service API. You can also use that library in
+through the Secret Service API@. You can also use that library in
other packages, it's not exclusive to auth-source.
@defvar secrets-enabled
or @kbd{C-h}. This
means that entering an empty string will simply assume that you are finished.
Typing quit on the other hand terminates the loop but also the rest of the
-skeleton, e.g. an ``else'' clause is skipped. Only a syntactically necessary
+skeleton, e.g., an ``else'' clause is skipped. Only a syntactically necessary
termination still gets inserted.
Skeleton commands take an optional numeric prefix argument
(@pxref{(emacs)Arguments}). This is interpreted in two different ways depending
-on whether the prefix is positive, i.e. forwards oriented or negative,
-i.e. backwards oriented.
+on whether the prefix is positive, i.e., forwards oriented, or negative,
+i.e., backwards oriented.
A positive prefix means to wrap the skeleton around that many
following words. This is accomplished by putting the words there where
If, on the other hand, you marked in alphabetical order the points [] A C B,
and call a skeleton command with @kbd{M-- 3}, you will wrap the text from
-point to A, then the text from A to C and finally the text from C to B. This
+point to A, then the text from A to C and finally the text from C to B@. This
is done because the regions overlap and Emacs would be helplessly lost if it
tried to follow the order in which you marked these points.
Indent line according to major mode. When following element is @code{_}, and
there is a interregion that will be wrapped here, indent that interregion.
@item @code{&}
-Logical and. Iff preceding element moved point, i.e. usually inserted
+Logical and. Iff preceding element moved point, i.e., usually inserted
something, do following element.
@item @code{|}
-Logical xor. Iff preceding element didn't move point, i.e. usually inserted
+Logical xor. Iff preceding element didn't move point, i.e., usually inserted
nothing, do following element.
@item @code{-@var{number}}
Delete preceding number characters. Depends on value of
can simply insert some text, indeed, it can be skeleton command (@pxref{Using
Skeletons}). It can be a lambda function which will for example conditionally
call another function. Or it can even reset the mode for the buffer. If you
-want to perform several such actions in order, you use a vector, i.e. several
+want to perform several such actions in order, you use a vector, i.e., several
of the above elements between square brackets (@samp{[@r{@dots{}}]}).
By default C and C++ headers insert a definition of a symbol derived from
@vindex auto-insert
The variable @code{auto-insert} says what to do when @code{auto-insert} is
-called non-interactively, e.g. when a newly found file is empty (see above):
+called non-interactively, e.g., when a newly found file is empty (see above):
@table @asis
@item @code{nil}
Do nothing.
@item @code{t}
-Insert something if possible, i.e. there is a matching entry in
+Insert something if possible, i.e., there is a matching entry in
@code{auto-insert-alist}.
@item other
Insert something if possible, but mark as unmodified.
@kbd{M-x copyright-update} looks for a copyright notice in the first
@code{copyright-limit} characters of the buffer and updates it when necessary.
The current year (variable @code{copyright-current-year}) is added to the
-existing ones, in the same format as the preceding year, i.e. 1994, '94 or 94.
+existing ones, in the same format as the preceding year, i.e., 1994, '94 or 94.
If a dash-separated year list up to last year is found, that is extended to
current year, else the year is added separated by a comma. Or it replaces
them when this is called with a prefix argument. If a header referring to a
@vindex executable-insert
The variable @code{executable-insert} says what to do when
-@code{executable-set-magic} is called non-interactively, e.g. when file has no
+@code{executable-set-magic} is called non-interactively, e.g., when file has no
or the wrong magic number:
@table @asis
@item @code{nil}
this manual ought to be readable even if you don't know or use Emacs
regularly.
-This manual is divided into three major parts:@: the ``Getting
+This manual is divided into three major parts: the ``Getting
Started'' chapter you are reading now, the Calc tutorial, and the Calc
reference manual.
@c [when-split]
fair to give the user direct access to it, which in turn made it
practical to support fractions as well as floats. All these features
inspired me to look around for other data types that might be worth
-having.
+having.
Around this time, my friend Rick Koshi showed me his nifty new HP-28
calculator. It allowed the user to manipulate formulas as well as
rearranged. (This one is rather tricky; the solution at the end of
this chapter uses 6 rewrite rules. Hint: The @samp{constant(x)}
condition tests whether @samp{x} is a number.) @xref{Rewrites Answer
-6, 6}. (@bullet{})
+6, 6}. (@bullet{})
Just for kicks, try adding the rule @code{2+3 := 6} to @code{EvalRules}.
What happens? (Be sure to remove this rule afterward, or you might get
@smallexample
@group
___
-1: V 2
+1: V 2
.
a r a*(b+c) := a*b + a*c
numbers. HMS forms also for many purposes act as real numbers. These
types can be combined to form complex numbers, modulo forms, error forms,
or interval forms. (But these last four types cannot be combined
-arbitrarily:@: error forms may not contain modulo forms, for example.)
+arbitrarily: error forms may not contain modulo forms, for example.)
Finally, all these types of numbers may be combined into vectors,
matrices, or algebraic formulas.
of a date form. @xref{Packing and Unpacking}.
Date forms can go arbitrarily far into the future or past. Negative
-year numbers represent years BC. Calc uses a combination of the
+year numbers represent years BC@. Calc uses a combination of the
Gregorian and Julian calendars, following the history of Great
Britain and the British colonies. This is the same calendar that
is used by the @code{cal} program in most Unix implementations.
drift caused by the lack of leap years in the calendar used
until that time. The Julian calendar introduced an extra day in
all years divisible by four. After some initial confusion, the
-calendar was adopted around the year we call 8 AD. Some centuries
+calendar was adopted around the year we call 8 AD@. Some centuries
later it became apparent that the Julian year of 365.25 days was
itself not quite right. In 1582 Pope Gregory XIII introduced the
Gregorian calendar, which added the new rule that years divisible
A common technique is to set the simplification mode down to the lowest
amount of simplification you will allow to be applied automatically, then
use manual commands like @kbd{a s} and @kbd{c c} (@code{calc-clean}) to
-perform higher types of simplifications on demand.
+perform higher types of simplifications on demand.
@node Declarations, Display Modes, Simplification Modes, Mode Settings
@section Declarations
function checks for nonnegative reals, i.e., reals greater than or
equal to zero. Note that Calc's algebraic simplifications, which are
effectively applied to all conditions in rewrite rules, can simplify
-an expression like @expr{x > 0} to 1 or 0 using @code{dpos}.
+an expression like @expr{x > 0} to 1 or 0 using @code{dpos}.
So the actual functions @code{dpos}, @code{dneg}, and @code{dnonneg}
are rarely necessary.
match exactly; letter fields must correspond to suitable text in
the input. If this doesn't work, Calc checks if the input is a
simple number; if so, the number is interpreted as a number of days
-since Jan 1, 1 AD. Otherwise, Calc tries a much more relaxed and
+since Jan 1, 1 AD@. Otherwise, Calc tries a much more relaxed and
flexible algorithm which is described in the next section.
Weekday names are ignored during reading.
@item AAA
Year: ``AD '' or blank.
@item aaaa
-Year: ``a.d.'' or blank.
+Year: ``a.d.@:'' or blank.
@item AAAA
Year: ``A.D.'' or blank.
@item bb
@item BBB
Year: `` BC'' or blank.
@item bbbb
-Year: ``b.c.'' or blank.
+Year: ``b.c.@:'' or blank.
@item BBBB
Year: ``B.C.'' or blank.
@item M
@item PP
AM/PM: ``AM'' or ``PM''.
@item pppp
-AM/PM: ``a.m.'' or ``p.m.''.
+AM/PM: ``a.m.@:'' or ``p.m.''.
@item PPPP
AM/PM: ``A.M.'' or ``P.M.''.
@item m
The @kbd{d W} (@code{calc-maple-language}) command selects the
conventions of Maple.
-Maple's language is much like C. Underscores are allowed in symbol
+Maple's language is much like C@. Underscores are allowed in symbol
names; square brackets are used for subscripts; explicit @samp{*}s for
multiplications are required. Use either @samp{^} or @samp{**} to
denote powers.
If the simplification mode is set below basic simplification, it is raised
for the purposes of this command. Thus, @kbd{c c} applies the basic
simplifications even if their automatic application is disabled.
-@xref{Simplification Modes}.
+@xref{Simplification Modes}.
@cindex Roundoff errors, correcting
A numeric prefix argument to @kbd{c c} sets the floating-point precision
@pindex calc-date
@tindex date
The @kbd{t D} (@code{calc-date}) [@code{date}] command converts a
-date form into a number, measured in days since Jan 1, 1 AD. The
+date form into a number, measured in days since Jan 1, 1 AD@. The
result will be an integer if @var{date} is a pure date form, or a
fraction or float if @var{date} is a date/time form. Or, if its
argument is a number, it converts this number into a date form.
@cindex Julian day counts, conversions
The @kbd{t J} (@code{calc-julian}) [@code{julian}] command converts
a date form into a Julian day count, which is the number of days
-since noon (GMT) on Jan 1, 4713 BC. A pure date is converted to an
+since noon (GMT) on Jan 1, 4713 BC@. A pure date is converted to an
integer Julian count representing noon of that day. A date/time form
is converted to an exact floating-point Julian count, adjusted to
interpret the date form in the current time zone but the Julian
exercise for the reader is to modify this formula to yield the same day
if the input is already a Wednesday. Another interesting exercise is
to preserve the time-of-day portion of the input (@code{newweek} resets
-the time to midnight; hint:@: how can @code{newweek} be defined in terms
+the time to midnight; hint: how can @code{newweek} be defined in terms
of the @code{weekday} function?).
@ignore
ten, however, the numbers should be completely unbiased.
The Gaussian random numbers generated by @samp{random(0.0)} use the
-``polar'' method described in Knuth section 3.4.1C. This method
+``polar'' method described in Knuth section 3.4.1C@. This method
generates a pair of Gaussian random numbers at a time, so only every
other call to @samp{random(0.0)} will require significant calculations.
If you give a numeric prefix argument of 2 to @kbd{a v}, it simplifies
using Calc's algebraic simplifications; @pxref{Simplifying Formulas}.
If you give a numeric prefix of 3 or more, it uses Extended
-Simplification mode (@kbd{a e}).
+Simplification mode (@kbd{a e}).
If you give a negative prefix argument @mathit{-1}, @mathit{-2}, or @mathit{-3},
it simplifies in the corresponding mode but only works on the top-level
are mapped, the direction of the second inequality is reversed to
match the first: Using @kbd{a M +} on @samp{a < b} and @samp{a > 2}
reverses the latter to get @samp{2 < a}, which then allows the
-combination @samp{a + 2 < b + a}, which the algebraic simplifications
+combination @samp{a + 2 < b + a}, which the algebraic simplifications
can reduce to @samp{2 < b}.
Using @kbd{a M *}, @kbd{a M /}, @kbd{a M n}, or @kbd{a M &} to negate
@kbd{Q} [@code{sqrt}], the arguments are simply popped from the stack
and collected into a suitable function call, which is then simplified
(the arguments being simplified first as part of the process, as
-described above).
+described above).
Even the basic set of simplifications are too numerous to describe
completely here, but this section will describe the ones that apply to the
mode. If you have switched to a different simplification mode, you can
switch back with the @kbd{m A} command. Even in other simplification
modes, the @kbd{a s} command will use these algebraic simplifications to
-simplify the formula.
+simplify the formula.
There is a variable, @code{AlgSimpRules}, in which you can put rewrites
to be applied. Its use is analogous to @code{EvalRules},
simplifications will not change @expr{x y + y x} to @expr{2 x y},
but the algebraic simplifications; it first rewrites the sum to
@expr{x y + x y} which can then be recognized as a sum of identical
-terms.
+terms.
The canonical ordering used to sort terms of products has the
property that real-valued numbers, interval forms and infinities
for example, @expr{(4 x + 6) / 8 x} simplifies to @expr{(2 x + 3) / 4 x}.
Non-constant common factors are not found even by algebraic
-simplifications. To cancel the factor @expr{a} in
+simplifications. To cancel the factor @expr{a} in
@expr{(a x + a) / a^2} you could first use @kbd{j M} on the product
@expr{a x} to Merge the numerator to @expr{a (1+x)}, which can then be
-simplified successfully.
+simplified successfully.
@tex
\bigskip
@tindex esimplify
Calc is capable of performing some simplifications which may sometimes
be desired but which are not ``safe'' in all cases. The @kbd{a e}
-(@code{calc-simplify-extended}) [@code{esimplify}] command
+(@code{calc-simplify-extended}) [@code{esimplify}] command
applies the algebraic simplifications as well as these extended, or
``unsafe'', simplifications. Use this only if you know the values in
your formula lie in the restricted ranges for which these
@vindex IntegSimpRules
Another set of rules, stored in @code{IntegSimpRules}, are applied
every time the integrator uses algebraic simplifications to simplify an
-intermediate result. For example, putting the rule
+intermediate result. For example, putting the rule
@samp{twice(x) := 2 x} into @code{IntegSimpRules} would tell Calc to
convert the @code{twice} function into a form it knows whenever
-integration is attempted.
+integration is attempted.
One more way to influence the integrator is to define a function with
the @kbd{Z F} command (@pxref{Algebraic Definitions}). Calc's
been matched to something else the two values must be equal; if the
meta-variable is new then it is bound to the result of the expression.
This variable can then appear in later conditions, and on the righthand
-side of the rule.
+side of the rule.
In fact, @expr{v} may be any pattern in which case the result of
evaluating @expr{x} is matched to that pattern, binding any
meta-variables that appear in that pattern. Note that @code{let}
formula. The variable @code{AlgSimpRules} holds rules for this purpose.
The @kbd{a s} command will apply @code{EvalRules} and
@code{AlgSimpRules} to the formula, as well as all of its built-in
-simplifications.
+simplifications.
Most of the special limitations for @code{EvalRules} don't apply to
@code{AlgSimpRules}. Calc simply does an @kbd{a r AlgSimpRules}
simplifications. It then applies its own built-in simplifications
throughout the formula, and then repeats these two steps (along with
applying the default simplifications) until no further changes are
-possible.
+possible.
@cindex @code{ExtSimpRules} variable
@cindex @code{UnitSimpRules} variable
All current modes apply when an @samp{=>} operator is computed,
including the current simplification mode. Recall that the
formula @samp{arcsin(sin(x))} will not be handled by Calc's algebraic
-simplifications, but Calc's unsafe simplifications will reduce it to
+simplifications, but Calc's unsafe simplifications will reduce it to
@samp{x}. If you enter @samp{arcsin(sin(x)) =>} normally, the result
-will be @samp{arcsin(sin(x)) => arcsin(sin(x))}. If you change to
+will be @samp{arcsin(sin(x)) => arcsin(sin(x))}. If you change to
Extended Simplification mode, the result will be
@samp{arcsin(sin(x)) => x}. However, just pressing @kbd{a e}
once will have no effect on @samp{arcsin(sin(x)) => arcsin(sin(x))},
@kindex g O
@pindex calc-graph-output
The @kbd{g O} (@code{calc-graph-output}) command sets the name of the
-output file used by GNUPLOT. For some devices, notably @code{x11} and
+output file used by GNUPLOT@. For some devices, notably @code{x11} and
@code{windows}, there is no output file and this information is not
used. Many other ``devices'' are really file formats like
@code{postscript}; in these cases the output in the desired format
effect if the current device is @code{windows}.
The buffer called @samp{*Gnuplot Trail*} holds a transcript of the
-session with GNUPLOT. This shows the commands Calc has ``typed'' to
+session with GNUPLOT@. This shows the commands Calc has ``typed'' to
GNUPLOT and the responses it has received. Calc tries to notice when an
error message has appeared here and display the buffer for you when
this happens. You can check this buffer yourself if you suspect
Date forms are stored as @samp{(date @var{n})}, where @var{n} is
a real number that counts days since midnight on the morning of
-January 1, 1 AD. If @var{n} is an integer, this is a pure date
+January 1, 1 AD@. If @var{n} is an integer, this is a pure date
form. If @var{n} is a fraction or float, this is a date/time form.
Modulo forms are stored as @samp{(mod @var{n} @var{m})}, where @var{m} is a
function is used by the @kbd{V S} vector-sorting command, and also
by Calc's algebraic simplifications to put the terms of a product into
canonical order: This allows @samp{x y + y x} to be simplified easily to
-@samp{2 x y}.
+@samp{2 x y}.
@end defun
@defun equal x y
before the call to @code{normalize}) and, if it has changed,
the entire procedure is repeated (starting with @code{normalize})
until no further changes occur. Usually only two iterations are
-needed:@: one to simplify the formula, and another to verify that no
+needed: one to simplify the formula, and another to verify that no
further simplifications were possible.
@end defun
@c The following four macros generate the filenames and titles of the
@c main (X)Emacs manual and the Elisp/Lispref manual. Leave the
@c Texinfo variable `XEMACS' unset to generate a GNU Emacs version, set it
-@c to generate an XEmacs version, e.g. with
+@c to generate an XEmacs version, e.g., with
@c "makeinfo -DXEMACS cc-mode.texi".
@ifset XEMACS
@macro emacsman
which will rearrange brace location, amongst other things.
Preprocessor directives are handled as syntactic whitespace from other
-code, i.e. they can be interspersed anywhere without affecting the
+code, i.e., they can be interspersed anywhere without affecting the
indentation of the surrounding code, just like comments.
The code inside macro definitions is, by default, still analyzed
syntactically so that you get relative indentation there just as you'd
get if the same code was outside a macro. However, since there is no
-hint about the syntactic context, i.e. whether the macro expands to an
+hint about the syntactic context, i.e., whether the macro expands to an
expression, to some statements, or perhaps to whole functions, the
syntactic recognition can be wrong. @ccmode{} manages to figure it
out correctly most of the time, though.
encompassing point. It leaves point unchanged. This function can't be
used to reindent a nested brace construct, such as a nested class or
function, or a Java method. The top-level construct being reindented
-must be complete, i.e. it must have both a beginning brace and an ending
+must be complete, i.e., it must have both a beginning brace and an ending
brace.
@item @kbd{C-M-\} (@code{indent-region})
A popular programming style, especially for object-oriented languages
such as C++ is to write symbols in a mixed case format, where the
first letter of each word is capitalized, and not separated by
-underscores. E.g. @samp{SymbolsWithMixedCaseAndNoUnderlines}.
+underscores. E.g., @samp{SymbolsWithMixedCaseAndNoUnderlines}.
These commands move backward or forward to the beginning of the next
capitalized word. With prefix argument @var{n}, move @var{n} times.
Since there's a lot of normal text in comments and string literals,
@ccmode{} provides features to edit these like in text mode. The goal
-is to do it seamlessly, i.e. you can use auto fill mode, sentence and
+is to do it seamlessly, i.e., you can use auto fill mode, sentence and
paragraph movement, paragraph filling, adaptive filling etc. wherever
there's a piece of normal text without having to think much about it.
@ccmode{} keeps the indentation, fixes suitable comment line prefixes,
@cindex paragraph filling
Line breaks are by default handled (almost) the same regardless of
whether they are made by auto fill mode (@pxref{Auto
-Fill,,,@emacsman{}, @emacsmantitle{}}), by paragraph filling (e.g. with
+Fill,,,@emacsman{}, @emacsmantitle{}}), by paragraph filling (e.g., with
@kbd{M-q}), or explicitly with @kbd{M-j} or similar methods. In
string literals, the new line gets the same indentation as the
previous nonempty line.@footnote{You can change this default by
@findex c-context-open-line
@findex context-open-line (c-)
This is to @kbd{C-o} (@kbd{M-x open-line}) as
-@code{c-context-line-break} is to @kbd{RET}. I.e. it works just like
+@code{c-context-line-break} is to @kbd{RET}. I.e., it works just like
@code{c-context-line-break} but leaves the point before the inserted
line break.
@end table
especially for users who are new to @ccmode{}.
@item auto-newline mode
This automatically inserts newlines where you'd probably want to type
-them yourself, e.g. after typing @samp{@}}s. Its action is suppressed
+them yourself, e.g., after typing @samp{@}}s. Its action is suppressed
when electric mode is disabled.
@item hungry-delete mode
This lets you delete a contiguous block of whitespace with a single
This mode makes basic word movement commands like @kbd{M-f}
(@code{forward-word}) and @kbd{M-b} (@code{backward-word}) treat the
parts of sillycapsed symbols as different words.
-E.g. @samp{NSGraphicsContext} is treated as three words @samp{NS},
+E.g., @samp{NSGraphicsContext} is treated as three words @samp{NS},
@samp{Graphics}, and @samp{Context}.
@item syntactic-indentation mode
When this is enabled (which it normally is), indentation commands such
(@code{c-electric-slash}) causes reindentation when you type it as the
second component of a C style block comment opener (@samp{/*}) or a
C++ line comment opener (@samp{//}) respectively, but only if the
-comment opener is the first thing on the line (i.e. there's only
+comment opener is the first thing on the line (i.e., there's only
whitespace before it).
Additionally, you can configure @ccmode{} so that typing a slash at
@itemize @bullet
@item
Auto-newline minor mode is enabled, as evidenced by the indicator
-@samp{a} after the mode name on the modeline (e.g. @samp{C/a} or
+@samp{a} after the mode name on the modeline (e.g., @samp{C/a} or
@samp{C/la}).
@item
whitespace} since they are usually ignored when scanning C code.}.
@item
-No numeric argument was supplied to the command (i.e. it was typed as
+No numeric argument was supplied to the command (i.e., it was typed as
normal, with no @kbd{C-u} prefix).
@end itemize
@cindex nomenclature
@cindex subword
In spite of the GNU Coding Standards, it is popular to name a symbol
-by mixing uppercase and lowercase letters, e.g. @samp{GtkWidget},
+by mixing uppercase and lowercase letters, e.g., @samp{GtkWidget},
@samp{EmacsFrameClass}, or @samp{NSGraphicsContext}. Here we call
these mixed case symbols @dfn{nomenclatures}. Also, each capitalized
(or completely uppercase) part of a nomenclature is called a
@strong{Please note:} The font locking in AWK mode is currently not
integrated with the rest of @ccmode{}. Only the last section of this
-chapter, @ref{AWK Mode Font Locking}, applies to AWK. The other
+chapter, @ref{AWK Mode Font Locking}, applies to AWK@. The other
sections apply to the other languages.
@menu
For each language there's a variable @code{*-font-lock-extra-types},
where @samp{*} stands for the language in question. It contains a list
of regexps that matches identifiers that should be recognized as types,
-e.g. @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t}
+e.g., @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t}
as is customary in C code. Each regexp should not match more than a
single identifier.
@vindex font-lock-builtin-face
@vindex font-lock-reference-face
Preprocessor directives get @code{font-lock-preprocessor-face} if it
-exists (i.e. XEmacs). In Emacs they get @code{font-lock-builtin-face}
+exists (i.e., XEmacs). In Emacs they get @code{font-lock-builtin-face}
or @code{font-lock-reference-face}, for lack of a closer equivalent.
@item
@comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
There are various tools to supply documentation in the source as
-specially structured comments, e.g. the standard Javadoc tool in Java.
+specially structured comments, e.g., the standard Javadoc tool in Java.
@ccmode{} provides an extensible mechanism to fontify such comments and
the special markup inside them.
@defopt c-doc-comment-style
@vindex doc-comment-style (c-)
This is a style variable that specifies which documentation comment
-style to recognize, e.g. @code{javadoc} for Javadoc comments.
+style to recognize, e.g., @code{javadoc} for Javadoc comments.
The value may also be a list of styles, in which case all of them are
recognized simultaneously (presumably with markup cues that don't
Note that @ccmode{} uses this variable to set other variables that
handle fontification etc. That's done at mode initialization or when
you switch to a style which sets this variable. Thus, if you change it
-in some other way, e.g. interactively in a CC Mode buffer, you will need
+in some other way, e.g., interactively in a CC Mode buffer, you will need
to do @kbd{M-x java-mode} (or whatever mode you're currently using) to
reinitialize.
@cindex mode hooks
@comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@c The node name is "CC Hooks" rather than "Hooks" because of a bug in
-@c some older versions of Info, e.g. the info.el in GNU Emacs 21.3.
+@c some older versions of Info, e.g., the info.el in GNU Emacs 21.3.
@c If you go to "Config Basics" and hit <CR> on the xref to "CC
@c Hooks" the function Info-follow-reference searches for "*Note: CC
@c Hooks" from the beginning of the page. If this node were instead
The variables that @ccmode{}'s style system control are called
@dfn{style variables}. Note that style variables are ordinary Lisp
variables, which the style system initializes; you can change their
-values at any time (e.g. in a hook function). The style system can
+values at any time (e.g., in a hook function). The style system can
also set other variables, to some extent. @xref{Styles}.
@dfn{Style variables} are handled specially in several ways:
using @code{c-set-offset}.
@end defvar
-Note that file style settings (i.e. @code{c-file-style}) are applied
+Note that file style settings (i.e., @code{c-file-style}) are applied
before file offset settings
-(i.e. @code{c-file-offsets})@footnote{Also, if either of these are set
+(i.e., @code{c-file-offsets})@footnote{Also, if either of these are set
in a file's local variable section, all the style variable values are
made local to that buffer, even if
@code{c-style-variables-are-local-p} is @code{nil}. Since this
@noindent
with zero or more stars at the beginning of every line. If you change
this variable, please make sure it still matches the comment starter
-(i.e. @code{//}) of line comments @emph{and} the line prefix inside
+(i.e., @code{//}) of line comments @emph{and} the line prefix inside
block comments.
@findex c-setup-paragraph-variables
@ccmode{} uses adaptive fill mode (@pxref{Adaptive Fill,,, emacs, GNU
Emacs Manual}) to make Emacs correctly keep the line prefix when
filling paragraphs. That also makes Emacs preserve the text
-indentation @emph{inside} the comment line prefix. E.g. in the
+indentation @emph{inside} the comment line prefix. E.g., in the
following comment, both paragraphs will be filled with the left
margins of the texts kept intact:
@c 2005/11/22: The above is still believed to be the case.
which handles things like bulleted lists nicely. There's a convenience
function @code{c-setup-filladapt} that tunes the relevant variables in
-Filladapt for use in @ccmode{}. Call it from a mode hook, e.g. with
+Filladapt for use in @ccmode{}. Call it from a mode hook, e.g., with
something like this in your @file{.emacs}:
@example
@code{c-block-comment-prefix} typically gets overridden by the default
style @code{gnu}, which sets it to blank. You can see the line
splitting effect described here by setting a different style,
-e.g. @code{k&r} @xref{Choosing a Style}.}, which makes a comment
+e.g., @code{k&r} @xref{Choosing a Style}.}, which makes a comment
@example
/* Got O(n^2) here, which is a Bad Thing. */
@defopt c-ignore-auto-fill
@vindex ignore-auto-fill (c-)
When auto fill mode is enabled, @ccmode{} can selectively ignore it
-depending on the context the line break would occur in, e.g. to never
+depending on the context the line break would occur in, e.g., to never
break a line automatically inside a string literal. This variable
takes a list of symbols for the different contexts where auto-filling
never should occur:
@item cpp
Inside a preprocessor directive.
@item code
-Anywhere else, i.e. in normal code.
+Anywhere else, i.e., in normal code.
@end table
By default, @code{c-ignore-auto-fill} is set to @code{(string cpp
startup. The reason is that @kbd{M-j} could otherwise produce sequences
of single line block comments for texts that should logically be treated
as one comment, and the rest of the paragraph handling code
-(e.g. @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to
+(e.g., @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to
inconsistent behavior.
@comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@cindex customization, brace hanging
An action function is called with two arguments: the syntactic symbol
-for the brace (e.g. @code{substatement-open}), and the buffer position
+for the brace (e.g., @code{substatement-open}), and the buffer position
where the brace has been inserted. Point is undefined on entry to an
-action function, but the function must preserve it (e.g. by using
+action function, but the function must preserve it (e.g., by using
@code{save-excursion}). The return value should be a list containing
some combination of @code{before} and @code{after}, including neither
-of them (i.e. @code{nil}).
+of them (i.e., @code{nil}).
@defvar c-syntactic-context
@vindex syntactic-context (c-)
@ccmode{} also comes with the criteria function
@code{c-semi&comma-no-newlines-for-oneline-inliners}, which suppresses
newlines after semicolons inside one-line inline method definitions
-(e.g. in C++ or Java).
+(e.g., in C++ or Java).
@end defun
@dfn{Clean-ups} are mechanisms which remove (or exceptionally, add)
whitespace in specific circumstances and are complementary to colon
and brace hanging. You enable a clean-up by adding its symbol into
-@code{c-cleanup-list}, e.g. like this:
+@code{c-cleanup-list}, e.g., like this:
@example
(add-to-list 'c-cleanup-list 'space-before-funcall)
On the surface, it would seem that clean-ups overlap the functionality
provided by the @code{c-hanging-*-alist} variables. Clean-ups,
-however, are used to adjust code ``after-the-fact'', i.e. to adjust
+however, are used to adjust code ``after-the-fact'', i.e., to adjust
the whitespace in constructs later than when they were typed.
Most of the clean-ups remove automatically inserted newlines, and are
@item space-before-funcall
Insert a space between the function name and the opening parenthesis
of a function call. This produces function calls in the style
-mandated by the GNU coding standards, e.g. @samp{signal@w{ }(SIGINT,
+mandated by the GNU coding standards, e.g., @samp{signal@w{ }(SIGINT,
SIG_IGN)} and @samp{abort@w{ }()}. Clean up occurs when the opening
parenthesis is typed. This clean-up should never be active in AWK
Mode, since such a space is syntactically invalid for user defined
of a function call that has no arguments. This is typically used
together with @code{space-before-funcall} if you prefer the GNU function
call style for functions with arguments but think it looks ugly when
-it's only an empty parenthesis pair. I.e. you will get @samp{signal
+it's only an empty parenthesis pair. I.e., you will get @samp{signal
(SIGINT, SIG_IGN)}, but @samp{abort()}. Clean up occurs when the
closing parenthesis is typed.
@item comment-close-slash
When inside a block comment, terminate the comment when you type a slash
-at the beginning of a line (i.e. immediately after the comment prefix).
+at the beginning of a line (i.e., immediately after the comment prefix).
This clean-up removes whitespace preceding the slash and if needed,
inserts a star to complete the token @samp{*/}. Type @kbd{C-q /} in this
situation if you just want a literal @samp{/} inserted.
@noindent
The first thing inside each syntactic element is always a
@dfn{syntactic symbol}. It describes the kind of construct that was
-recognized, e.g. @code{statement}, @code{substatement},
+recognized, e.g., @code{statement}, @code{substatement},
@code{class-open}, @code{class-close}, etc. @xref{Syntactic Symbols},
for a complete list of currently recognized syntactic symbols and
their semantics. The remaining entries are various data associated
@end table
Running this command on line 4 of this example, we'd see in the echo
-area@footnote{With a universal argument (i.e. @kbd{C-u C-c C-s}) the
+area@footnote{With a universal argument (i.e., @kbd{C-u C-c C-s}) the
analysis is inserted into the buffer as a comment on the current
line.}:
Lines continuing an Objective-C method call. @ref{Objective-C Method
Symbols}.
@item extern-lang-open
-Brace that opens an @code{extern} block (e.g. @code{extern "C"
+Brace that opens an @code{extern} block (e.g., @code{extern "C"
@{...@}}). @ref{External Scope Symbols}.
@item extern-lang-close
Brace that closes an @code{extern} block. @ref{External Scope
C++ template argument list continuations. @ref{Class Symbols}.
@item inlambda
Analogous to @code{inclass} syntactic symbol, but used inside lambda
-(i.e. anonymous) functions. Only used in Pike mode. @ref{Statement
+(i.e., anonymous) functions. Only used in Pike mode. @ref{Statement
Block Symbols}.
@item lambda-intro-cont
-Lines continuing the header of a lambda function, i.e. between the
+Lines continuing the header of a lambda function, i.e., between the
@code{lambda} keyword and the function body. Only used in Pike mode.
@ref{Statement Block Symbols}.
@item inexpr-statement
the brace that opens a top-level function definition. Line 9 is the
corresponding
@code{defun-close} since it contains the brace that closes the top-level
-function definition. Line 4 is a @code{defun-block-intro}, i.e. it is
+function definition. Line 4 is a @code{defun-block-intro}, i.e., it is
the first line of a brace-block, enclosed in a
top-level function definition.
very similar semantically), so replacing the @code{class} keyword in the
example above with @code{struct} or @code{union} would still result in a
syntax of @code{class-open} for line 4 @footnote{This is the case even
-for C and Objective-C. For consistency, structs in all supported
+for C and Objective-C@. For consistency, structs in all supported
languages are syntactically equivalent to classes. Note however that
the keyword @code{class} is meaningless in C and Objective-C.}.
Similarly, line 18 is assigned @code{class-close} syntax.
There are various other top level blocks like @code{extern}, and they
are all treated in the same way except that the symbols are named after
-the keyword that introduces the block. E.g. C++ namespace blocks get
+the keyword that introduces the block. E.g., C++ namespace blocks get
the three symbols @code{namespace-open}, @code{namespace-close} and
@code{innamespace}. The currently recognized top level blocks are:
@ssindex cpp-define-intro
@ssindex cpp-macro-cont
Multiline preprocessor macro definitions are normally handled just like
-other code, i.e. the lines inside them are indented according to the
+other code, i.e., the lines inside them are indented according to the
syntactic analysis of the preceding lines inside the macro. The first
-line inside a macro definition (i.e. the line after the starting line of
+line inside a macro definition (i.e., the line after the starting line of
the cpp directive itself) gets @code{cpp-define-intro}. In this example:
@example
of a cpp directive is always given that symbol. Line 2 is given
@code{cpp-define-intro}, so that you can give the macro body as a whole
some extra indentation. Lines 3 through 5 are then analyzed as normal
-code, i.e. @code{substatement} on lines 3 and 4, and @code{else-clause}
+code, i.e., @code{substatement} on lines 3 and 4, and @code{else-clause}
on line 5.
The syntactic analysis inside macros can be turned off with
@ssindex knr-argdecl-intro
@ssindex knr-argdecl
Two other syntactic symbols can appear in old style, non-prototyped C
-code @footnote{a.k.a. K&R C, or Kernighan & Ritchie C}:
+code @footnote{a.k.a.@: K&R C, or Kernighan & Ritchie C}:
@example
1: int add_three_integers(a, b, c)
Here, line 2 is the first line in an argument declaration list and so is
given the @code{knr-argdecl-intro} syntactic symbol. Subsequent lines
-(i.e. lines 3 and 4 in this example), are given @code{knr-argdecl}
+(i.e., lines 3 and 4 in this example), are given @code{knr-argdecl}
syntax.
@defun c-lineup-inexpr-block
@findex lineup-inexpr-block (c-)
This can be used with the in-expression block symbols to indent the
-whole block to the column where the construct is started. E.g. for Java
+whole block to the column where the construct is started. E.g., for Java
anonymous classes, this lines up the class under the @samp{new} keyword,
and in Pike it lines up the lambda function body under the @samp{lambda}
keyword. Returns @code{nil} if the block isn't part of such a
@code{inline-close}, @code{block-close}, @code{brace-list-close},
@code{brace-list-intro}, @code{statement-block-intro},
@code{arglist-intro}, @code{arglist-cont-nonempty},
-@code{arglist-close}, and all @code{in*} symbols, e.g. @code{inclass}
+@code{arglist-close}, and all @code{in*} symbols, e.g., @code{inclass}
and @code{inextern-lang}.
@end defun
Since this function doesn't do anything for lines without an infix
operator you typically want to use it together with some other lineup
-settings, e.g. as follows (the @code{arglist-close} setting is just a
+settings, e.g., as follows (the @code{arglist-close} setting is just a
suggestion to get a consistent style):
@example
@defun c-lineup-math
@findex lineup-math (c-)
Like @code{c-lineup-assignments} but indent with @code{c-basic-offset}
-if no assignment operator was found on the first line. I.e. this
+if no assignment operator was found on the first line. I.e., this
function is the same as specifying a list @code{(c-lineup-assignments
+)}. It's provided for compatibility with old configurations.
@defun c-lineup-streamop
@findex lineup-streamop (c-)
-Line up C++ stream operators (i.e. @samp{<<} and @samp{>>}).
+Line up C++ stream operators (i.e., @samp{<<} and @samp{>>}).
@workswith @code{stream-op}.
@end defun
@end example
The style variable @code{c-comment-prefix-regexp} is used to recognize
-the comment line prefix, e.g. the @samp{*} that usually starts every
+the comment line prefix, e.g., the @samp{*} that usually starts every
line inside a comment.
@workswith The @code{c} syntactic symbol.
If @code{c-syntactic-indentation-in-macros} is non-@code{nil}, the
function returns the relative indentation to the macro start line to
-allow accumulation with other offsets. E.g. in the following cases,
+allow accumulation with other offsets. E.g., in the following cases,
@code{cpp-define-intro} is combined with the
@code{statement-block-intro} that comes from the @samp{do @{} that hangs
on the @samp{#define} line:
This is done only in an @samp{asm} or @samp{__asm__} block, and only to
those lines mentioned. Anywhere else @code{nil} is returned. The usual
arrangement is to have this routine as an extra feature at the start of
-arglist lineups, e.g.
+arglist lineups, e.g.:
@example
(c-lineup-gcc-asm-reg c-lineup-arglist)
Line-up functions must not move point or change the content of the
buffer (except temporarily). They are however allowed to do
-@dfn{hidden buffer changes}, i.e. setting text properties for caching
+@dfn{hidden buffer changes}, i.e., setting text properties for caching
purposes etc. Buffer undo recording is disabled while they run.
The syntactic element passed as the parameter to a line-up function is
@vindex syntactic-element (c-)
@vindex c-syntactic-context
@vindex syntactic-context (c-)
-Some syntactic symbols, e.g. @code{arglist-cont-nonempty}, have more
+Some syntactic symbols, e.g., @code{arglist-cont-nonempty}, have more
info in the syntactic element - typically other positions that can be
interesting besides the anchor position. That info can't be accessed
through the passed argument, which is a cons cell. Instead, you can
When the indentation engine calls this hook, the variable
@code{c-syntactic-context} is bound to the current syntactic context
-(i.e. what you would get by typing @kbd{C-c C-s} on the source line.
+(i.e., what you would get by typing @kbd{C-c C-s} on the source line.
@xref{Custom Braces}.). Note that you should not change point or mark
-inside a @code{c-special-indent-hook} function, i.e. you'll probably
+inside a @code{c-special-indent-hook} function, i.e., you'll probably
want to wrap your function in a @code{save-excursion}@footnote{The
numerical value returned by @code{point} will change if you change the
indentation of the line within a @code{save-excursion} form, but point
These variables control the alignment columns for line continuation
backslashes in multiline macros. They are used by the functions that
automatically insert or align such backslashes,
-e.g. @code{c-backslash-region} and @code{c-context-line-break}.
+e.g., @code{c-backslash-region} and @code{c-context-line-break}.
@code{c-backslash-column} specifies the minimum column for the
backslashes. If any line in the macro goes past this column, then the
-next tab stop (i.e. next multiple of @code{tab-width}) in that line is
+next tab stop (i.e., next multiple of @code{tab-width}) in that line is
used as the alignment column for all the backslashes, so that they
remain in a single column. However, if any lines go past
@code{c-backslash-max-column} then the backslashes in the rest of the
@vindex auto-align-backslashes (c-)
Align automatically inserted line continuation backslashes if
non-@code{nil}. When line continuation backslashes are inserted
-automatically for line breaks in multiline macros, e.g. by
+automatically for line breaks in multiline macros, e.g., by
@code{c-context-line-break}, they are aligned with the other
backslashes in the same macro if this flag is set.
section gives some insight in how @ccmode{} operates, how that interacts
with some coding styles, and what you can use to improve performance.
-The overall goal is that @ccmode{} shouldn't be overly slow (i.e. take
+The overall goal is that @ccmode{} shouldn't be overly slow (i.e., take
more than a fraction of a second) in any interactive operation.
-I.e. it's tuned to limit the maximum response time in single operations,
+I.e., it's tuned to limit the maximum response time in single operations,
which is sometimes at the expense of batch-like operations like
reindenting whole blocks. If you find that @ccmode{} gradually gets
slower and slower in certain situations, perhaps as the file grows in
@findex beginning-of-defun
In earlier versions of @ccmode{}, we used to recommend putting the
-opening brace of a top-level construct@footnote{E.g. a function in C,
+opening brace of a top-level construct@footnote{E.g., a function in C,
or outermost class definition in C++ or Java.} into the leftmost
column. Earlier still, this used to be a rigid Emacs constraint, as
embodied in the @code{beginning-of-defun} function. @ccmode now
tells @ccmode{} to use XEmacs-specific built-in functions which, in some
circumstances, can locate the top-most opening brace much more quickly than
@code{beginning-of-defun}. Preliminary testing has shown that for
-styles where these braces are hung (e.g. most JDK-derived Java styles),
+styles where these braces are hung (e.g., most JDK-derived Java styles),
this hack can improve performance of the core syntax parsing routines
from 3 to 60 times. However, for styles which @emph{do} conform to
Emacs's recommended style of putting top-level braces in column zero,
22.1 as of this writing in February 2007).
Text properties are used to speed up skipping over syntactic whitespace,
-i.e. comments and preprocessor directives. Indenting a line after a
+i.e., comments and preprocessor directives. Indenting a line after a
huge macro definition can be slow the first time, but after that the
text properties are in place and it should be fast (even after you've
edited other parts of the file and then moved back).
Font locking can be a CPU hog, especially the font locking done on
decoration level 3 which tries to be very accurate. Note that that
level is designed to be used with a font lock support mode that only
-fontifies the text that's actually shown, i.e. Lazy Lock or Just-in-time
+fontifies the text that's actually shown, i.e., Lazy Lock or Just-in-time
Lock mode, so make sure you use one of them. Fontification of a whole
buffer with some thousand lines can often take over a minute. That is
a known weakness; the idea is that it never should happen.
intention to change this goal.
If you want to reformat old code, you're probably better off using some
-other tool instead, e.g. @ref{Top, , GNU indent, indent, The `indent'
+other tool instead, e.g., @ref{Top, , GNU indent, indent, The `indent'
Manual}, which has more powerful reformatting capabilities than
@ccmode{}.
@item
The support for C++ templates (in angle brackets) is not yet complete.
When a non-nested template is used in a declaration, @ccmode{} indents
-it and font-locks it OK. Templates used in expressions, and nested
+it and font-locks it OK@. Templates used in expressions, and nested
templates do not fare so well. Sometimes a workaround is to refontify
the expression after typing the closing @samp{>}.
@end example
@xref{Getting Started}. This is a very common question. If you want
-this to be the default behavior, don't lobby us, lobby RMS! @t{:-)}
+this to be the default behavior, don't lobby us, lobby RMS@! @t{:-)}
@item
@emph{How do I stop my code jumping all over the place when I type?}
you think it might affect our ability to reproduce it.
Please try to produce the problem in an Emacs instance without any
-customizations loaded (i.e. start it with the @samp{-q --no-site-file}
+customizations loaded (i.e., start it with the @samp{-q --no-site-file}
arguments). If it works correctly there, the problem might be caused
by faulty customizations in either your own or your site
configuration. In that case, we'd appreciate it if you isolate the
defines aliases to the @file{cl-lib.el} definitions). Where
@file{cl-lib.el} defines a function called, for example,
@code{cl-incf}, @file{cl.el} uses the same name but without the
-@samp{cl-} prefix, e.g.@: @code{incf} in this example. There are a few
+@samp{cl-} prefix, e.g., @code{incf} in this example. There are a few
exceptions to this. First, functions such as @code{cl-defun} where
the unprefixed version was already used for a standard Emacs Lisp
function. In such cases, the @file{cl.el} version adds a @samp{*}
-suffix, e.g.@: @code{defun*}. Second, there are some obsolete features
+suffix, e.g., @code{defun*}. Second, there are some obsolete features
that are only implemented in @file{cl.el}, not in @file{cl-lib.el},
because they are replaced by other standard Emacs Lisp features.
Finally, in a very few cases the old @file{cl.el} versions do not
@node Setf Extensions
@subsection Setf Extensions
-Several standard (e.g.@: @code{car}) and Emacs-specific
-(e.g.@: @code{window-point}) Lisp functions are @code{setf}-able by default.
+Several standard (e.g., @code{car}) and Emacs-specific
+(e.g., @code{window-point}) Lisp functions are @code{setf}-able by default.
This package defines @code{setf} handlers for several additional functions:
@itemize
through the Lisp @code{message} function.
@c Bug#411.
-Note that many primitives (e.g.@: @code{+}) have special byte-compile
+Note that many primitives (e.g., @code{+}) have special byte-compile
handling. Attempts to redefine such functions using @code{flet} will
fail if byte-compiled.
@c Or cl-flet.
Class trees are displayed in @dfn{tree buffers} which install their own
major mode. Most Emacs keys work in tree buffers in the usual way,
-e.g.@: you can move around in the buffer with the usual @kbd{C-f},
+e.g., you can move around in the buffer with the usual @kbd{C-f},
@kbd{C-v} etc., or you can search with @kbd{C-s}.
Tree-specific commands are bound to simple keystrokes, similar to
to the one containing the member.
With a prefix argument (@kbd{C-u}), all members in the class tree,
-i.e.@: all members the browser knows about appear in the completion
+i.e., all members the browser knows about appear in the completion
list. The member display will be switched to the class and member list
containing the member.
Directly after you performed a jump, this will put you back to the
position where you came from.
-The stack is not popped, i.e.@: you can always switch back and forth
+The stack is not popped, i.e., you can always switch back and forth
between positions in the stack. To avoid letting the stack grow to
infinite size there is a maximum number of positions defined. When this
number is reached, older positions are discarded when new positions are
remember only part of a member name, and not its beginning.
A special buffer is popped up containing all identifiers matching the
-regular expression, and what kind of symbol it is (e.g.@: a member
+regular expression, and what kind of symbol it is (e.g., a member
function, or a type). You can then switch to this buffer, and use the
command @kbd{C-c C-m f}, for example, to jump to a specific member.
@subsection Custom Locate
The various simple project styles all have one major drawback, which
-is that the files in the project are not completely known to EDE.
+is that the files in the project are not completely known to EDE@.
When the EDE API is used to try and file files by some reference name
in the project, then that could fail.
@code{ede-locate-setup-options} with the names of different locate
objects. @ref{Miscellaneous commands}.
-Configure this in your @file{.emacs} before loading in CEDET or EDE.
+Configure this in your @file{.emacs} before loading in CEDET or EDE@.
If you want to add support for GNU Global, your configuration would
look like this:
@end example
That way, when a search needs to be done, it will first try using
-GLOBAL. If global is not available for that directory, then it will
+GLOBAL@. If global is not available for that directory, then it will
revert to the base locate object. The base object always fails to
find a file.
required.
@ede{} uses @eieio{}, the CLOS package for Emacs, to define two object
-superclasses, specifically the PROJECT and TARGET. All commands in
+superclasses, specifically the PROJECT and TARGET@. All commands in
@ede{} are usually meant to address the current project, or current
target.
@code{ede-dir-to-projectfile} on every @code{ede-project-autoload}
until one of them returns true. The method
@code{ede-dir-to-projectfile} in turn gets the @code{:proj-file} slot
-from the autoload. If it is a string (ie, a project file name), it
+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
@ede{} projects track source file / target associates via source code
objects. The definitions for this is in @file{ede-source.el}. A source
code object contains methods that know how to identify a file as being
-of that class, (ie, a C file ends with @file{.c}). Some targets can
+of that class, (i.e., a C file ends with @file{.c}). Some targets can
handle many different types of sources which must all be compiled
together. For example, a mixed C and C++ program would have
instantiations of both sourcecode types.
@item :web-site-directory @*
A directory where web pages can be found by Emacs.
-For remote locations use a path compatible with ange-ftp or EFS.
+For remote locations use a path compatible with ange-ftp or EFS@.
You can also use TRAMP for use with rcp & scp.
@refill
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
+It should return the fully qualified file name passed in from NAME@. If that file does not
exist, it should return nil.
@refill
@end deffn
@deffn Method ede-buffer-header-file :AFTER this buffer
-There are no default header files in EDE.
+There are no default header files in EDE@.
Do a quick check to see if there is a Header tag in this buffer.
@end deffn
type a number, say 3, and then @kbd{j} (@code{ediff-jump-to-difference}),
Ediff moves to the third difference region. Typing 3 and then @kbd{a}
(@code{ediff-diff-to-diff}) copies the 3rd difference region from variant A
-to variant B. Likewise, 4 followed by @kbd{ra} restores the 4th difference
+to variant B@. Likewise, 4 followed by @kbd{ra} restores the 4th difference
region in buffer A (if it was previously written over via the command
@kbd{a}).
@kindex a
@emph{In comparison sessions:}
Copies the current difference region (or the region specified as the prefix
-to this command) from buffer A to buffer B.
+to this command) from buffer A to buffer B@.
Ediff saves the old contents of buffer B's region; it can
be restored via the command @kbd{rb}, which see.
@item ab
@kindex ab
Copies the current difference region (or the region specified as the prefix
-to this command) from buffer A to buffer B. This (and the next five)
+to this command) from buffer A to buffer B@. This (and the next five)
command is enabled only in sessions that compare three files
simultaneously. The old region in buffer B is saved and can be restored
via the command @kbd{rb}.
@item ac
@kindex ac
-Copies the difference region from buffer A to buffer C.
+Copies the difference region from buffer A to buffer C@.
The old region in buffer C is saved and can be restored via the command
@kbd{rc}.
@item ba
@kindex ba
-Copies the difference region from buffer B to buffer A.
+Copies the difference region from buffer B to buffer A@.
The old region in buffer A is saved and can be restored via the command
@kbd{ra}.
@item bc
@kindex bc
-Copies the difference region from buffer B to buffer C.
+Copies the difference region from buffer B to buffer C@.
The command @kbd{rc} undoes this.
@item ca
@kindex ca
-Copies the difference region from buffer C to buffer A.
+Copies the difference region from buffer C to buffer A@.
The command @kbd{ra} undoes this.
@item cb
@kindex cb
-Copies the difference region from buffer C to buffer B.
+Copies the difference region from buffer C to buffer B@.
The command @kbd{rb} undoes this.
@item p
@item A
@kindex A
-Toggles the read-only property in buffer A.
+Toggles the read-only property in buffer A@.
If file A is under version control and is checked in, it is checked out
(with your permission).
@item B
@kindex B
-Toggles the read-only property in buffer B.
+Toggles the read-only property in buffer B@.
If file B is under version control and is checked in, it is checked out.
@item C
@kindex C
wear and tear by saving him and her much of unproductive, repetitive
typing. If it notices that, say, file A's difference region is identical to
the same difference region in the ancestor file, then the merge buffer will
-automatically get the difference region taken from buffer B. The rationale
+automatically get the difference region taken from buffer B@. The rationale
is that this difference region in buffer A is as old as that in the
ancestor buffer, so the contents of that region in buffer B represents real
change.
identical to its default setting, as originally decided by Ediff. For
instance, if Ediff is merging according to the `combined' policy, then the
merge region is skipped over if it is different from the combination of the
-regions in buffers A and B. (Warning: swapping buffers A and B will confuse
+regions in buffers A and B@. (Warning: swapping buffers A and B will confuse
things in this respect.) If the merge region is marked as `prefer-A' then
this region will be skipped if it differs from the current difference
region in buffer A, etc.
in @code{ediff-control-buffer;} they should also leave
@code{ediff-control-buffer} as the current buffer when they finish.
Hooks that are executed after @code{ediff-cleanup-mess} should expect
-the current buffer be either buffer A or buffer B.
+the current buffer be either buffer A or buffer B@.
@code{ediff-cleanup-mess} doesn't kill the buffers being compared or
merged (see @code{ediff-cleanup-hook}, below).
@section Window and Frame Configuration
On a non-windowing display, Ediff sets things up in one frame, splitting
-it between a small control window and the windows for buffers A, B, and C.
+it between a small control window and the windows for buffers A, B, and C@.
The split between these windows can be horizontal or
vertical, which can be changed interactively by typing @kbd{|} while the
cursor is in the control window.
STRING3 Symbol3 STRING4)}. The symbols here must be atoms of the form
@code{A}, @code{B}, or @code{Ancestor}. They determine the order in which
the corresponding difference regions (from buffers A, B, and the ancestor
-buffer) are displayed in the merged region of buffer C. The strings in the
+buffer) are displayed in the merged region of buffer C@. The strings in the
template determine the text that separates the aforesaid regions. The
default template is
@samp{=diff(B)} will change to @samp{diff-A} and the mode line will
display @samp{=diff(A) prefer-B}. This indicates that the difference
region in buffer C is identical to that in buffer A, but originally
-buffer C's region came from buffer B. This is useful to know because
+buffer C's region came from buffer B@. This is useful to know because
you can recover the original difference region in buffer C by typing
@kbd{r}.
not take it into account for the purpose of computing fine differences. The
result is that Ediff can provide a better visual information regarding the
actual fine differences in the non-white regions in buffers B and
-C. Moreover, if the regions in buffers B and C differ in the white space
+C@. Moreover, if the regions in buffers B and C differ in the white space
only, then a message to this effect will be displayed.
@vindex ediff-merge-window-share
In two-way comparison, this variable is @code{nil}.
@item ediff-window-A
-The window displaying buffer A. If buffer A is not visible, this variable
+The window displaying buffer A@. If buffer A is not visible, this variable
is @code{nil} or it may be a dead window.
@item ediff-window-B
@chapter Credits
Ediff was written by Michael Kifer <kifer@@cs.stonybrook.edu>. It was inspired
-by emerge.el written by Dale R.@: Worley <drw@@math.mit.edu>. An idea due to
+by emerge.el written by Dale R. Worley <drw@@math.mit.edu>. An idea due to
Boris Goldowsky <boris@@cs.rochester.edu> made it possible to highlight
fine differences in Ediff buffers. Alastair Burt <burt@@dfki.uni-kl.de>
ported Ediff to XEmacs, Eric Freudenthal <freudent@@jan.ultra.nyu.edu>
Drew Adams (drew.adams at oracle.com),
Steve Baur (steve at xemacs.org),
Neal Becker (neal at ctd.comsat.com),
-E.@: Jay Berkenbilt (ejb at ql.org),
+E. Jay Berkenbilt (ejb at ql.org),
Lennart Borgman (ennart.borgman at gmail.com)
Alastair Burt (burt at dfki.uni-kl.de),
Paul Bibilo (peb at delcam.co.uk),
Kevin Broadey (KevinB at bartley.demon.co.uk),
Harald Boegeholz (hwb at machnix.mathematik.uni-stuttgart.de),
-Bradley A.@: Bosch (brad at lachman.com),
-Michael D.@: Carney (carney at ltx-tr.com),
-Jin S.@: Choi (jin at atype.com),
+Bradley A. Bosch (brad at lachman.com),
+Michael D. Carney (carney at ltx-tr.com),
+Jin S. Choi (jin at atype.com),
Scott Cummings (cummings at adc.com),
Albert Dvornik (bert at mit.edu),
Eric Eide (eeide at asylum.cs.utah.edu),
Stefan Reicher (xsteve at riic.at),
Charles Rich (rich at merl.com),
Bill Richter (richter at math.nwu.edu),
-C.S.@: Roberson (roberson at aur.alcatel.com),
+C.S. Roberson (roberson at aur.alcatel.com),
Kevin Rodgers (kevin.rodgers at ihs.com),
Sandy Rutherford (sandy at ibm550.sissa.it),
Heribert Schuetz (schuetz at ecrc.de),
This manual describes version 4.0 of the EDT Emulation for Emacs.
It comes with special functions which replicate nearly all of
EDT's keypad mode behavior. It sets up default keypad and function key
-bindings which closely match those found in EDT. Support is provided so
+bindings which closely match those found in EDT@. Support is provided so
that users may reconfigure most keypad and function key bindings to
their own liking.
emulation.
Emacs binds keys to @acronym{ASCII} control characters and so does the
-real EDT. Where EDT key bindings and Emacs key bindings conflict,
+real EDT@. Where EDT key bindings and Emacs key bindings conflict,
the default Emacs key bindings are retained by the EDT emulation by
default. If you are a diehard EDT user you may not like this. The
@ref{Control keys} section explains how to change this so that the EDT
@end example
So, after executing @samp{xmodmap .xmodmaprc}, a press of the physical
-@key{F12} key looks like a Num_Lock keypress to X. Also, a press of the
+@key{F12} key looks like a Num_Lock keypress to X@. Also, a press of the
physical @key{NumLock} key looks like a press of the @key{F12} key to X.
Now, @file{edt-mapper.el} will see @samp{f12} when the physical
@item
Cursor movement and deletion involving word entities is identical to
-EDT. This, above all else, gives the die-hard EDT user a sense of being
+EDT@. This, above all else, gives the die-hard EDT user a sense of being
at home. Also, an emulation of EDT's @samp{SET ENTITY WORD} command is
provided, for those users who like to customize movement by a word at a
time to their own liking.
@node Wish List
@chapter Wish List
-@eieio{} is an incomplete implementation of CLOS. Finding ways to
+@eieio{} is an incomplete implementation of CLOS@. Finding ways to
improve the compatibility would help make CLOS style programs run
better in Emacs.
does not enable scrolling, which means that you cannot see the whole
image. To prevent this, the library tries to determine the image size
before displaying it inline, and if it doesn't fit the window, the
-library will display it externally (e.g. with @samp{ImageMagick} or
+library will display it externally (e.g., with @samp{ImageMagick} or
@samp{xv}). Setting this variable to @code{t} disables this check and
makes the library display all inline images as inline, regardless of
their size. If you set this variable to @code{resize}, the image will
@item mm-w3m-safe-url-regexp
@vindex mm-w3m-safe-url-regexp
-A regular expression that matches safe URL names, i.e. URLs that are
+A regular expression that matches safe URL names, i.e., URLs that are
unlikely to leak personal information when rendering @acronym{HTML}
email (the default value is @samp{\\`cid:}). If @code{nil} consider
all URLs safe. In Gnus, this will be overridden according to the value
@item mm-file-name-delete-gotchas
@findex mm-file-name-delete-gotchas
Delete characters that could have unintended consequences when used
-with flawed shell scripts, i.e. @samp{|}, @samp{>} and @samp{<}; and
+with flawed shell scripts, i.e., @samp{|}, @samp{>} and @samp{<}; and
@samp{-}, @samp{.} as the first character.
@item mm-file-name-delete-whitespace
used.
@code{qp-or-base64} has another effect. It will fold long lines so that
-MIME parts may not be broken by MTA. So do @code{quoted-printable} and
+MIME parts may not be broken by MTA@. So do @code{quoted-printable} and
@code{base64}.
Note that it affects body encoding only when a part is a raw forwarded
@item rfc2047-encode-encoded-words
@vindex rfc2047-encode-encoded-words
The boolean variable specifies whether encoded words
-(e.g. @samp{=?us-ascii?q?hello?=}) should be encoded again.
+(e.g., @samp{=?us-ascii?q?hello?=}) should be encoded again.
@code{rfc2047-encoded-word-regexp} is used to look for such words.
@item rfc2047-allow-irregular-q-encoded-words
@vindex rfc2047-allow-irregular-q-encoded-words
The boolean variable specifies whether irregular Q encoded words
-(e.g. @samp{=?us-ascii?q?hello??=}) should be decoded. If it is
+(e.g., @samp{=?us-ascii?q?hello??=}) should be decoded. If it is
non-@code{nil}, @code{rfc2047-encoded-word-regexp-loose} is used instead
of @code{rfc2047-encoded-word-regexp} to look for encoded words.
return a ``zero'' time.
@item time-less-p
-Take two times and say whether the first time is less (i. e., earlier)
+Take two times and say whether the first time is less (i.e., earlier)
than the second time.
@item time-since
Take a time and return a time saying how long it was since that time.
@item subtract-time
-Take two times and subtract the second from the first. I. e., return
+Take two times and subtract the second from the first. I.e., return
the time between the two times.
@item days-between
@end ifnottex
@menu
-* Overview::
-* Quick start::
-* Commands::
-* Caching Passphrases::
-* Bug Reports::
+* Overview::
+* Quick start::
+* Commands::
+* Caching Passphrases::
+* Bug Reports::
@end menu
@node Overview
This chapter introduces various commands for typical use cases.
@menu
-* Key management::
-* Cryptographic operations on regions::
-* Cryptographic operations on files::
-* Dired integration::
-* Mail-mode integration::
-* Encrypting/decrypting *.gpg files::
+* Key management::
+* Cryptographic operations on regions::
+* Cryptographic operations on files::
+* Dired integration::
+* Mail-mode integration::
+* Encrypting/decrypting *.gpg files::
@end menu
@node Key management
blobs inside a message body, not using modern MIME format.
NOTE: Inline OpenPGP is not recommended and you should consider to use
-PGP/MIME. See
+PGP/MIME@. See
@uref{http://josefsson.org/inline-openpgp-considered-harmful.html,
Inline OpenPGP in E-mail is bad@comma{} Mm'kay?}.
* Keystroke Summary:: Keystrokes used in ERC buffers.
* Modules:: Available modules for ERC.
* Advanced Usage:: Cool ways of using ERC.
-* Getting Help and Reporting Bugs::
+* Getting Help and Reporting Bugs::
* History:: The history of ERC.
* Copying:: The GNU General Public License gives you
permission to redistribute ERC on
@item user scripting
-Users can load scripts (e.g. auto greeting scripts) when ERC starts up.
+Users can load scripts (e.g., auto greeting scripts) when ERC starts up.
It is also possible to make custom IRC commands, if you know a little
Emacs Lisp. Just make an Emacs Lisp function and call it
help you figure out its parameters.
@defun erc
-Select connection parameters and run ERC.
+Select connection parameters and run ERC@.
Non-interactively, it takes the following keyword arguments.
@itemize @bullet
@section Sample Configuration
@cindex configuration, sample
-Here is an example of configuration settings for ERC. This can go into
+Here is an example of configuration settings for ERC@. This can go into
your Emacs configuration file. Everything after the @code{(require
'erc)} command can optionally go into @file{~/.emacs.d/.ercrc.el}.
(erc :server "localhost" :port "6667"
:nick "MYNICK")))
-;; Make C-c RET (or C-c C-RET) send messages instead of RET. This has
+;; Make C-c RET (or C-c C-RET) send messages instead of RET. This has
;; been commented out to avoid confusing new users.
;; (define-key erc-mode-map (kbd "RET") nil)
;; (define-key erc-mode-map (kbd "C-c RET") 'erc-send-current-line)
@kbd{M-x customize-group erc RET}.
@defopt erc-hide-list
-If non, @code{nil}, this is a list of IRC message types to hide, e.g.
+If non, @code{nil}, this is a list of IRC message types to hide, e.g.:
@example
(setq erc-hide-list '("JOIN" "PART" "QUIT"))
@item
@uref{http://www.emacswiki.org/cgi-bin/wiki/ERC} is the
-emacswiki.org page for ERC. Anyone may add tips, hints, etc. to it.
+emacswiki.org page for ERC@. Anyone may add tips, hints, etc. to it.
@item
You can ask questions about using ERC on the Emacs mailing list,
selector "^ert-" selects ERT's self-tests.
Other uses include grouping tests by their expected execution time,
-e.g. to run quick tests during interactive development and slow tests less
+e.g., to run quick tests during interactive development and slow tests less
often. This can be achieved with the @code{:tag} argument to
@code{ert-deftest} and @code{tag} test selectors.
@item Eshell scripts can't execute in the background
-@item Support zsh's ``Parameter Expansion'' syntax, i.e. @samp{$@{@var{name}:-@var{val}@}}
+@item Support zsh's ``Parameter Expansion'' syntax, i.e., @samp{$@{@var{name}:-@var{val}@}}
@item Write an @command{info} alias that can take arguments
@item Implement @command{stty} in Lisp
-@item Support @command{rc}'s matching operator, e.g. @samp{~ (@var{list}) @var{regexp}}
+@item Support @command{rc}'s matching operator, e.g., @samp{~ (@var{list}) @var{regexp}}
@item Implement @command{bg} and @command{fg} as editors of @code{eshell-process-list}
@comment node-name, next, previous, up
@chapter Usage
-This chapter describes the usage of EUDC. Most functions and
+This chapter describes the usage of EUDC@. Most functions and
customization options are available through the @samp{Directory Search}
submenu of the @samp{Tools} submenu.
@quotation
This list of frequently asked questions about GNU Emacs with answers
(``FAQ'') may be translated into other languages, transformed into other
-formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information.
+formats (e.g., Texinfo, Info, WWW, WAIS), and updated with new information.
The same conditions apply to any derivative of the FAQ as apply to the FAQ
itself. Every copy of the FAQ must include this notice or an approved
pressed.}.
@kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127. It is a misnomer to call
-@kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON.
+@kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON@.
Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127.
@c FIXME I cannot understand the previous sentence.
@cindex Directories and files that come with Emacs
These are files that come with Emacs. The Emacs distribution is divided
-into subdirectories; e.g. @file{etc}, @file{lisp}, and @file{src}.
-Some of these (e.g. @file{etc} and @file{lisp}) are present both in
-an installed Emacs and in the sources, but some (e.g. @file{src}) are
+into subdirectories; e.g., @file{etc}, @file{lisp}, and @file{src}.
+Some of these (e.g., @file{etc} and @file{lisp}) are present both in
+an installed Emacs and in the sources, but some (e.g., @file{src}) are
only found in the sources.
If you use Emacs, but don't know where it is kept on your system, start
@end table
-Avoid confusing the FSF and the LPF. The LPF opposes
+Avoid confusing the FSF and the LPF@. The LPF opposes
look-and-feel copyrights and software patents. The FSF aims to make
high quality free software available for everyone.
invokes help on your system, type @kbd{M-x where-is @key{RET}
help-for-help @key{RET}}. This will print a comma-separated list of key
sequences in the echo area. Ignore the last character in each key
-sequence listed. Each of the resulting key sequences (e.g. @key{F1} is
+sequence listed. Each of the resulting key sequences (e.g., @key{F1} is
common) invokes help.
Emacs help works best if it is invoked by a single key whose value
apropos-documentation}.
@item
-You can order a hardcopy of the manual from the FSF. @xref{Getting a
+You can order a hardcopy of the manual from the FSF@. @xref{Getting a
printed manual}.
@cindex Reference cards, in other languages
@cindex Manual, obtaining a printed or HTML copy of
@cindex Emacs manual, obtaining a printed or HTML copy of
-You can order a printed copy of the Emacs manual from the FSF. For
+You can order a printed copy of the Emacs manual from the FSF@. For
details see the @uref{http://shop.fsf.org/, FSF on-line store}.
The full Texinfo source for the manual also comes in the @file{doc/emacs}
@cindex TECO
@cindex Original version of Emacs
-Emacs originally was an acronym for Editor MACroS. RMS says he ``picked
+Emacs originally was an acronym for Editor MACroS@. RMS says he ``picked
the name Emacs because @key{E} was not in use as an abbreviation on ITS at
the time.'' The first Emacs was a set of macros written in 1976 at MIT
by RMS for the editor TECO (Text Editor and COrrector, originally Tape
@cindex Bazaar repository, Emacs
Emacs @value{EMACSVER} is the current version as of this writing. A version
-number with two components (e.g. @samp{22.1}) indicates a released
+number with two components (e.g., @samp{22.1}) indicates a released
version; three components indicate a development
-version (e.g. @samp{23.0.50} is what will eventually become @samp{23.1}).
+version (e.g., @samp{23.0.50} is what will eventually become @samp{23.1}).
Emacs is under active development, hosted at
@uref{http://savannah.gnu.org/projects/emacs/, Savannah}. The source
change their values, and save your changes to your init file.
@xref{Easy Customization,,, emacs, The GNU Emacs Manual}.
-If you know the name of the group in advance (e.g. ``shell''), use
+If you know the name of the group in advance (e.g., ``shell''), use
@kbd{M-x customize-group @key{RET}}.
If you wish to customize a single option, use @kbd{M-x customize-option
@cindex Console, colors
In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
-i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when
+i.e., on Unix and GNU/Linux text-only terminals and consoles, and when
invoked as @samp{emacs -nw} on X, and MS-Windows. (Colors and faces were
supported in the MS-DOS port since Emacs 19.29.) Emacs automatically
detects color support at startup and uses it if available. If you think
@cindex Major mode for shell scripts
The variable @code{interpreter-mode-alist} specifies which mode to use
-when loading an interpreted script (e.g. shell, python, etc.). Emacs
+when loading an interpreted script (e.g., shell, python, etc.). Emacs
determines which interpreter you're using by examining the first line of
the script. Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on
@code{interpreter-mode-alist} to learn more.
@c Don't include VER in the file name, because pretests are not there.
@uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz}
-(Replace @samp{VERSION} with the relevant version number, e.g. @samp{23.1}.)
+(Replace @samp{VERSION} with the relevant version number, e.g., @samp{23.1}.)
@item
Next uncompress and extract the source files. This requires
@cindex Misspecified key sequences
Usually, one of two things has happened. In one case, the control
-character in the key sequence has been misspecified (e.g. @samp{C-f}
+character in the key sequence has been misspecified (e.g., @samp{C-f}
used instead of @samp{\C-f} within a Lisp expression). In the other
case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
was already bound as a @dfn{complete key}. Historically, the @samp{ESC [}
@item
Not all modifiers are permitted in all situations. @key{Hyper},
@key{Super}, and @key{Alt} are not available on Unix character
-terminals. Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and
+terminals. Non-@acronym{ASCII} keys and mouse events (e.g., @kbd{C-=} and
@kbd{Mouse-1}) also fall under this category.
@end itemize
@end lisp
Note that the aliases are expanded automatically only after you type
-a word-separator character (e.g. @key{RET} or @kbd{,}). You can force their
+a word-separator character (e.g., @key{RET} or @kbd{,}). You can force their
expansion by moving point to the end of the alias and typing @kbd{C-x a e}
(@kbd{M-x expand-abbrev}).
@end itemize
@ifnottex
@node Top
@top GNU Flymake
-@insertcopying
+@insertcopying
@end ifnottex
@menu
(compiler for C++ files, @code{perl} for perl files, etc.) in the
background, passing it a temporary copy of the current buffer, and
parses the output for known error/warning message patterns. Flymake
-then highlights erroneous lines (i.e. lines for which at least one
+then highlights erroneous lines (i.e., lines for which at least one
error or warning has been reported by the syntax check tool), and
displays an overall buffer status in the mode line. Status information
displayed by Flymake contains total number of errors and warnings
actual data to be presented. The control file describes
how to present it.
-@insertcopying
+@insertcopying
@menu
* Forms Example:: An example: editing the password data base.
they make up a forms.
The contents of the forms consist of the contents of the fields of the
-record (e.g. @samp{root}, @samp{0}, @samp{1}, @samp{Super User})
+record (e.g., @samp{root}, @samp{0}, @samp{1}, @samp{Super User})
interspersed with normal text (e.g @samp{User : }, @samp{Uid: }).
If you modify the contents of the fields, Forms mode will analyze your
@code{nil}, multi-line text fields are prohibited. The pseudo newline
must not be a character contained in @code{forms-field-sep}.
-The default value is @code{"\^k"}, the character Control-K. Example:
+The default value is @code{"\^k"}, the character Control-K@. Example:
@example
(setq forms-multi-line "\^k")
The default format for the data file, using @code{"\t"} to separate
fields and @code{"\^k"} to separate lines within a field, matches the
-file format of some popular database programs, e.g. FileMaker. So
+file format of some popular database programs, e.g., FileMaker. So
@code{forms-mode} can decrease the need to use proprietary software.
@node Error Messages
@top Gnus Coding Style and Maintenance Guide
This manual describes @dots{}
-@insertcopying
+@insertcopying
@end ifnottex
@menu
The Gnus distribution contains a lot of libraries that have been written
for Gnus and used intensively for Gnus. But many of those libraries are
-useful on their own. E.g. other Emacs Lisp packages might use the
+useful on their own. E.g., other Emacs Lisp packages might use the
@acronym{MIME} library @xref{Top, ,Top, emacs-mime, The Emacs MIME
Manual}.
Functions for Cancel-Lock feature
@c Cf. draft-ietf-usefor-cancel-lock-01.txt
@c Although this draft has expired, Canlock-Lock revived in 2007 when
-@c major news providers (e.g. news.individual.org) started to use it.
+@c major news providers (e.g., news.individual.org) started to use it.
@c As of 2007-08-25...
There are no Gnus dependencies in these files.
The development of Gnus normally is done on the Git repository trunk
as of April 19, 2010 (formerly it was done in CVS; the repository is
-at http://git.gnus.org), i.e. there are no separate branches to
+at http://git.gnus.org), i.e., there are no separate branches to
develop and test new features. Most of the time, the trunk is
developed quite actively with more or less daily changes. Only after
-a new major release, e.g. 5.10.1, there's usually a feature period of
+a new major release, e.g., 5.10.1, there's usually a feature period of
several months. After the release of Gnus 5.10.6 the development of
new features started again on the trunk while the 5.10 series is
continued on the stable branch (v5-10) from which more stable releases
will be done when needed (5.10.8, @dots{}). @ref{Gnus Development,
,Gnus Development, gnus, The Gnus Newsreader}
-Stable releases of Gnus finally become part of Emacs. E.g. Gnus 5.8
-became a part of Emacs 21 (relabeled to Gnus 5.9). The 5.10 series
+Stable releases of Gnus finally become part of Emacs. E.g., Gnus 5.8
+became a part of Emacs 21 (relabeled to Gnus 5.9). The 5.10 series
became part of Emacs 22 as Gnus 5.11.
@section Syncing
For new customizable variables introduced in Oort Gnus (including the
v5-10 branch) use @code{:version "22.1" ;; Oort Gnus} (including the
-comment) or e.g. @code{:version "22.2" ;; Gnus 5.10.10} if the feature
+comment) or, e.g., @code{:version "22.2" ;; Gnus 5.10.10} if the feature
was added for Emacs 22.2 and Gnus 5.10.10.
@c
If the variable is new in No Gnus use @code{:version "23.1" ;; No Gnus}.
as a part of Emacs. It's been around in some form for almost a decade
now, and has been distributed as a standard part of Emacs for much of
that time. Gnus 5 is the latest (and greatest) incarnation. The
-original version was called GNUS, and was written by Masanobu UMEDA.
+original version was called GNUS, and was written by Masanobu UMEDA@.
When autumn crept up in '94, Lars Magne Ingebrigtsen grew bored and
decided to rewrite Gnus.
Message-utils now included in Gnus.
@item
-New format specifiers for summary lines, e.g. %B for
+New format specifiers for summary lines, e.g., %B for
a complex trn-style thread tree.
@end itemize
Gnus is released independent from releases of Emacs and XEmacs.
Therefore, the version bundled with Emacs or the version in XEmacs's
-package system might not be up to date (e.g. Gnus 5.9 bundled with Emacs
+package system might not be up to date (e.g., Gnus 5.9 bundled with Emacs
21 is outdated).
You can get the latest released version of Gnus from
@uref{http://www.gnus.org/dist/gnus.tar.gz}
(under MS-Windows either get the Cygwin environment from
@uref{http://www.cygwin.com}
which allows you to do what's described above or unpack the
-tarball with some packer (e.g. Winace from
+tarball with some packer (e.g., Winace from
@uref{http://www.winace.com})
and use the batch-file make.bat included in the tarball to install
Gnus.) If you don't want to (or aren't allowed to) install Gnus
This message means that the last time you used Gnus, it
wasn't properly exited and therefore couldn't write its
-information to disk (e.g. which messages you read), you
+information to disk (e.g., which messages you read), you
are now asked if you want to restore that information
from the auto-save file.
@subsubheading Answer
Gnus offers the topic mode, it allows you to sort your
-groups in, well, topics, e.g. all groups dealing with
+groups in, well, topics, e.g., all groups dealing with
Linux under the topic linux, all dealing with music under
the topic music and all dealing with scottish music under
the topic scottish which is a subtopic of music.
you want, so let's do it the correct way.
The first thing you've got to do is to
create a suitable directory (no blanks in directory name
-please) e.g. c:\myhome. Then you must set the environment
+please), e.g., c:\myhome. Then you must set the environment
variable HOME to this directory. To do this under Windows 9x
or Me include the line
send them directly to a SMTP Server 2: Some program like
fetchmail retrieves your mail and stores it on disk from
where Gnus shall read it. Outgoing mail is sent by
-Sendmail, Postfix or some other MTA. Sometimes, you even
+Sendmail, Postfix or some other MTA@. Sometimes, you even
need a combination of the above cases.
However, the first thing to do is to tell Gnus in which way
achieve what you want. The easiest way is to get an external
program which retrieves copies of the mail and stores them
on disk, so Gnus can read it from there. On Unix systems you
-could use e.g. fetchmail for this, on MS Windows you can use
+could use, e.g., fetchmail for this, on MS Windows you can use
Hamster, an excellent local news and mail server.
The other solution would be, to replace the method Gnus
GNU Emacs look for the file epop3.el which can do the same
(If you know the home of this file, please send me an
e-mail). You can also tell Gnus to use an external program
-(e.g. fetchmail) to fetch your mail, see the info node
+(e.g., fetchmail) to fetch your mail, see the info node
"Mail Source Specifiers" in the Gnus manual on how to do
it.
* FAQ 4-9:: Is there a way to automatically ignore posts by specific
authors or with specific words in the subject? And can I
highlight more interesting ones in some way?
-* FAQ 4-10:: How can I disable threading in some (e.g. mail-) groups,
+* FAQ 4-10:: How can I disable threading in some (e.g., mail-) groups,
or set other variables specific for some groups?
* FAQ 4-11:: Can I highlight messages written by me and follow-ups to
those?
@samp{RET}
in group buffer with point over the group, only unread and ticked messages are loaded. Say
@samp{C-u RET}
-instead to load all available messages. If you want only the e.g. 300 newest say
+instead to load all available messages. If you want only the 300 newest say
@samp{C-u 300 RET}
Loading only unread messages can be annoying if you have threaded view enabled, say
@samp{s} for substring-match and delete afterwards
everything but the name to score down all authors with the given
name no matter which email address is used. Now you need to tell
-Gnus when to apply the rule and how long it should last, hit e.g.
+Gnus when to apply the rule and how long it should last, hit
@samp{p} to apply the rule now and let it last
forever. If you want to raise the score instead of lowering it say
@samp{I} instead of @samp{L}.
whose elements are lists again. the first element of those lists
is the header to score on, then one more list with what to match,
which score to assign, when to expire the rule and how to do the
-matching. If you find me very interesting, you could e.g. add the
+matching. If you find me very interesting, you could add the
following to your all.Score:
@example
@node FAQ 4-10
@subsubheading Question 4.10
-How can I disable threading in some (e.g. mail-) groups, or
+How can I disable threading in some (e.g., mail-) groups, or
set other variables specific for some groups?
@subsubheading Answer
sadly hard tabulators are broken in 5.8.8.
Since 5.10, Gnus offers you some very nice new specifiers,
-e.g. %B which draws a thread-tree and %&user-date which
+e.g., %B which draws a thread-tree and %&user-date which
gives you a date where the details are dependent of the
articles age. Here's an example which uses both:
@example
(defun my-archive-article (&optional n)
- "Copies one or more article(s) to a corresponding `nnml:' group, e.g.
+ "Copies one or more article(s) to a corresponding `nnml:' group, e.g.,
`gnus.ding' goes to `nnml:1.gnus.ding'. And `nnml:List-gnus.ding' goes
to `nnml:1.List-gnus-ding'.
@subsubheading Answer
-If you want all read messages to be expired (e.g. in
+If you want all read messages to be expired (e.g., in
mailing lists where there's an online archive), you've
got two choices: auto-expire and
total-expire. Auto-expire means, that every article
(If you want to change the value of nnmail-expiry-target
on a per group basis see the question "How can I disable
-threading in some (e.g. mail-) groups, or set other
+threading in some (e.g., mail-) groups, or set other
variables specific for some groups?")
@node FAQ 7 - Gnus in a dial-up environment
it's a small freeware, open-source program which fetches
your mail and news from remote servers and offers them
to Gnus (or any other mail and/or news reader) via nntp
-respectively POP3 or IMAP. It also includes a smtp
+respectively POP3 or IMAP@. It also includes a smtp
server for receiving mails from Gnus.
@node FAQ 7-2
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 e.g. Forte Agent. If you want to use
+newsreaders like Forte Agent. If you want to use
the Agent place the following in ~/.gnus.el if you are
still using 5.8.8 or 5.9 (it's the default since 5.10):
@menu
* FAQ 8-1:: How to find information and help inside Emacs?
-* FAQ 8-2:: I can't find anything in the Gnus manual about X (e.g.
+* FAQ 8-2:: I can't find anything in the Gnus manual about X (e.g.,
attachments, PGP, MIME...), is it not documented?
* FAQ 8-3:: Which websites should I know?
* FAQ 8-4:: Which mailing lists and newsgroups are there?
@subsubheading Question 8.2
I can't find anything in the Gnus manual about X
-(e.g. attachments, PGP, MIME...), is it not documented?
+(e.g., attachments, PGP, MIME...), is it not documented?
@subsubheading Answer
You can change that format to whatever you want by fiddling with the
@code{gnus-group-line-format} variable. This variable works along the
lines of a @code{format} specification, which is pretty much the same as
-a @code{printf} specifications, for those of you who use (feh!) C.
+a @code{printf} specifications, for those of you who use (feh!) C@.
@xref{Formatting Variables}.
@samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
reasons of efficiency.
It is recommended that you keep all your mail groups (if any) on quite
-low levels (e.g. 1 or 2).
+low levels (e.g., 1 or 2).
Maybe the following description of the default behavior of Gnus helps to
understand what these levels are all about. By default, Gnus shows you
use this level as the ``work'' level.
@vindex gnus-activate-level
-Gnus will normally just activate (i. e., query the server about) groups
+Gnus will normally just activate (i.e., query the server about) groups
on level @code{gnus-activate-level} or less. If you don't want to
activate unsubscribed groups, for instance, you might set this variable
to 5. The default is 6.
@kindex G R (Group)
@findex gnus-group-make-rss-group
Make a group based on an @acronym{RSS} feed
-(@code{gnus-group-make-rss-group}). You will be prompted for an URL.
+(@code{gnus-group-make-rss-group}). You will be prompted for an URL@.
@xref{RSS}.
@item G DEL
@findex gnus-read-ephemeral-gmane-group-url
This command is similar to @code{gnus-read-ephemeral-gmane-group}, but
the group name and the article number and range are constructed from a
-given @acronym{URL}. Supported @acronym{URL} formats include e.g.
+given @acronym{URL}. Supported @acronym{URL} formats include:
@url{http://thread.gmane.org/gmane.foo.bar/12300/focus=12399},
@url{http://thread.gmane.org/gmane.foo.bar/12345/},
@url{http://article.gmane.org/gmane.foo.bar/12345/},
@vindex gnus-list-identifiers
A use for this feature is to remove a mailing list identifier tag in
-the subject fields of articles. E.g. if the news group
+the subject fields of articles. E.g., if the news group
@example
nntp+news.gnus.org:gmane.text.docbook.apps
to include extra headers when generating overview (@acronym{NOV}) files.
If you have old overview files, you should regenerate them after
changing this variable, by entering the server buffer using @kbd{^},
-and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
+and then @kbd{g} on the appropriate mail server (e.g., nnml) to cause
regeneration.
@vindex gnus-summary-line-format
using the default @code{gnus-thread-sort-by-number}, responses can end
up appearing before the article to which they are responding to.
Setting this variable to an alternate value
-(e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
-appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
+(e.g., @code{gnus-thread-sort-by-date}), in a group's parameters or in an
+appropriate hook (e.g., @code{gnus-summary-generate-hook}) can produce a
more logical sub-thread ordering in such instances.
@end table
@item gnus-summary-save-in-pipe
@findex gnus-summary-save-in-pipe
Pipe the article to a shell command. This function takes optional two
-arguments COMMAND and RAW. Valid values for COMMAND include:
+arguments COMMAND and RAW@. Valid values for COMMAND include:
@itemize @bullet
@item a string@*
(Typically offensive jokes and such.)
It's commonly called ``rot13'' because each letter is rotated 13
-positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
+positions in the alphabet, e.g., @samp{B} (letter #2) -> @samp{O} (letter
#15). It is sometimes referred to as ``Caesar rotate'' because Caesar
is rumored to have employed this form of, uh, somewhat weak encryption.
@item W c
@kindex W c (Summary)
@findex gnus-article-remove-cr
-Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
+Translate CRLF pairs (i.e., @samp{^M}s on the end of the lines) into LF
(this takes care of DOS line endings), and then translate any remaining
CRs into LF (this takes care of Mac line endings)
(@code{gnus-article-remove-cr}).
@item W D m
@kindex W D m (Summary)
@findex gnus-treat-mail-picon
-Piconify all mail headers (i. e., @code{Cc}, @code{To})
+Piconify all mail headers (i.e., @code{Cc}, @code{To})
(@code{gnus-treat-mail-picon}).
@item W D n
@kindex W D n (Summary)
@findex gnus-treat-newsgroups-picon
-Piconify all news headers (i. e., @code{Newsgroups} and
+Piconify all news headers (i.e., @code{Newsgroups} and
@code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
@item W D g
@item W D h
@kindex W D h (Summary)
@findex gnus-treat-mail-gravatar
-Gravatarify all mail headers (i. e., @code{Cc}, @code{To})
+Gravatarify all mail headers (i.e., @code{Cc}, @code{To})
(@code{gnus-treat-from-gravatar}).
@item W D D
This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
is @code{nil}.
-To see e.g. security buttons but no other buttons, you could set this
+E.g., to see security buttons but no other buttons, you could set this
variable to @code{("multipart/signed")} and leave
@code{gnus-unbuttonized-mime-types} at the default value.
@vindex gnus-article-mime-part-function
For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
handle as the parameter. The function is meant to be used to allow
-users to gather information from the article (e. g., add Vcard info to
-the bbdb database) or to do actions based on parts (e. g., automatically
+users to gather information from the article (e.g., add Vcard info to
+the bbdb database) or to do actions based on parts (e.g., automatically
save all jpegs into some directory).
Here's an example function the does the latter:
faster. Of course, it'll make group entry somewhat slow.
@vindex gnus-refer-thread-limit
-The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
+The @code{gnus-refer-thread-limit} variable says how many old (i.e.,
articles before the first displayed in the current group) headers to
fetch when doing this command. The default is 200. If @code{t}, all
the available headers will be fetched. This variable can be overridden
@enumerate
@item
To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
-install an OpenPGP implementation such as GnuPG. The Lisp interface
+install an OpenPGP implementation such as GnuPG@. The Lisp interface
to GnuPG included with Emacs is called EasyPG (@pxref{Top, ,EasyPG,
epa, EasyPG Assistant user's manual}), but PGG (@pxref{Top, ,PGG, pgg,
PGG Manual}), and Mailcrypt are also supported.
@item
-To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
+To handle @acronym{S/MIME} message, you need to install OpenSSL@. OpenSSL 0.9.6
or newer is recommended.
@end enumerate
@item gnus-html-frame-width
@vindex gnus-html-frame-width
-The width to use when rendering HTML. The default is 70.
+The width to use when rendering HTML@. The default is 70.
@item gnus-max-image-proportion
@vindex gnus-max-image-proportion
@item p
Displayed when article is digitally signed or encrypted, and Gnus has
hidden the security headers. (N.B. does not tell anything about
-security status, i.e. good or bad signature.)
+security status, i.e., good or bad signature.)
@item s
Displayed when the signature has been hidden in the Article buffer.
contains the message including the message header. Changes made to
the message will only affect the Gcc copy, but not the original
message. You can use these hooks to edit the copy (and influence
-subsequent transformations), e.g. remove MML secure tags
+subsequent transformations), e.g., remove MML secure tags
(@pxref{Signing and encrypting}).
@end table
A foreign group (or any group, really) is specified by a @dfn{name} and
a @dfn{select method}. To take the latter first, a select method is a
-list where the first element says what back end to use (e.g. @code{nntp},
+list where the first element says what back end to use (e.g., @code{nntp},
@code{nnspool}, @code{nnml}) and the second element is the @dfn{server
name}. There may be additional elements in the select method, where the
value may have special meaning for the back end in question.
@subsection Servers and Methods
Wherever you would normally use a select method
-(e.g. @code{gnus-secondary-select-method}, in the group select method,
+(e.g., @code{gnus-secondary-select-method}, in the group select method,
when browsing a foreign server) you can use a virtual server name
instead. This could potentially save lots of typing. And it's nice all
over.
(add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
@end lisp
-Note that not all servers support the recommended ID. This works for
+Note that not all servers support the recommended ID@. This works for
INN versions 2.3.0 and later, for instance.
@item nntp-server-list-active-group
@cindex reading mail
@cindex mail
-Reading mail with a newsreader---isn't that just plain WeIrD? But of
+Reading mail with a newsreader---isn't that just plain WeIrD@? But of
course.
@menu
@env{MAILHOST} environment variable.
@item :port
-The port number of the @acronym{POP} server. This can be a number (eg,
-@samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
+The port number of the @acronym{POP} server. This can be a number (e.g.,
+@samp{:port 1234}) or a string (e.g., @samp{:port "pop3"}). If it is a
string, it should be a service name as listed in @file{/etc/services} on
Unix systems. The default is @samp{"pop3"}. On some systems you might
need to specify it as @samp{"pop-3"} instead.
@item imap
Get mail from a @acronym{IMAP} server. If you don't want to use
-@acronym{IMAP} as intended, as a network mail reading protocol (ie
+@acronym{IMAP} as intended, as a network mail reading protocol (i.e.,
with nnimap), for some reason or other, Gnus let you treat it similar
to a @acronym{POP} server and fetches articles from a given
@acronym{IMAP} mailbox. @xref{Using IMAP}, for more information.
lowercase of the matched string should be used for the substitution.
Setting it as non-@code{nil} is useful to avoid the creation of multiple
groups when users send to an address using different case
-(i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value
+(i.e., mailing-list@@domain vs Mailing-List@@Domain). The default value
is @code{t}.
@findex nnmail-split-fancy-with-parent
@c @findex nnmail-fix-eudora-headers
@cindex Eudora
@cindex Pegasus
-Some mail user agents (e.g. Eudora and Pegasus) produce broken
+Some mail user agents (e.g., Eudora and Pegasus) produce broken
@code{References} headers, but correct @code{In-Reply-To} headers. This
function will get rid of the @code{References} header if the headers
contain a line matching the regular expression
@acronym{RSS} is a format for summarizing headlines from news related
sites (such as BBC or CNN). But basically anything list-like can be
presented as an @acronym{RSS} feed: weblogs, changelogs or recent
-changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
+changes to a wiki (e.g., @url{http://cliki.net/recent-changes.rdf}).
@acronym{RSS} has a quite regular and nice interface, and it's
possible to get the information Gnus needs to keep groups updated.
@item nnrss-ignore-article-fields
@vindex nnrss-ignore-article-fields
Some feeds update constantly article fields during their publications,
-e.g. to indicate the number of comments. However, if there is
+e.g., to indicate the number of comments. However, if there is
a difference between the local article and the distant one, the latter
is considered to be new. To avoid this and discard some fields, set this
variable to the list of fields to be ignored. The default is
@code{nneething} does this in a two-step process. First, it snoops each
file in question. If the file looks like an article (i.e., the first
few lines look like headers), it will use this as the head. If this is
-just some arbitrary file without a head (e.g. a C source file),
+just some arbitrary file without a head (e.g., a C source file),
@code{nneething} will cobble up a header out of thin air. It will use
file ownership, name and date and do whatever it can with these
elements.
@defvar nndiary-reminders
This is the list of times when you want to be reminded of your
-appointments (e.g. 3 weeks before, then 2 days before, then 1 hour
+appointments (e.g., 3 weeks before, then 2 days before, then 1 hour
before and that's it). Remember that ``being reminded'' means that the
diary message will pop up as brand new and unread again when you get new
mail.
@code{gnus-diary} provides two supplemental user formats to be used in
summary line formats. @code{D} corresponds to a formatted time string
-for the next occurrence of the event (e.g. ``Sat, Sep 22 01, 12:00''),
+for the next occurrence of the event (e.g., ``Sat, Sep 22 01, 12:00''),
while @code{d} corresponds to an approximate remaining time until the
-next occurrence of the event (e.g. ``in 6 months, 1 week'').
+next occurrence of the event (e.g., ``in 6 months, 1 week'').
For example, here's how Joe's birthday is displayed in my
@code{nndiary+diary:birthdays} summary buffer (note that the message is
useful values.
For example, you could decide that you don't want to download articles
-that were posted more than a certain number of days ago (e.g. posted
+that were posted more than a certain number of days ago (e.g., posted
more than @code{gnus-agent-expire-days} ago) you might write a function
something along the lines of the following:
@item gnus-agent-cache
@vindex gnus-agent-cache
Variable to control whether use the locally stored @acronym{NOV} and
-articles when plugged, e.g. essentially using the Agent as a cache.
+articles when plugged, e.g., essentially using the Agent as a cache.
The default is non-@code{nil}, which means to use the Agent as a cache.
@item gnus-agent-go-online
The current score file is by default the group's local score file, even
if no such score file actually exists. To insert score commands into
-some other score file (e.g. @file{all.SCORE}), you must first make this
+some other score file (e.g., @file{all.SCORE}), you must first make this
score file the current one.
General score commands that don't actually change the score file:
This match key is somewhat special, in that it will match the
@code{From} header, and affect the score of not only the matching
articles, but also all followups to the matching articles. This allows
-you e.g. increase the score of followups to your own articles, or
+you to increase the score of followups to your own articles, or
decrease the score of followups to the articles of some known
trouble-maker. Uses the same match types as the @code{From} header
uses. (Using this match key will lead to creation of @file{ADAPT}
rest. Next time you enter the group, you will see new articles in the
interesting threads, plus any new threads.
-I.e.---the orphan score atom is for high-volume groups where a few
+I.e., the orphan score atom is for high-volume groups where a few
interesting threads which can't be found automatically by ordinary
scoring rules exist.
non-@code{nil}, Gnus will run the score files through the decaying
mechanism thereby lowering the scores of all non-permanent score rules.
If @code{gnus-decay-scores} is a regexp, only score files matching this
-regexp are treated. E.g. you may set it to @samp{\\.ADAPT\\'} if only
+regexp are treated. E.g., you may set it to @samp{\\.ADAPT\\'} if only
@emph{adaptive} score files should be decayed. The decay itself if
performed by the @code{gnus-decay-score-function} function, which is
@code{gnus-decay-score} by default. Here's the definition of that
@item Boolean query operators
AND, OR, and NOT are supported, and parentheses can be used to control
-operator precedence, e.g. (emacs OR xemacs) AND linux. Note that
+operator precedence, e.g., (emacs OR xemacs) AND linux. Note that
operators must be written with all capital letters to be
recognized. Also preceding a term with a - sign is equivalent to NOT
term.
@table @samp
@item Boolean query operators
AND, OR, NOT (or AND NOT), and XOR are supported, and brackets can be
-used to control operator precedence, e.g. (emacs OR xemacs) AND linux.
+used to control operator precedence, e.g., (emacs OR xemacs) AND linux.
Note that operators must be written with all capital letters to be
recognized.
@item Required and excluded terms
-+ and - can be used to require or exclude terms, e.g. football -american
++ and - can be used to require or exclude terms, e.g., football -american
@item Unicode handling
The search engine converts all text to utf-8, so searching should work
@item Stopwords
Common English words (like 'the' and 'a') are ignored by default. You
-can override this by prefixing such words with a + (e.g. +the) or
-enclosing the word in quotes (e.g. "the").
+can override this by prefixing such words with a + (e.g., +the) or
+enclosing the word in quotes (e.g., "the").
@end table
@end menu
@c FIXME: The markup in this section might need improvement.
-@c E.g. adding @samp, @var, @file, @command, etc.
+@c E.g., adding @samp, @var, @file, @command, etc.
@c Cf. (info "(texinfo)Indicating")
@node About mairix
Mairix is a tool for indexing and searching words in locally stored
mail. It was written by Richard Curnow and is licensed under the
-GPL. Mairix comes with most popular GNU/Linux distributions, but it also
+GPL@. Mairix comes with most popular GNU/Linux distributions, but it also
runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can
be found at
@uref{http://www.rpcurnow.force9.co.uk/mairix/index.html}
Mairix searches local mail---that means, mairix absolutely must have
direct access to your mail folders. If your mail resides on another
-server (e.g. an @acronym{IMAP} server) and you happen to have shell
-access, @code{nnmairix} supports running mairix remotely, e.g. via ssh.
+server (e.g., an @acronym{IMAP} server) and you happen to have shell
+access, @code{nnmairix} supports running mairix remotely, e.g., via ssh.
Additionally, @code{nnmairix} only supports the following Gnus back
ends: @code{nnml}, @code{nnmaildir}, and @code{nnimap}. You must use
The back end @code{nnmairix} enables you to call mairix from within Gnus,
either to query mairix with a search term or to update the
database. While visiting a message in the summary buffer, you can use
-several pre-defined shortcuts for calling mairix, e.g. to quickly
+several pre-defined shortcuts for calling mairix, e.g., to quickly
search for all mails from the sender of the current message or to
display the whole thread associated with the message, even if the
mails are in different folders.
Additionally, you can create permanent @code{nnmairix} groups which are bound
to certain mairix searches. This way, you can easily create a group
containing mails from a certain sender, with a certain subject line or
-even for one specific thread based on the Message-ID. If you check for
-new mail in these folders (e.g. by pressing @kbd{g} or @kbd{M-g}), they
+even for one specific thread based on the Message-ID@. If you check for
+new mail in these folders (e.g., by pressing @kbd{g} or @kbd{M-g}), they
automatically update themselves by calling mairix.
You might ask why you need @code{nnmairix} at all, since mairix already
strange article counts, and sometimes you might see mails which Gnus
claims have already been canceled and are inaccessible. This is due to
the fact that Gnus isn't really amused when things are happening behind
-its back. Another problem can be the mail back end itself, e.g. if you
+its back. Another problem can be the mail back end itself, e.g., if you
use mairix with an @acronym{IMAP} server (I had Dovecot complaining
about corrupt index files when mairix changed the contents of the search
group). Using @code{nnmairix} should circumvent these problems.
present these folders in the Gnus front end only with @code{<NAME>}.
You can use an existing mail back end where you already store your mail,
but if you're uncomfortable with @code{nnmairix} creating new mail
-groups alongside your other mail, you can also create e.g. a new
+groups alongside your other mail, you can also create, e.g., a new
@code{nnmaildir} or @code{nnml} server exclusively for mairix, but then
make sure those servers do not accidentally receive your new mail
(@pxref{nnmairix caveats}). A special case exists if you want to use
which are accessed through @code{nnmaildir}, @code{nnimap} and
@code{nnml} are supported. As explained above, for locally stored
mails, this can be an existing server where you store your mails.
-However, you can also create e.g. a new @code{nnmaildir} or @code{nnml}
+However, you can also create, e.g., a new @code{nnmaildir} or @code{nnml}
server exclusively for @code{nnmairix} in your secondary select methods
(@pxref{Finding the News}). If you use a secondary @code{nnml} server
just for mairix, make sure that you explicitly set the server variable
@vindex nnmairix-mairix-search-options
The @strong{command} to call the mairix binary. This will usually just
be @code{mairix}, but you can also choose something like @code{ssh
-SERVER mairix} if you want to call mairix remotely, e.g. on your
+SERVER mairix} if you want to call mairix remotely, e.g., on your
@acronym{IMAP} server. If you want to add some default options to
mairix, you could do this here, but better use the variable
@code{nnmairix-mairix-search-options} instead.
@item
The name of the @strong{default search group}. This will be the group
-where all temporary mairix searches are stored, i.e. all searches which
+where all temporary mairix searches are stored, i.e., all searches which
are not bound to permanent @code{nnmairix} groups. Choose whatever you
like.
@item
If the mail back end is @code{nnimap} or @code{nnmaildir}, you will be
-asked if you work with @strong{Maildir++}, i.e. with hidden maildir
+asked if you work with @strong{Maildir++}, i.e., with hidden maildir
folders (=beginning with a dot). For example, you have to answer
@samp{yes} here if you work with the Dovecot @acronym{IMAP}
server. Otherwise, you should answer @samp{no} here.
@kindex G b t (Group)
@findex nnmairix-group-toggle-threads-this-group
Toggles the 'threads' parameter for the @code{nnmairix} group under cursor,
-i.e. if you want see the whole threads of the found messages
+i.e., if you want see the whole threads of the found messages
(@code{nnmairix-group-toggle-threads-this-group}).
@item G b u
@kindex $ o (Summary)
@findex nnmairix-goto-original-article
(Only in @code{nnmairix} groups!) Tries determine the group this article
-originally came from and displays the article in this group, so that
-e.g. replying to this article the correct posting styles/group
+originally came from and displays the article in this group, so that,
+e.g., replying to this article the correct posting styles/group
parameters are applied (@code{nnmairix-goto-original-article}). This
function will use the registry if available, but can also parse the
article file name as a fallback method.
marks this way, it might take some time. You can avoid this situation by
setting @code{nnmairix-only-use-registry} to t.
-Maybe you also want to propagate marks the other way round, i.e. if you
+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
article in a @code{nnmairix} group ticked, too. For several good
reasons, this can only be done efficiently if you use maildir. To
For example, you can create a group for all ticked articles, where the
articles always stay unread:
-Hit @kbd{G b g}, enter group name (e.g. @samp{important}), use
+Hit @kbd{G b g}, enter group name (e.g., @samp{important}), use
@samp{F:f} as query and do not include threads.
Now activate marks propagation for this group by using @kbd{G b p}. Then
@code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above
comments about this option. If it works for you, the tick marks should
also exist in the @code{nnmairix} group and you can remove them as usual,
-e.g. by marking an article as read.
+e.g., by marking an article as read.
When you have removed a tick mark from the original article, this
article should vanish from the @code{nnmairix} group after you have updated the
see them when you enter the back end server in the server buffer. You
should not subscribe these groups! Unfortunately, these groups will
usually get @emph{auto-subscribed} when you use @code{nnmaildir} or
-@code{nnml}, i.e. you will suddenly see groups of the form
+@code{nnml}, i.e., you will suddenly see groups of the form
@samp{zz_mairix*} pop up in your group buffer. If this happens to you,
simply kill these groups with C-k. For avoiding this, turn off
auto-subscription completely by setting the variable
Point will be put in the buffer that has the optional third element
@code{point}. In a @code{frame} split, the last subsplit having a leaf
-split where the tag @code{frame-focus} is a member (i.e. is the third or
+split where the tag @code{frame-focus} is a member (i.e., is the third or
fourth element in the list, depending on whether the @code{point} tag is
present) gets focus.
@vindex gnus-mode-non-string-length
By default, Gnus displays information on the current article in the mode
lines of the summary and article buffers. The information Gnus wishes
-to display (e.g. the subject of the article) is often longer than the
+to display (e.g., the subject of the article) is often longer than the
mode lines, and therefore have to be cut off at some point. The
@code{gnus-mode-non-string-length} variable says how long the other
elements on the line is (i.e., the non-info part). If you put
-additional elements on the mode line (e.g. a clock), you should modify
+additional elements on the mode line (e.g., a clock), you should modify
this variable:
@c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
@end lisp
Once you manage to process your incoming spool somehow, thus making
-the mail contain e.g.@: a header indicating it is spam, you are ready to
+the mail contain, e.g., a header indicating it is spam, you are ready to
filter it out. Using normal split methods (@pxref{Splitting Mail}):
@lisp
My provider has set up bogofilter (in combination with @acronym{DCC}) on
the mail server (@acronym{IMAP}). Recognized spam goes to
@samp{spam.detected}, the rest goes through the normal filter rules,
-i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
+i.e., to @samp{some.folder} or to @samp{INBOX}. Training on false
positives or negatives is done by copying or moving the article to
@samp{training.ham} or @samp{training.spam} respectively. A cron job on
the server feeds those to bogofilter with the suitable ham or spam
@item @b{The Spam folder:}
In the folder @samp{spam.detected}, I have to check for false positives
-(i.e. legitimate mails, that were wrongly judged as spam by
+(i.e., legitimate mails, that were wrongly judged as spam by
bogofilter or DCC).
Because of the @code{gnus-group-spam-classification-spam} entry, all
The @code{gnus-article-sort-by-chars} entry simplifies detection of
false positives for me. I receive lots of worms (sweN, @dots{}), that all
-have a similar size. Grouping them by size (i.e. chars) makes finding
+have a similar size. Grouping them by size (i.e., chars) makes finding
other false positives easier. (Of course worms aren't @i{spam}
(@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
an excellent tool for filtering those unwanted mails for me.)
Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
because I don't read the groups directly from news.gmane.org, but
-through my local news server (leafnode). I.e. the article numbers are
+through my local news server (leafnode). I.e., the article numbers are
not the same as on news.gmane.org, thus @code{spam-report.el} has to check
the @code{X-Report-Spam} header to find the correct number.
Set this variable to @code{t} if you want to use the BBDB as an
implicit filter, meaning that every message will be considered spam
-unless the sender is in the BBDB. Use with care. Only sender
+unless the sender is in the BBDB@. Use with care. Only sender
addresses in the BBDB will be allowed through; all others will be
classified as spammers.
@defvar spam-spamoracle-binary
Gnus uses the SpamOracle binary called @file{spamoracle} found in the
-user's PATH. Using the variable @code{spam-spamoracle-binary}, this
+user's PATH@. Using the variable @code{spam-spamoracle-binary}, this
can be customized.
@end defvar
@end example
For this group the @code{spam-use-spamoracle} is installed for both
ham and spam processing. If the group contains spam message
-(e.g. because SpamOracle has not had enough sample messages yet) and
+(e.g., because SpamOracle has not had enough sample messages yet) and
the user marks some messages as spam messages, these messages will be
processed by SpamOracle. The processor sends the messages to
SpamOracle as new samples for spam.
Split messages to their parent
This keeps discussions in the same group. You can use the subject and
-the sender in addition to the Message-ID. Several strategies are
+the sender in addition to the Message-ID@. Several strategies are
available.
@item
@cindex RFC 1991
@cindex RFC 2440
RFC 1991 is the original @acronym{PGP} message specification,
-published as an informational RFC. RFC 2440 was the follow-up, now
+published as an informational RFC@. RFC 2440 was the follow-up, now
called Open PGP, and put on the Standards Track. Both document a
non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
encoding (signing and encryption) and decoding (verification and
values.
@item
-@code{gnus-summary-goto-article} now accept Message-ID's.
+@code{gnus-summary-goto-article} now accept Message-IDs.
@item
A new Message command for deleting text in the body of a message
This makes it possible to take backup of nnml/nnfolder servers/groups
separately of @file{~/.newsrc.eld}, while preserving marks. It also
makes it possible to share articles and marks between users (without
-sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
+sharing the @file{~/.newsrc.eld} file) within, e.g., a department. It
works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
slow, and then try to analyze the backtrace (repeating the procedure
helps isolating the real problem areas).
-A fancier approach is to use the elisp profiler, ELP. The profiler is
+A fancier approach is to use the elisp profiler, ELP@. The profiler is
(or should be) fully documented elsewhere, but to get you started
there are a few steps that need to be followed. First, instrument the
-part of Gnus you are interested in for profiling, e.g. @kbd{M-x
+part of Gnus you are interested in for profiling, e.g., @kbd{M-x
elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
RET message}. Then perform the operation that is slow and press
@kbd{M-x elp-results}. You will then see which operations that takes
@section Lesson I: Development Cycle
The purpose of this tutorial is to guide you through a very basic
-development cycle using IDLWAVE. We will paste a simple program into
+development cycle using IDLWAVE@. We will paste a simple program into
a buffer and use the shell to compile, debug and run it. On the way
we will use many of the important IDLWAVE commands. Note, however,
that IDLWAVE has many more capabilities than covered here, which can
highlighted in different colors, if you have set up support for
font-lock.
-Let's check out two particular editing features of IDLWAVE. Place the
+Let's check out two particular editing features of IDLWAVE@. Place the
cursor after the @code{end} statement of the @code{for} loop and press
@key{SPC}. IDLWAVE blinks back to the beginning of the block and
changes the generic @code{end} to the specific @code{endfor}
@kbd{C-c C-s}. The Emacs window will split or another window will popup
to display IDL running in a shell interaction buffer. Type a few
commands like @code{print,!PI} to convince yourself that you can work
-there just as well as in a terminal, or the IDLDE. Use the arrow keys
+there just as well as in a terminal, or the IDLDE@. Use the arrow keys
to cycle through your command history. Are we having fun now?
Now go back to the source window and type @kbd{C-c C-d C-c} to compile
variables. You can access it through the IDLWAVE menu in one of the
@file{.pro} buffers, menu item @code{Customize->Browse IDLWAVE
Group}. Here you'll be presented with all the various variables grouped
-into categories. You can navigate the hierarchy (e.g. @samp{IDLWAVE
+into categories. You can navigate the hierarchy (e.g., @samp{IDLWAVE
Code Formatting->Idlwave Abbrev And Indent Action->Idlwave Expand
Generic End} to turn on @code{END} expansion), read about the variables,
change them, and `Save for Future Sessions'. Few of these variables
every IDL routine on your search path. All this information is
written to the file @file{.idlwave/idlusercat.el} in your home
directory and will from now on automatically load whenever you use
-IDLWAVE. You may find it necessary to rebuild the catalog on occasion
+IDLWAVE@. You may find it necessary to rebuild the catalog on occasion
as your local libraries change, or build a library catalog for those
directories instead. Invoke routine info (@kbd{C-c ?}) or completion
(@kbd{M-@key{TAB}}) on any routine or partial routine name you know to
...
@end example
-I hope you made it until here. Now you are set to work with IDLWAVE.
+I hope you made it until here. Now you are set to work with IDLWAVE@.
On the way you will want to change other things, and to learn more
about the possibilities not discussed in this short tutorial. Read
the manual, look at the documentation strings of interesting variables
@cindex Foreign code, adapting
@cindex Indentation, of foreign code
@kindex C-M-\
-To re-indent a larger portion of code (e.g. when working with foreign
+To re-indent a larger portion of code (e.g., when working with foreign
code written with different conventions), use @kbd{C-M-\}
(@code{indent-region}) after marking the relevant code. Useful marking
commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current
@end example
@noindent This simultaneously solves the font-lock problem and is more
-consistent with the notation for hexadecimal numbers, e.g. @code{'C5'XB}.
+consistent with the notation for hexadecimal numbers, e.g., @code{'C5'XB}.
@node Routine Info, Online Help, Code Formatting, The IDLWAVE Major Mode
@section Routine Info
object, unless the class is already known through a text property on the
@samp{->} operator (@pxref{Object Method Completion and Class
Ambiguity}), or by having been explicitly included in the call
-(e.g. @code{a->myclass::Foo}).
+(e.g., @code{a->myclass::Foo}).
@cindex Calling sequences
@cindex Keywords of a routine
Any routines discovered in library catalogs (@pxref{Library
Catalogs}), will display the category assigned during creation,
-e.g. @samp{NasaLib}. For routines not discovered in this way, you can
+e.g., @samp{NasaLib}. For routines not discovered in this way, you can
create additional categories based on the routine's filename using the
variable @code{idlwave-special-lib-alist}.
@cindex Speed, of online help
@cindex XML Help Catalog
-For IDL system routines, extensive documentation is supplied with IDL.
+For IDL system routines, extensive documentation is supplied with IDL@.
IDLWAVE can access the HTML version of this documentation very quickly
and accurately, based on the local context. This can be @emph{much}
faster than using the IDL online help application, because IDLWAVE
usually gets you to the right place in the documentation directly ---
-e.g. a specific keyword of a routine --- without any additional browsing
+e.g., a specific keyword of a routine --- without any additional browsing
and scrolling.
For this online help to work, an HTML version of the IDL documentation
with possible completions, clicking with @kbd{Mouse-3} on a completion
item invokes help on that item (@pxref{Completion}). Items for which
help is available in the online system documentation (vs. just the
-program source itself) will be emphasized (e.g. colored blue).
+program source itself) will be emphasized (e.g., colored blue).
@end itemize
@noindent
In both cases, a blue face indicates that the item is documented in
@defopt idlwave-help-doclib-name (@code{"name"})
The case-insensitive heading word in doclib headers to locate the
-@emph{name} section. Can be a regexp, e.g. @code{"\\(name\\|nom\\)"}.
+@emph{name} section. Can be a regexp, e.g., @code{"\\(name\\|nom\\)"}.
@end defopt
@defopt idlwave-help-doclib-keyword (@code{"KEYWORD"})
@kbd{M-@key{TAB}} repeatedly. Online help (if installed) for each
possible completion is available by clicking with @kbd{Mouse-3} on the
item. Items for which system online help (from the IDL manual) is
-available will be emphasized (e.g. colored blue). For other items, the
+available will be emphasized (e.g., colored blue). For other items, the
corresponding source code or DocLib header will be used as the help
text.
@code{idlwave-query-class} can be configured to make such prompting the
default for all methods (not recommended), or selectively for very
common methods for which the number of completing keywords would be too
-large (e.g. @code{Init,SetProperty,GetProperty}).
+large (e.g., @code{Init,SetProperty,GetProperty}).
@cindex Saving object class on @code{->}
@cindex @code{->}
-After you have specified the class for a particular statement (e.g. when
+After you have specified the class for a particular statement (e.g., when
completing the method), IDLWAVE can remember it for the rest of the
editing session. Subsequent completions in the same statement
-(e.g. keywords) can then reuse this class information. This works by
+(e.g., keywords) can then reuse this class information. This works by
placing a text property on the method invocation operator @samp{->},
after which the operator will be shown in a different face (bold by
default). The variable @code{idlwave-store-inquired-class} can be used
@cindex Keyword inheritance
@cindex Inheritance, keyword
-Class inheritance affects which methods are called in IDL. An object of
+Class inheritance affects which methods are called in IDL@. An object of
a class which inherits methods from one or more superclasses can
override that method by defining its own method of the same name, extend
the method by calling the method(s) of its superclass(es) in its
@cindex Structure tag completion
In many programs, especially those involving widgets, large structures
-(e.g. the @samp{state} structure) are used to communicate among
+(e.g., the @samp{state} structure) are used to communicate among
routines. It is very convenient to be able to complete structure tags,
in the same way as for instance variables (tags) of the @samp{self}
object (@pxref{Object Method Completion and Class Ambiguity}). Add-in
the structure in all parts of the program. This is entirely unenforced
by the IDL language, but is a typical convention. If you consistently
refer to the same structure with the same variable name
-(e.g. @samp{state}), structure tags which are read from its definition
+(e.g., @samp{state}), structure tags which are read from its definition
in the same file can be used for completion.
Structure tag completion is not enabled by default. To enable it,
@end defopt
@defopt idlwave-abbrev-move (@code{t})
-Non-@code{nil} means the abbrev hook can move point, e.g. to end up
+Non-@code{nil} means the abbrev hook can move point, e.g., to end up
between the parentheses of a function call.
@end defopt
@item
@cindex Foreign code, adapting
@cindex Actions, applied to foreign code
-Actions can also be applied to a larger piece of code, e.g. to convert
+Actions can also be applied to a larger piece of code, e.g., to convert
foreign code to your own style. To do this, mark the relevant part of
the code and execute @kbd{M-x expand-region-abbrevs}. Useful marking
commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current
Note that the modified assignment operators which begin with a word
(@samp{AND=}, @samp{OR=}, @samp{NOT=}, etc.) require a leading space to
be recognized (e.g @code{vAND=4} would be interpreted as a variable
-@code{vAND}). Also note that, since e.g., @code{>} and @code{>=} are
+@code{vAND}). Also note that since, e.g., @code{>} and @code{>=} are
both valid operators, it is impossible to surround both by blanks while
they are being typed. Similarly with @code{&} and @code{&&}. For
these, a compromise is made: the padding is placed on the left, and if
@cindex Spells, magic
IDLWAVE works in line input mode: You compose a full command line, using
all the power Emacs gives you to do this. When you press @key{RET}, the
-whole line is sent to IDL. Sometimes it is necessary to send single
+whole line is sent to IDL@. Sometimes it is necessary to send single
characters (without a newline), for example when an IDL program is
waiting for single character input with the @code{GET_KBRD} function.
You can send a single character to IDL with the command @kbd{C-c C-x}
(@code{idlwave-shell-send-char}). When you press @kbd{C-c C-y}
(@code{idlwave-shell-char-mode-loop}), IDLWAVE runs a blocking loop
-which accepts characters and immediately sends them to IDL. The loop
+which accepts characters and immediately sends them to IDL@. The loop
can be exited with @kbd{C-g}. It terminates also automatically when the
current IDL command is finished. Check the documentation of the two
variables described below for a way to make IDL programs trigger
@end lisp
@noindent a breakpoint can then be set by pressing @kbd{b} while holding down
-@kbd{shift} and @kbd{control} keys, i.e. @kbd{C-S-b}. Compiling a
+@kbd{shift} and @kbd{control} keys, i.e., @kbd{C-S-b}. Compiling a
source file will be on @kbd{C-S-c}, deleting a breakpoint @kbd{C-S-d},
etc. In the remainder of this chapter we will assume that the
@kbd{C-c C-d} bindings are active, but each of these bindings will
IDLWAVE helps you set breakpoints and step through code. Setting a
breakpoint in the current line of the source buffer is accomplished
with @kbd{C-c C-d C-b} (@code{idlwave-shell-break-here}). With a
-prefix arg of 1 (i.e. @kbd{C-1 C-c C-d C-b}), the breakpoint gets a
+prefix arg of 1 (i.e., @kbd{C-1 C-c C-d C-b}), the breakpoint gets a
@code{/ONCE} keyword, meaning that it will be deleted after first use.
-With a numeric prefix greater than one (e.g. @kbd{C-4 C-c C-d C-b}),
+With a numeric prefix greater than one (e.g., @kbd{C-4 C-c C-d C-b}),
the breakpoint will only be active the @code{nth} time it is hit.
-With a single non-numeric prefix (i.e. @kbd{C-u C-c C-d C-b}), prompt
+With a single non-numeric prefix (i.e., @kbd{C-u C-c C-d C-b}), prompt
for a condition --- an IDL expression to be evaluated and trigger the
breakpoint only if true. To clear the breakpoint in the current line,
use @kbd{C-c C-d C-d} (@code{idlwave-clear-current-bp}). When
Most single-character electric debug bindings use the final keystroke
of the equivalent multiple key commands (which are of course also
-still available), but some differ (e.g. @kbd{e},@kbd{t},@kbd{q},@kbd{x}).
+still available), but some differ (e.g., @kbd{e},@kbd{t},@kbd{q},@kbd{x}).
Some have additional convenience bindings (like @kbd{@key{SPACE}} for
stepping). All prefix and other argument options described in this
section for the commands invoked by electric debug bindings are still
@cindex Mouse binding to print expressions
@kindex C-c C-d C-p
-Do you find yourself repeatedly typing, e.g. @code{print,n_elements(x)},
+Do you find yourself repeatedly typing, e.g., @code{print,n_elements(x)},
and similar statements to remind yourself of the
type/size/structure/value/etc. of variables and expressions in your code
or at the command line? IDLWAVE has a suite of special commands to
For added speed and convenience, there are mouse bindings which allow
you to click on expressions and examine their values. Use
@kbd{S-Mouse-2} to print an expression and @kbd{C-M-Mouse-2} to invoke
-help (i.e. you need to hold down @key{META} and @key{CONTROL} while
+help (i.e., you need to hold down @key{META} and @key{CONTROL} while
clicking with the middle mouse button). If you simply click, the
nearest expression will be selected in the same manner as described
above. You can also @emph{drag} the mouse in order to highlight
@cindex ROUTINE_NAMES, IDL procedure
N.B.: printing values of expressions on higher levels of the calling
stack uses the @emph{unsupported} IDL routine @code{ROUTINE_NAMES},
-which may or may not be available in future versions of IDL. Caveat
+which may or may not be available in future versions of IDL@. Caveat
Examinor.
@end itemize
routines (@pxref{Routine Info}) to other source collections.
Starting with version 5.0, there are two types of catalogs available
-with IDLWAVE. The traditional @emph{user catalog} and the newer
+with IDLWAVE@. The traditional @emph{user catalog} and the newer
@emph{library catalogs}. Although they can be used interchangeably, the
library catalogs are more flexible, and preferred. There are few
occasions when a user catalog might be preferred --- read below. Both
from the shell about the IDL search paths, and can write this
information out automatically, or on-demand (menu @code{Debug->Save Path
Info}). On systems with no shell from which to discover the path
-information (e.g. Windows), a library path must be specified in
+information (e.g., Windows), a library path must be specified in
@code{idlwave-library-path} to allow library catalogs to be located, and
to setup directories for user catalog scan (@pxref{User Catalog} for
more on this variable). Note that, before the shell is running, IDLWAVE
@end defopt
@defopt idlwave-library-path
-IDL library path for Windows and MacOS. Under Unix/MacOSX, will be
+IDL library path for Windows and MacOS@. Under Unix/MacOSX, will be
obtained from the Shell when run.
@end defopt
@defopt idlwave-system-directory
-The IDL system directory for Windows and MacOS. Also needed for
+The IDL system directory for Windows and MacOS@. Also needed for
locating HTML help and the IDL Assistant for IDL v6.2 and later. Under
Unix/MacOSX, will be obtained from the Shell and recorded, if run.
@end defopt
discovered on the IDL search path and loaded automatically when routine
information is read. Each catalog file documents the routines found in
that directory --- one catalog per directory. Every catalog has a
-library name associated with it (e.g. @emph{AstroLib}). This name will
+library name associated with it (e.g., @emph{AstroLib}). This name will
be shown briefly when the catalog is found, and in the routine info of
routines it documents.
Many popular libraries of routines are shipped with IDLWAVE catalog
files by default, and so will be automatically discovered. Library
catalogs are scanned externally to Emacs using a tool provided with
-IDLWAVE. Each catalog can be re-scanned independently of any other.
+IDLWAVE@. Each catalog can be re-scanned independently of any other.
Catalogs can easily be made available system-wide with a common source
repository, providing uniform routine information, and lifting the
burden of scanning from the user (who may not even know they're using a
scanned catalog). Since all catalogs are independent, they can be
-re-scanned automatically to gather updates, e.g. in a @file{cron} job.
+re-scanned automatically to gather updates, e.g., in a @file{cron} job.
Scanning is much faster than with the built-in user catalog method. One
minor disadvantage: the entire IDL search path is scanned for catalog
files every time IDLWAVE starts up, which might be slow if accessing IDL
@item @kbd{M-x idlwave-list-buffer-load-path-shadows}
This command checks the names of all routines defined in the current
buffer for shadowing conflicts with other routines accessible to
-IDLWAVE. The command also has a key binding: @kbd{C-c C-b}
+IDLWAVE@. The command also has a key binding: @kbd{C-c C-b}
@item @kbd{M-x idlwave-list-shell-load-path-shadows}.
Checks all routines compiled under the shell for shadowing. This is
very useful when you have written a complete application. Just compile
@cindex @code{!DIR}, IDL variable
Users of Windows and MacOS (not X) also must set the variable
@code{idlwave-system-directory} to the value of the @code{!DIR} system
-variable in IDL. IDLWAVE appends @file{lib} to the value of this
+variable in IDL@. IDLWAVE appends @file{lib} to the value of this
variable and assumes that all files found on that path are system
routines.
There are a wide variety of possible browsers to use for displaying
the online HTML help available with IDLWAVE (starting with version
5.0). Since IDL v6.2, a single cross-platform HTML help browser, the
-@emph{IDL Assistant} is distributed with IDL. If this help browser is
+@emph{IDL Assistant} is distributed with IDL@. If this help browser is
available, it is the preferred choice, and the default. The variable
@code{idlwave-help-use-assistant}, enabled by default, controls
whether this help browser is used. If you use the IDL Assistant, the
@itemize @minus
@item
-are not self-evident (i.e. too magic) when used by an unsuspecting user.
+are not self-evident (i.e., too magic) when used by an unsuspecting user.
@item
are too intrusive.
@item
However, if you are an Emacs power-user and want IDLWAVE to work
completely differently, you can change almost every aspect of it. Here
-is an example of a much more extensive configuration of IDLWAVE. The
+is an example of a much more extensive configuration of IDLWAVE@. The
user is King!
@example
If you run Emacs directly as an Aqua application, rather than from the
console shell, the environment is set not from your usual shell
-configuration files (e.g. @file{.cshrc}), but from the file
+configuration files (e.g., @file{.cshrc}), but from the file
@file{~/.MacOSX/environment.plist}. Either include your path settings
there, or start Emacs and IDLWAVE from the shell.
cl-builtin-gethash} on completion or routine info.}
This error arises if you upgraded Emacs from 20.x to 21.x without
-re-installing IDLWAVE. Old Emacs and new Emacs are not byte-compatible
+re-installing IDLWAVE@. Old Emacs and new Emacs are not byte-compatible
in compiled lisp files. Presumably, you kept the original .elc files in
place, and this is the source of the error. If you recompile (or just
"make; make install") from source, it should resolve this problem.
The problem is that your Emacs is not finding the version of IDLWAVE you
installed. Many Emacsen come with an older bundled copy of IDLWAVE
-(e.g. v4.7 for Emacs 21.x), which is likely what's being used instead.
+(e.g., v4.7 for Emacs 21.x), which is likely what's being used instead.
You need to make sure your Emacs @emph{load-path} contains the directory
where IDLWAVE is installed (@file{/usr/local/share/emacs/site-lisp}, by
default), @emph{before} Emacs's default search directories. You can
Unfortunately, the HTMLHelp files RSI provides attempt to switch to
@samp{Symbol} font to display Greek characters, which is not really an
-permitted method for doing this in HTML. There is a "workaround" for
+permitted method for doing this in HTML@. There is a "workaround" for
some browsers: @xref{HTML Help Browser Tips}.
@item @strong{In the shell, my long commands are truncated at 256 characters!}
This actually happens when running IDL in an XTerm as well. There are
-a couple of workarounds: @code{define_key,/control,'^d'} (e.g. in
+a couple of workarounds: @code{define_key,/control,'^d'} (e.g., in
your @file{$IDL_STARTUP} file) will disable the @samp{EOF} character
and give you a 512 character limit. You won't be able to use
@key{C-d} to quit the shell, however. Another possibility is
widget events (those with @code{/NO_BLOCK} passed to @code{XManager}).
@item @strong{When I invoke IDL HTML help on a routine, the page which
-is loaded is one page off, e.g. for @code{CONVERT_COORD}, I get
+is loaded is one page off, e.g., for @code{CONVERT_COORD}, I get
@code{CONTOUR}.}
You have a mismatch between your help index and the HTML help package
@end ifinfo
@end ifnottex
-@insertcopying
+@insertcopying
@menu
* Getting Started:: Getting started using an Info reader.
@format
>> If you are in Emacs and have a mouse, and if you already practiced
- typing @kbd{n} to get to the next node, click now with the left
+ typing @kbd{n} to get to the next node, click now with the left
mouse button on the @samp{Next} link to do the same ``the mouse way''.
@end format
we call ``Backspace or DEL'' in this manual is labeled differently on
different keyboards. Look for a key which is a little ways above the
@key{ENTER} or @key{RET} key and which you normally use outside Emacs
-to erase the character before the cursor, i.e.@: the character you
+to erase the character before the cursor, i.e., the character you
typed last. It might be labeled @samp{Backspace} or @samp{<-} or
@samp{DEL}, or sometimes @samp{Delete}.} and @kbd{b} commands exist to
allow you to ``move around'' in a node that does not all fit on the
Mairix is a tool for indexing and searching words in locally stored
mail. It was written by Richard Curnow and is licensed under the
-GPL. Mairix comes with most popular GNU/Linux distributions, but it also
+GPL@. Mairix comes with most popular GNU/Linux distributions, but it also
runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can
be found at
@uref{http://www.rpcurnow.force9.co.uk/mairix/index.html}
@kindex M-x mairix-widget-search-based-on-article
@findex mairix-widget-search-based-on-article
Create a mairix query using graphical widgets, but based on the
-currently displayed article, i.e. the available fields will be filled
+currently displayed article, i.e., the available fields will be filled
with the current header values.
@item mairix-search-from-this-article
the normal methods for determining the To header will be used.
Each list element should be a cons, where the @sc{car} should be the
-name of a header (e.g. @code{Cc}) and the @sc{cdr} should be the header
-value (e.g. @samp{larsi@@ifi.uio.no}). All these headers will be
+name of a header (e.g., @code{Cc}) and the @sc{cdr} should be the header
+value (e.g., @samp{larsi@@ifi.uio.no}). All these headers will be
inserted into the head of the outgoing mail.
@end itemize
-Gnus honors the MFT header in other's messages (i.e. while following
+Gnus honors the MFT header in other's messages (i.e., while following
up to someone else's post) and also provides support for generating
sensible MFT headers for outgoing messages as well.
so on.
The @acronym{S/MIME} support in Message (and @acronym{MML}) require
-OpenSSL. OpenSSL performs the actual @acronym{S/MIME} sign/encrypt
+OpenSSL@. OpenSSL performs the actual @acronym{S/MIME} sign/encrypt
operations. OpenSSL can be found at @uref{http://www.openssl.org/}.
OpenSSL 0.9.6 and later should work. Version 0.9.5a cannot extract mail
addresses from certificates, and it insert a spurious CR character into
required. Message (@acronym{MML}) need a certificate for the person to whom you
wish to communicate with though. You're asked for this when you type
@kbd{C-c C-m c s}. Currently there are two ways to retrieve this
-certificate, from a local file or from DNS. If you chose a local
+certificate, from a local file or from DNS@. If you chose a local
file, it need to contain a X.509 certificate in @acronym{PEM} format.
If you chose DNS, you're asked for the domain name where the
certificate is stored, the default is a good guess. To my belief,
@emph{Note!} Your private key is now stored unencrypted in the file,
so take care in handling it. Storing encrypted keys on the disk are
supported, and Gnus will ask you for a passphrase before invoking
-OpenSSL. Read the OpenSSL documentation for how to achieve this. If
+OpenSSL@. Read the OpenSSL documentation for how to achieve this. If
you use unencrypted keys (e.g., if they are on a secure storage, or if
you are on a secure single user machine) simply press @code{RET} at
the passphrase prompt.
If you have imported your old PGP 2.x key into GnuPG, and want to send
signed and encrypted messages to your fellow PGP 2.x users, you'll
discover that the receiver cannot understand what you send. One
-solution is to use PGP 2.x instead (e.g.@: if you use @code{pgg}, set
+solution is to use PGP 2.x instead (e.g., if you use @code{pgg}, set
@code{pgg-default-scheme} to @code{pgp}). You could also convince your
-fellow PGP 2.x users to convert to GnuPG.
+fellow PGP 2.x users to convert to GnuPG@.
@vindex mml-signencrypt-style-alist
As a final workaround, you can make the sign and encryption work in
two steps; separately sign, then encrypt a message. If you would like
Most versions of MH doesn't like being fed messages that contain the
headers in this variable. If this variable is non-@code{nil} (which is
the default), these headers will be removed before mailing when sending
-messages via MH. Set it to @code{nil} if your MH can handle these
+messages via MH@. Set it to @code{nil} if your MH can handle these
headers.
@item message-qmail-inject-program
This should be a list of strings, one string for each argument. It
may also be a function.
-For e.g., if you wish to set the envelope sender address so that bounces
+E.g., if you wish to set the envelope sender address so that bounces
go to the right place or to deal with listserv's usage of that address, you
might set this variable to @code{'("-f" "you@@some.where")}.
created based on the date, time, user name (for the local part) and the
domain part. For the domain part, message will look (in this order) at
@code{message-user-fqdn}, @code{system-name}, @code{mail-host-address}
-and @code{message-user-mail-address} (i.e. @code{user-mail-address})
+and @code{message-user-mail-address} (i.e., @code{user-mail-address})
until a probably valid fully qualified domain name (FQDN) was found.
@item User-Agent
This manual introduces another interface to the MH mail system that is
accessible through the GNU Emacs editor, namely, @emph{MH-E}. MH-E is
easy to use. I don't assume that you know GNU Emacs or even MH at this
-point, since I didn't know either of them when I discovered MH-E.
+point, since I didn't know either of them when I discovered MH-E@.
However, MH-E was the tip of the iceberg, and I discovered more and
more niceties about GNU Emacs and MH@. Now I'm fully hooked on both of
them.
If the @code{mh-version} command displays @samp{No MH variant
detected}@footnote{In very old versions of MH-E, you may get the error
message, @samp{Cannot find the commands `inc' and `mhl' and the file
-`components'} if MH-E can't find MH. In this case, you need to update
+`components'} if MH-E can't find MH@. In this case, you need to update
MH-E, and you may need to install MH too. However, newer versions of
MH-E are better at finding MH if it is on your system.}, then you need
to install MH or tell MH-E where to find MH.
@cindex GNU mailutils MH
If you don't have MH on your system already, you must install a
-variant of MH. The Debian mh-e package does this for you automatically
+variant of MH@. The Debian mh-e package does this for you automatically
(@pxref{Getting MH-E}). Most people use
@uref{http://www.nongnu.org/nmh/, nmh}, but you may be interested in
trying out @uref{http://www.gnu.org/software/mailutils/, GNU mailutils
-MH}, which supports IMAP. Your GNU/Linux distribution probably has
+MH}, which supports IMAP@. Your GNU/Linux distribution probably has
packages for both of these.
@cindex @command{install-mh}
names.}. When you're done, you'll be able to send, read, and file
mail, which is all that a lot of people ever do. But if you're the
curious or adventurous type, read the rest of the manual to be able to
-use all the features of MH-E. I suggest you read this chapter first to
+use all the features of MH-E@. I suggest you read this chapter first to
get the big picture, and then you can read the manual as you wish.
@menu
@samp{+inbox} in MH-Folder mode. The command @kbd{M-x mh-rmail} shows
you only new mail, not mail you have already read@footnote{If you want
to see your old mail as well, use @kbd{F r} to pull all your messages
-into MH-E. Or, give a prefix argument to @code{mh-rmail} so it will
+into MH-E@. Or, give a prefix argument to @code{mh-rmail} so it will
prompt you for folder to visit like @kbd{F v} (for example, @kbd{C-u
M-x mh-rmail @key{RET} bob @key{RET}}). @xref{Folders}.}.
reader. Most of the time, this is desirable, so by default MH-E
suppresses the buttons for inline attachments. On the other hand, you
may receive code or HTML which the sender has added to his message as
-inline attachments so that you can read them in MH-E. In this case, it
+inline attachments so that you can read them in MH-E@. In this case, it
is useful to see the buttons so that you know you don't have to cut
and paste the code into a file; you can simply save the attachment. If
you want to make the buttons visible for inline attachments, you can
@cindex menu, @samp{Message}
@cindex using folders
-This chapter discusses the things you can do with folders within MH-E.
+This chapter discusses the things you can do with folders within MH-E@.
The commands in this chapter are also found in the @samp{Folder} and
@samp{Message} menus.
@cindex aliases
-MH aliases are used in the same way in MH-E as they are in MH. Any
+MH aliases are used in the same way in MH-E as they are in MH@. Any
alias listed as a recipient will be expanded when the message is sent.
This chapter discusses other things you can do with aliases in MH-E.
@vindex mh-alias-completion-ignore-case-flag
-As MH ignores case in the aliases, so too does MH-E. However, you may
+As MH ignores case in the aliases, so too does MH-E@. However, you may
turn off the option @code{mh-alias-completion-ignore-case-flag} to
make case significant which can be used to segregate completion of
your aliases. You might use uppercase for mailing lists and lowercase
[12]
[13] # Place mail sent to any MH-E mailing list in +mh-e.
[14] :0 w: mh-e$LOCKEXT
-[15] * ^TO.*mh-e-.*@.*sourceforge.net
+[15] * ^TO.*mh-e-.*@@.*sourceforge.net
[16] | myrcvstore -create +mh-e
@end smallexample
@vtable @code
@item gnus-secondary-select-methods
Select the @samp{nnml} value. This select method uses directories for
-folders and individual files for messages, just like MH. You do not
+folders and individual files for messages, just like MH@. You do not
have to set an address.
@c -------------------------
@item mail-sources
# Place mail sent to the GnuCash mailing list in gnucash.spool, where
# Gnus will pick it up.
:0:
-* ^TO.*gnucash.*@.*gnucash.org
+* ^TO.*gnucash.*@@.*gnucash.org
gnucash.spool
@end smallexample
@cindex SourceForge
@cindex mailing lists
-There are several mailing lists for MH-E. They are @i{mh-e-users at
+There are several mailing lists for MH-E@. They are @i{mh-e-users at
lists.sourceforge.net}, @i{mh-e-announce at lists.sourceforge.net},
and @i{mh-e-devel at lists.sourceforge.net}. You can subscribe or view
the archives at @uref{https://sourceforge.net/mail/?group_id=13357,
After you download and extract the MH-E tarball, read the
@file{README} file and @file{MH-E-NEWS}. These correspond to the
release notes and change log mentioned above. The file @file{README}
-contains instructions on installing MH-E. If you're already running
+contains instructions on installing MH-E@. If you're already running
Emacs, please quit that session and start again to load in the new
-MH-E. Check that you're running the new version with the command
+MH-E@. Check that you're running the new version with the command
@kbd{M-x mh-version}.
@cindex contributed software
@cindex @command{xmh}, in MH-E history
In '89, I came to Wisconsin as a professor and decided not to work on
-MH-E. It was stable, except for minor bugs, and had enough
+MH-E@. It was stable, except for minor bugs, and had enough
functionality, so I let it be for a few years. Stephen Gildea of BBN
began to pester me about the bugs, but I ignored them. In 1990, he
went off to the X Consortium, said good bye, and said that he would
now be using @command{xmh}. A few months later, he came back and said
that he couldn't stand @command{xmh} and could I put a few more bug fixes
-into MH-E. At that point, I had no interest in fixing MH-E, so I gave
+into MH-E@. At that point, I had no interest in fixing MH-E, so I gave
the responsibility of maintenance to him and he has done a fine job
since then.
embedded editors; they never live up to Emacs.
MH is the mail reader of choice at BBN, so I converted to it. Since I
-didn't want to give up using an Emacs interface, I started using MH-E.
+didn't want to give up using an Emacs interface, I started using MH-E@.
As is my wont, I started hacking on it almost immediately. I first
used version 3.4m. One of the first features I added was to treat the
folder buffer as a file-visiting buffer: you could lock it, save it,
with Emacs 18.56 in 1990, was noticeably faster.
When I moved to the X Consortium I became the first person there to
-not use xmh. (There is now one other engineer there using MH-E.) About
+not use xmh. (There is now one other engineer there using MH-E@.) About
this point I took over maintenance of MH-E from Jim and was finally
able to add some features Jim hadn't accepted, such as the backward
searching undo. My first release was 3.8 (Emacs 18.58) in 1992.
@node Configuration
@chapter Configuration
-All Newsticker options are customizable, i.e. they can be changed with
+All Newsticker options are customizable, i.e., they can be changed with
Emacs customization methods. Call the command
@code{customize-group} and enter @samp{newsticker} for the customization
group.
@item
@code{newsticker-ticker} contains options that define how headlines
-are shown in the echo area, i.e. the ``ticker''.
+are shown in the echo area, i.e., the ``ticker''.
@itemize
@item
To get validation and schema-sensitive editing, you need a RELAX NG Compact
Syntax (RNC) schema for your document (@pxref{Locating a schema}). The
@file{etc/schema} directory includes some schemas for popular document
-types. See @url{http://relaxng.org/} for more information on RELAX NG.
+types. See @url{http://relaxng.org/} for more information on RELAX NG@.
You can use the @samp{Trang} program from
@url{http://www.thaiopensource.com/relaxng/trang.html} to
automatically create RNC schemas. This program can:
@end example
@noindent
-and the schema is XHTML. In this context, the symbol to be completed
+and the schema is XHTML@. In this context, the symbol to be completed
is @samp{h}. The possible completions consist of just
@samp{head}. Another example, is
Emacs has several commands that operate on paragraphs, most
notably @kbd{M-q}. nXML mode redefines these to work in a way
-that is useful for XML. The exact rules that are used to find the
+that is useful for XML@. The exact rules that are used to find the
beginning and end of a paragraph are complicated; they are designed
mainly to ensure that @kbd{M-q} does the right thing.
subsections). The text content of a section consists of anything in a
section that is neither a subsection nor a heading.
-Note that this is a different model from that used by XHTML.
+Note that this is a different model from that used by XHTML@.
nXML mode's outline support will not be useful for XHTML unless you
adopt a convention of adding a @code{div} to enclose each
section, rather than having sections implicitly delimited by different
in a future version.
The variable @code{nxml-section-element-name-regexp} gives
-a regexp for the local names (i.e. the part of the name following any
+a regexp for the local names (i.e., the part of the name following any
prefix) of section elements. The variable
@code{nxml-heading-element-name-regexp} gives a regexp for the
local names of heading elements. For an element to be recognized
As usual with XML-related technologies, resources are identified
by URIs. The @samp{uri} attribute identifies the schema by
-specifying the URI. The URI may be relative. If so, it is resolved
+specifying the URI@. The URI may be relative. If so, it is resolved
relative to the URI of the schema locating file that contains
attribute. This means that if the value of @samp{uri} attribute
does not contain a @samp{/}, then it will refer to a filename in
whose URI matches a pattern. The pattern has the same syntax as an
absolute or relative URI except that the path component of the URI can
use a @samp{*} character to stand for zero or more characters
-within a path segment (i.e. any character other @samp{/}).
+within a path segment (i.e., any character other @samp{/}).
Typically, the URI pattern looks like a relative URI, but, whereas a
relative URI in the @samp{resource} attribute is resolved into a
particular absolute URI using the base URI of the schema locating
file, a relative URI pattern matches if it matches some number of
complete path segments of the document's URI ending with the last path
-segment of the document's URI. For example,
+segment of the document's URI@. For example,
@example
<uri pattern="*.xsl" uri="xslt.rnc"/>
Type identifiers allow a level of indirection in locating the
schema for a document. Instead of associating the document directly
with a schema URI, the document is associated with a type identifier,
-which is in turn associated with a schema URI. nXML mode does not
+which is in turn associated with a schema URI@. nXML mode does not
constrain the format of type identifiers. They can be simply strings
without any formal structure or they can be public identifiers or
URIs. Note that these type identifiers have nothing to do with the
@chapter DTDs
nXML mode is designed to support the creation of standalone XML
-documents that do not depend on a DTD. Although it is common practice
+documents that do not depend on a DTD@. Although it is common practice
to insert a DOCTYPE declaration referencing an external DTD, this has
undesirable side-effects. It means that the document is no longer
self-contained. It also means that different XML parsers may interpret
the document in different ways, since the XML Recommendation does not
-require XML parsers to read the DTD. With DTDs, it was impractical to
+require XML parsers to read the DTD@. With DTDs, it was impractical to
get validation without using an external DTD or reference to an
parameter entity. With RELAX NG and other schema languages, you can
simultaneously get the benefits of validation and standalone XML
* Capture:: Capturing new stuff
* Attachments:: Add files to tasks
* RSS Feeds:: Getting input from RSS feeds
-* Protocols:: External (e.g.@: Browser) access to Emacs and Org
+* Protocols:: External (e.g., Browser) access to Emacs and Org
* Refiling notes:: Moving a tree from one place to another
* Archiving:: What to do with finished projects
@cindex FAQ
There is a website for Org which provides links to the newest
version of Org, as well as additional information, frequently asked
-questions (FAQ), links to tutorials, etc@. This page is located at
+questions (FAQ), links to tutorials, etc. This page is located at
@uref{http://orgmode.org}.
@cindex print edition
The four Org commands @command{org-store-link}, @command{org-capture},
@command{org-agenda}, and @command{org-iswitchb} should be accessible through
-global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are
+global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
suggested bindings for these keys, please modify the keys to your own
liking.
@lisp
@cindex show children, command
@orgcmd{C-c @key{TAB},show-children}
Expose all direct children of the subtree. With a numeric prefix argument N,
-expose all children down to level N.
+expose all children down to level N@.
@orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
Show the current subtree in an indirect buffer@footnote{The indirect
buffer
@cindex @code{showeverything}, STARTUP keyword
When Emacs first visits an Org file, the global state is set to
-OVERVIEW, i.e.@: only the top level headlines are visible. This can be
+OVERVIEW, i.e., only the top level headlines are visible. This can be
configured through the variable @code{org-startup-folded}, or on a
per-file basis by adding one of the following lines anywhere in the
buffer:
@code{all}.
@table @asis
@orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
-Switch back to the startup visibility of the buffer, i.e.@: whatever is
+Switch back to the startup visibility of the buffer, i.e., whatever is
requested by startup options and @samp{VISIBILITY} properties in individual
entries.
@end table
variable @code{org-M-RET-may-split-line}.}. If the command is used at the
beginning of a headline, the new headline is created before the current line.
If at the beginning of any other line, the content of that line is made the
-new heading. If the command is used at the end of a folded subtree (i.e.@:
+new heading. If the command is used at the end of a folded subtree (i.e.,
behind the ellipses at the end of a headline), then a headline like the
current one will be inserted after the end of the subtree.
@orgcmd{C-@key{RET},org-insert-heading-respect-content}
@orgcmd{M-S-@key{down},org-move-subtree-down}
Move subtree down (swap with next subtree of same level).
@orgcmd{C-c C-x C-w,org-cut-subtree}
-Kill subtree, i.e.@: remove it from buffer but save in kill ring.
+Kill subtree, i.e., remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
@orgcmd{C-c C-x M-w,org-copy-subtree}
Copy subtree to kill ring. With a numeric prefix argument N, copy the N
@samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
confusion with normal text, those are limited to one character only. Beyond
that limit, bullets will automatically fallback to numbers.}. If you want a
-list to start with a different value (e.g.@: 20), start the text of the item
+list to start with a different value (e.g., 20), start the text of the item
with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
must be put @emph{before} the checkbox. If you have activated alphabetical
lists, you can also use counters like @code{[@@b]}.}. Those constructs can
Org mode supports the creation of footnotes. In contrast to the
@file{footnote.el} package, Org mode's footnotes are designed for work on a
larger document, not only for one-off documents like emails. The basic
-syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
+syntax is similar to the one used by @file{footnote.el}, i.e., a footnote is
defined in a paragraph that is started by a footnote marker in square
brackets in column 0, no indentation allowed. If you need a paragraph break
inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
n @r{Normalize the footnotes by collecting all definitions (including}
@r{inline definitions) into a special section, and then numbering them}
@r{in sequence. The references will then also be numbers. This is}
- @r{meant to be the final step before finishing a document (e.g.@: sending}
+ @r{meant to be the final step before finishing a document (e.g., sending}
@r{off an email). The exporters do this automatically, and so could}
@r{something like @code{message-send-hook}.}
d @r{Delete the footnote at point, and all definitions of and references}
@section The built-in table editor
@cindex table editor, built-in
-Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as
+Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
the first non-whitespace character is considered part of a table. @samp{|}
is also the column separator@footnote{To insert a vertical bar into a table
field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
@end example
Column specifications can be absolute like @code{$1},
-@code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
+@code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
column of the field which is being computed) like @code{$+1} or @code{$-2}.
@code{$<} and @code{$>} are immutable references to the first and last
column, respectively, and you can use @code{$>>>} to indicate the third
However, this syntax is deprecated, it should not be used for new documents.
Use @code{@@>$} instead.} row in the table, respectively. You may also
specify the row relative to one of the hlines: @code{@@I} refers to the first
-hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such
+hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
line above the current line, @code{@@+I} to the first such line below the
current line. You can also write @code{@@III+2} which is the second data line
after the third hline in the table.
@code{@@0} and @code{$0} refer to the current row and column, respectively,
-i.e. to the row/column for the field being computed. Also, if you omit
+i.e., to the row/column for the field being computed. Also, if you omit
either the column or the row part of the reference, the current row/column is
implied.
Install a new formula for the current column and replace current field with
the result of the formula. The command prompts for a formula, with default
taken from the @samp{#+TBLFM} line, applies it to the current field and
-stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
+stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
will apply it to that many consecutive fields in the current column.
@end table
@item with
Specify a @code{with} option to be inserted for every col being plotted
-(e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
+(e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
Defaults to @code{lines}.
@item file
@cindex @code{inlineimages}, STARTUP keyword
@cindex @code{noinlineimages}, STARTUP keyword
Toggle the inline display of linked images. Normally this will only inline
-images that have no description part in the link, i.e.@: images that will also
+images that have no description part in the link, i.e., images that will also
be inlined during export. When called with a prefix argument, also display
images that do have a link description. You can ask for inline images to be
displayed at startup by configuring the variable
@noindent
In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
complete link abbreviations. You may also define a function
-@code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
+@code{org-PREFIX-complete-link} that implements special (e.g., completion)
support for inserting such a link with @kbd{C-c C-l}. Such a function should
not accept any arguments, and return the full link with prefix.
View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
entire buffer, but shows all TODO items (with not-DONE state) and the
headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
-/ T}), search for a specific TODO. You will be prompted for the keyword, and
+/ T}), search for a specific TODO@. You will be prompted for the keyword, and
you can also give a list of keywords like @code{KWD1|KWD2|...} to list
entries that match any one of these keywords. With a numeric prefix argument
N, show the tree for the Nth keyword in the variable
@vindex org-todo-keywords
By default, marked TODO entries have one of only two states: TODO and
-DONE. Org mode allows you to classify TODO items in more complex ways
+DONE@. Org mode allows you to classify TODO items in more complex ways
with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
special setup, the TODO keyword system can work differently in different
files.
state.
@cindex completion, of TODO keywords
With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
-to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
+to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
also use a numeric prefix argument to quickly select a specific state. For
-example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
+example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
define many keywords, you can use in-buffer completion
(@pxref{Completion}) or even a special one-key selection scheme
In this case, different keywords do not indicate a sequence, but rather
different types. So the normal work flow would be to assign a task to a
-person, and later to mark it DONE. Org mode supports this style by adapting
+person, and later to mark it DONE@. Org mode supports this style by adapting
the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
@kbd{t} command in the timeline and agenda buffers.}. When used several
times in succession, it will still cycle through all names, in order to first
select the right type for a task. But when you return to the item after some
time and execute @kbd{C-c C-t} again, it will switch from any name directly
-to DONE. Use prefix arguments or completion to quickly select a specific
+to DONE@. Use prefix arguments or completion to quickly select a specific
name. You can also review the items of a specific TODO type in a sparse tree
by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
@cindex property, ORDERED
The structure of Org files (hierarchy and lists) makes it easy to define TODO
dependencies. Usually, a parent TODO task should not be marked DONE until
-all subtasks (defined as children tasks) are marked as DONE. And sometimes
+all subtasks (defined as children tasks) are marked as DONE@. And sometimes
there is a logical sequence to a number of (sub)tasks, so that one task
cannot be acted upon before all siblings above it are done. If you customize
the variable @code{org-enforce-todo-dependencies}, Org will block entries
-from changing state to DONE while they have children that are not DONE.
+from changing state to DONE while they have children that are not DONE@.
Furthermore, if an entry has a property @code{ORDERED}, each of its children
-will be blocked until all earlier siblings are marked DONE. Here is an
+will be blocked until all earlier siblings are marked DONE@. Here is an
example:
@example
However, it will never prompt for two notes---if you have configured
both, the state change recording note will take precedence and cancel
the @samp{Closing Note}.}, and that a note is recorded when switching to
-WAIT or CANCELED. The setting for WAIT is even more special: the
+WAIT or CANCELED@. The setting for WAIT is even more special: the
@samp{!} after the slash means that in addition to the note taken when
entering the state, a timestamp should be recorded when @i{leaving} the
WAIT state, if and only if the @i{target} state does not configure
@noindent
The first column, @samp{%25ITEM}, means the first 25 characters of the
-item itself, i.e.@: of the headline. You probably always should start the
+item itself, i.e., of the headline. You probably always should start the
column definition with the @samp{ITEM} specifier. The other specifiers
create columns @samp{Owner} with a list of names as allowed values, for
@samp{Status} with four different possible values, and for a checkbox
single plus or minus, the date is always relative to today. With a
double plus or minus, it is relative to the default date. If instead of
a single letter, you use the abbreviation of day name, the date will be
-the Nth such day, e.g.@:
+the Nth such day, e.g.:
@example
+0 @result{} today
You can specify a time range by giving start and end times or by giving a
start time and a duration (in HH:MM format). Use one or two dash(es) as the
separator in the former case and use '+' as the separator in the latter
-case, e.g.@:
+case, e.g.:
@example
11am-1:15pm @result{} 11:00-13:15
addition, the agenda for @emph{today} will carry a warning about the
approaching or missed deadline, starting
@code{org-deadline-warning-days} before the due date, and continuing
-until the entry is marked DONE. An example:
+until the entry is marked DONE@. An example:
@example
*** TODO write article about the Earth for the Guide
@vindex org-agenda-skip-scheduled-if-done
The headline will be listed under the given date@footnote{It will still
-be listed on that date after it has been marked DONE. If you don't like
+be listed on that date after it has been marked DONE@. If you don't like
this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
addition, a reminder that the scheduled date has passed will be present
-in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
+in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
the task will automatically be forwarded until completed.
@example
@end table
Note that @code{org-schedule} and @code{org-deadline} supports
-setting the date by indicating a relative time: e.g. +1d will set
+setting the date by indicating a relative time: e.g., +1d will set
the date to the next day after today, and --1w will set the date
to the previous week before any current timestamp.
* Capture:: Capturing new stuff
* Attachments:: Add files to tasks
* RSS Feeds:: Getting input from RSS feeds
-* Protocols:: External (e.g.@: Browser) access to Emacs and Org
+* Protocols:: External (e.g., Browser) access to Emacs and Org
* Refiling notes:: Moving a tree from one place to another
* Archiving:: What to do with finished projects
@end menu
@cindex Boolean logic, for tag/property searches
A search string can use Boolean operators @samp{&} for AND and @samp{|} for
-OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
+OR@. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
not implemented. Each element in the search is either a tag, a regular
expression matching tags, or an expression like @code{PROPERTY OPERATOR
VALUE} with a comparison operator, accessing a property value. Each element
entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
-DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
+DONE@. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
The ITEM special property cannot currently be used in tags/property
searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
assumed to be date/time specifications in the standard Org way, and the
comparison will be done accordingly. Special values that will be recognized
are @code{"<now>"} for now (including time), and @code{"<today>"}, and
-@code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
+@code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
@code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
respectively, can be used.
connected with @samp{|}) with a @samp{/} and then specify a Boolean
expression just for TODO keywords. The syntax is then similar to that for
tags, but should be applied with care: for example, a positive selection on
-several TODO keywords cannot meaningfully be combined with boolean AND.
+several TODO keywords cannot meaningfully be combined with boolean AND@.
However, @emph{negative selection} combined with AND can be meaningful. To
make sure that only lines are checked that actually have any TODO keyword
(resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
covered by the current agenda view. The initial setting for this mode in new
agenda buffers can be set with the variable
@code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
-when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
+when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
contributions from entries that are hidden by agenda filtering@footnote{Only
tags filtering will be respected here, effort filtering is ignored.}. See
also the variable @code{org-clock-report-include-clocking-task}.
numbered. If you use a @code{+n} switch, the numbering from the previous
numbered snippet will be continued in the current one. In literal examples,
Org will interpret strings like @samp{(ref:name)} as labels, and use them as
-targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
+targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
enclosed in single parenthesis). In HTML, hovering the mouse over such a
link will remote-highlight the corresponding code line, which is kind of
cool.
#+INCLUDE: "~/.emacs" src emacs-lisp
@end example
@noindent
-The optional second and third parameter are the markup (e.g.@: @samp{quote},
+The optional second and third parameter are the markup (e.g., @samp{quote},
@samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
language for formatting the contents. The markup is optional; if it is not
given, the text will be assumed to be in Org mode format and will be
#+AUTHOR: the author (default taken from @code{user-full-name})
#+DATE: a date, an Org timestamp@footnote{@code{org-export-date-timestamp-format} defines how this timestamp will be exported.}, or a format string for @code{format-time-string}
#+EMAIL: his/her email address (default from @code{user-mail-address})
-#+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
-#+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
-#+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
+#+DESCRIPTION: the page description, e.g., for the XHTML meta tag
+#+KEYWORDS: the page keywords, e.g., for the XHTML meta tag
+#+LANGUAGE: language for HTML, e.g., @samp{en} (@code{org-export-default-language})
#+TEXT: Some descriptive text to be inserted at the beginning.
#+TEXT: Several lines may be given.
#+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
-#+BIND: lisp-var lisp-val, e.g.@:: @code{org-export-latex-low-levels itemize}
+#+BIND: lisp-var lisp-val, e.g., @code{org-export-latex-low-levels itemize}
@r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
#+LINK_UP: the ``up'' link of an exported page
#+LINK_HOME: the ``home'' link of an exported page
the variable @code{org-export-run-in-background}.}.
@orgcmd{C-c C-e v,org-export-visible}
Like @kbd{C-c C-e}, but only export the text that is currently visible
-(i.e.@: not hidden by outline visibility).
+(i.e., not hidden by outline visibility).
@orgcmd{C-u C-u C-c C-e,org-export}
@vindex org-export-run-in-background
Call the exporter, but reverse the setting of
-@code{org-export-run-in-background}, i.e.@: request background processing if
+@code{org-export-run-in-background}, i.e., request background processing if
not set, or force processing in the current Emacs process if set.
@end table
@cindex UTF-8 export
ASCII export produces a simple and very readable version of an Org mode
-file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
+file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
with special characters and symbols available in these encodings.
@cindex region, active
@cindex links, in HTML export
@cindex internal links, in HTML export
@cindex external links, in HTML export
-Internal links (@pxref{Internal links}) will continue to work in HTML. This
+Internal links (@pxref{Internal links}) will continue to work in HTML@. This
includes automatic links created by radio targets (@pxref{Radio
targets}). Links to external files will still work if the target file is on
the same @i{relative} path as the published Org file. Links to other
@cindex DocBook recursive sections
DocBook exporter exports Org files as articles using the @code{article}
-element in DocBook. Recursive sections, i.e.@: @code{section} elements, are
+element in DocBook. Recursive sections, i.e., @code{section} elements, are
used in exported articles. Top level headlines in Org files are exported as
top level sections, and lower level headlines are exported as nested
sections. The entire structure of Org files will be exported completely, no
@subsection Export of properties
-The exporter also takes TODO state information into consideration, i.e.@: if a
+The exporter also takes TODO state information into consideration, i.e., if a
task is marked as done it will have the corresponding attribute in
TaskJuggler (@samp{complete 100}). Also it will export any property on a task
resource or resource node which is known to TaskJuggler, such as
@subsection Reports
@vindex org-export-taskjuggler-default-reports
-TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
+TaskJuggler can produce many kinds of reports (e.g., gantt chart, resource
allocation, etc). The user defines what kind of reports should be generated
for a project in the TaskJuggler file. The exporter will automatically insert
some default reports in the file. These defaults are defined in
in the standard iCalendar format. If you also want to have TODO entries
included in the export, configure the variable
@code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
-and TODO items as VTODO. It will also create events from deadlines that are
+and TODO items as VTODO@. It will also create events from deadlines that are
in non-TODO items. Deadlines and scheduling dates in TODO items will be used
to set the start and due dates for the TODO entry@footnote{See the variables
@code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
@lisp
("project-name" :property value :property value ...)
- @r{i.e.@: a well-formed property list with alternating keys and values}
+ @r{i.e., a well-formed property list with alternating keys and values}
@r{or}
("project-name" :components ("project-name" "project-name" ...))
@samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
becomes a link to @file{foo.html}. In this way, you can interlink the
pages of your "org web" project and the links will work as expected when
-you publish them to HTML. If you also publish the Org source file and want
+you publish them to HTML@. If you also publish the Org source file and want
to link to that, use an @code{http:} link instead of a @code{file:} link,
because @code{file:} links are converted to link to the corresponding
@file{html} file.
@cindex source code, working with
Source code can be included in Org mode documents using a @samp{src} block,
-e.g.@:
+e.g.:
@example
#+BEGIN_SRC emacs-lisp
It is possible to export the @emph{code} of code blocks, the @emph{results}
of code block evaluation, @emph{both} the code and the results of code block
evaluation, or @emph{none}. For most languages, the default exports code.
-However, for some languages (e.g.@: @code{ditaa}) the default exports the
+However, for some languages (e.g., @code{ditaa}) the default exports the
results of code block evaluation. For information on exporting code block
bodies, see @ref{Literal examples}.
the value of the Emacs variable @code{default-directory}.
When using @code{:dir}, you should supply a relative path for file output
-(e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
+(e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
case that path will be interpreted relative to the default directory.
In other words, if you want your plot to go into a folder called @file{Work}
@item @code{yes}
Column names are removed and reapplied as with @code{nil} even if the table
-does not ``look like'' it has column names (i.e.@: the second row is not an
+does not ``look like'' it has column names (i.e., the second row is not an
hline)
@end itemize
@subsubsection @code{:shebang}
Setting the @code{:shebang} header argument to a string value
-(e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
+(e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
first line of any tangled file holding the code block, and the file
permissions of the tangled file are set to make it executable.
will insert example settings for this keyword.
@item
In the line after @samp{#+STARTUP: }, complete startup keywords,
-i.e.@: valid keys for this line.
+i.e., valid keys for this line.
@item
Elsewhere, complete dictionary words using Ispell.
@end itemize
@vindex org-speed-commands-user
Single keys can be made to execute commands when the cursor is at the
-beginning of a headline, i.e.@: before the first star. Configure the variable
+beginning of a headline, i.e., before the first star. Configure the variable
@code{org-use-speed-commands} to activate this feature. There is a
pre-defined list of commands, and you can add more such commands using the
variable @code{org-speed-commands-user}. Speed keys do not only speed up
@item #+SETUPFILE: file
This line defines a file that holds more in-buffer setup. Normally this is
entirely ignored. Only when the buffer is parsed for option-setting lines
-(i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
+(i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
settings line, or when exporting), then the contents of this file are parsed
as if they had been included in the buffer. In particular, the file can be
any other Org mode file with internal setup. You can visit the file the
Things become cleaner still if you skip all the even levels and use only odd
levels 1, 3, 5..., effectively adding two stars to go from one outline level
to the next@footnote{When you need to specify a level for a property search
-or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
+or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
way we get the outline view shown at the beginning of this section. In order
to make the structure editing and export commands handle this convention
correctly, configure the variable @code{org-odd-levels-only}, or set this on
constants in the variable @code{org-table-formula-constants}, install
the @file{constants} package which defines a large number of constants
and units, and lets you use unit prefixes like @samp{M} for
-@samp{Mega}, etc@. You will need version 2.0 of this package, available
+@samp{Mega}, etc. You will need version 2.0 of this package, available
at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
the function @code{constants-get}, which has to be autoloaded in your
setup. See the installation instructions in the file
buffer with @kbd{C-c C-l}.
When it makes sense for your new link type, you may also define a function
-@code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
+@code{org-PREFIX-complete-link} that implements special (e.g., completion)
support for inserting such a link with @kbd{C-c C-l}. Such a function should
not accept any arguments, and return the full link with prefix.
table inserted between the two marker lines.
Now let's assume you want to make the table header by hand, because you
-want to control how columns are aligned, etc@. In this case we make sure
+want to control how columns are aligned, etc. In this case we make sure
that the table translator skips the first 2 lines of the source
-table, and tell the command to work as a @i{splice}, i.e.@: to not produce
+table, and tell the command to work as a @i{splice}, i.e., to not produce
header and footer commands of the target table:
@example
As you can see, the properties passed into the function (variable
@var{PARAMS}) are combined with the ones newly defined in the function
-(variable @var{PARAMS2}). The ones passed into the function (i.e.@: the
+(variable @var{PARAMS2}). The ones passed into the function (i.e., the
ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
would like to use the @LaTeX{} translator, but wanted the line endings to
be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
Let's say you want to produce a list of projects that contain a WAITING
tag anywhere in the project tree. Let's further assume that you have
marked all tree headings that define a project with the TODO keyword
-PROJECT. In this case you would run a TODO search for the keyword
+PROJECT@. In this case you would run a TODO search for the keyword
PROJECT, but skip the match unless there is a WAITING tag anywhere in
the subtree belonging to the project line.
directly to a printer, or it can be read by a program that does further
processing of the data. The first of these commands is the function
@code{org-batch-agenda}, that produces an agenda view and sends it as
-ASCII text to STDOUT. The command takes a single string as parameter.
+ASCII text to STDOUT@. The command takes a single string as parameter.
If the string has length 1, it is used as a key to one of the commands
you have configured in @code{org-agenda-custom-commands}, basically any
key you can use after @kbd{C-c a}. For example, to directly print the
@vindex org-use-property-inheritance
@findex org-insert-property-drawer
@defun org-entry-get pom property &optional inherit
-Get value of PROPERTY for entry at point-or-marker POM. By default,
+Get value of PROPERTY for entry at point-or-marker POM@. By default,
this only looks at properties defined locally in the entry. If INHERIT
is non-nil and the entry does not have the property, then also check
higher levels of the hierarchy. If INHERIT is the symbol
@end defun
@defun org-entry-put-multivalued-property pom property &rest values
-Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
+Set PROPERTY at point-or-marker POM to VALUES@. VALUES should be a list of
strings. They will be concatenated, with spaces as separators.
@end defun
moved to the end of the line (presumably of the headline of the
processed entry) and search continues from there. Under some
circumstances, this may not produce the wanted results. For example,
-if you have removed (e.g.@: archived) the current (sub)tree it could
+if you have removed (e.g., archived) the current (sub)tree it could
mean that the next entry will be skipped entirely. In such cases, you
can specify the position from where search should continue by making
FUNC set the variable `org-map-continue-from' to the desired buffer
@ifnottex
@top PCL-CVS
-This manual describes PCL-CVS, the GNU Emacs front-end to CVS. It
+This manual describes PCL-CVS, the GNU Emacs front-end to CVS@. It
is nowhere near complete, so you are advised to use @kbd{M-x
customize-group RET pcl-cvs @key{RET}} and to look at the documentation strings
of the various commands and major modes for further information.
the build and installation procedure.
@item
-@email{woods@@weird.com, Greg A.@: Woods} contributed code to implement
+@email{woods@@weird.com, Greg A. Woods} contributed code to implement
the use of per-file diff buffers, and vendor join diffs with emerge and
ediff, as well as various and sundry bug fixes and cleanups.
@cindex Sample session
This document assumes that you know what CVS is, and that you at least
-know the fundamental concepts of CVS. If that is not the case, you
+know the fundamental concepts of CVS@. If that is not the case, you
should read the CVS documentation. Type @kbd{info -f cvs} or @kbd{man
cvs}.
@end iftex
@ifnottex
The nodes in this menu contains explanations about all the commands that
-you can use in PCL-CVS. They are grouped together by type.
+you can use in PCL-CVS@. They are grouped together by type.
@end ifnottex
@menu
@cindex Command-line options to CVS
This section describes the convention used by nearly all PCL-CVS
-commands for setting optional flags sent to CVS. A single @kbd{C-u}
+commands for setting optional flags sent to CVS@. A single @kbd{C-u}
prefix argument is used to cause the command to prompt for flags to be
used for the current invocation of the command only. Two @kbd{C-u} prefix
arguments are used to prompt for flags which will be set permanently, for the
commands will use the previously prevailing flags.
As a second example, say you are about to perform a diff and want to see
-the result in unified diff format, i.e. you'd like to pass the flag
+the result in unified diff format, i.e., you'd like to pass the flag
@samp{-u} to both @samp{cvs diff} and @samp{diff}. You'd also like all
subsequent diffs to use this flag. You can type @kbd{C-u C-u = -u @key{RET}}
and the diff will be performed, and the default flags will be set to
selected files has changed between the first step and the last. You can
change this last detail with @code{log-edit-confirm}.
-As for the difference between @kbd{c} (i.e. @code{cvs-mode-commit}) and
-@kbd{C} (i.e. @code{cvs-mode-commit-setup}) is that the first gets you
+As for the difference between @kbd{c} (i.e., @code{cvs-mode-commit}) and
+@kbd{C} (i.e., @code{cvs-mode-commit-setup}) is that the first gets you
straight to @samp{*cvs-commit*} without erasing it or changing anything
to its content, while the second first erases @samp{*cvs-commit*}
and tries to initialize it with a sane default (it does that by either
@table @asis
@item Unexpected output from CVS
-Unexpected output from CVS may confuse PCL-CVS. It will create
+Unexpected output from CVS may confuse PCL-CVS@. It will create
warning messages in the @samp{*cvs*} buffer alerting you to any parse errors.
If you get these messages, please send a bug report to the email
addresses listed above. Include the contents of the @samp{*cvs*} buffer, the
This document assumes that you have already obtained and installed them
and that you are familiar with its basic functions.
-By default, PGG uses GnuPG. If you are new to such a system, I
+By default, PGG uses GnuPG@. If you are new to such a system, I
recommend that you should look over the GNU Privacy Handbook (GPH)
which is available at @uref{http://www.gnupg.org/documentation/}.
When using GnuPG, we recommend the use of the @code{gpg-agent}
-program, which is distributed with versions 2.0 and later of GnuPG.
+program, which is distributed with versions 2.0 and later of GnuPG@.
This is a daemon to manage private keys independently from any
protocol, and provides the most secure way to input and cache your
passphrases (@pxref{Caching passphrase}). By default, PGG will
Use the command @kbd{M-x irc} to connect using the defaults.
@xref{Configuration}, if you want to change the defaults.
-Use @kbd{C-u M-x irc} if you don't want to use the defaults, eg. if you
+Use @kbd{C-u M-x irc} if you don't want to use the defaults, e.g., if you
want to connect to a different network, or connect to the same network
using a different nick. This will prompt you for four things:
@cindex full name
@cindex real name
@cindex surname
-This variable is used to set your ``real name'' on IRC. It defaults
+This variable is used to set your ``real name'' on IRC@. It defaults
to the name returned by @code{user-full-name}. If you want to hide
your full name, you might want to set it to some pseudonym.
for Emacs Lisp files and info files. Also, enter the name of your Emacs
executable (usually either @samp{emacs} or @samp{xemacs}).
-Then, type
+Then, type
@example
make
@RefTeX{} needs to access all files which are part of a multifile
document, and the BibTeX database files requested by the
@code{\bibliography} command. To find these files, @RefTeX{} will
-require a search path, i.e. a list of directories to check. Normally
+require a search path, i.e., a list of directories to check. Normally
this list is stored in the environment variables @code{TEXINPUTS} and
@code{BIBINPUTS} which are also used by @RefTeX{}. However, on some
systems these variables do not contain the full search path. If
@cindex Table of contents buffer, recentering
@kindex C-c -
If you call @code{reftex-toc} while the @file{*toc*} buffer already
-exists, the cursor will immediately jump to the right place, i.e. the
+exists, the cursor will immediately jump to the right place, i.e., the
section from which @code{reftex-toc} was called will be highlighted.
The command @kbd{C-c -} (@code{reftex-toc-recenter}) will only redisplay
the @file{*toc*} buffer and highlight the correct line without actually
selecting the @file{*toc*} window. This can be useful to quickly find
out where in the document you currently are. You can also automate this
by asking RefTeX to keep track of your current editing position in the
-TOC. The TOC window will then be updated whenever you stop typing for
+TOC@. The TOC window will then be updated whenever you stop typing for
more than @code{reftex-idle-time} seconds. By default this works only
with the dedicated @file{*TOC*} frame. But you can also force automatic
recentering of the TOC window on the current frame with
@vindex reftex-ref-macro-prompt
First, you can select which reference macro you want to use,
-e.g. @samp{\ref} or @samp{\pageref}. Later in the process you have
+e.g., @samp{\ref} or @samp{\pageref}. Later in the process you have
another chance to make this selection and you can therefore disable this
step by customizing @code{reftex-ref-macro-prompt} if you find it too
intrusive. @xref{Reference Styles}.
displayed by the @samp{S<...>} indicator in the mode line of the
selection buffer. This mechanism comes in handy if you are using
@LaTeX{} packages like @code{varioref} or @code{fancyref} and want to
-use the special referencing macros they provide (e.g. @code{\vref} or
+use the special referencing macros they provide (e.g., @code{\vref} or
@code{\fref}) instead of @code{\ref}.
@item V
@vindex reftex-label-alist-builtin
@RefTeX{} needs to be aware of the environments which can be referenced
-with a label (i.e. which carry their own counters). By default, @RefTeX{}
+with a label (i.e., which carry their own counters). By default, @RefTeX{}
recognizes all labeled environments and macros discussed in @cite{The
@LaTeX{} Companion by Goossens, Mittelbach & Samarin, Addison-Wesley
1994.}. These are:
So we need to tell @RefTeX{} that @code{theorem} and @code{axiom} are new
labeled environments which define their own label categories. We can
-either use Lisp to do this (e.g. in @file{.emacs}) or use the custom
+either use Lisp to do this (e.g., in @file{.emacs}) or use the custom
library. With Lisp it would look like this
@lisp
customizing @code{reftex-ref-macro-prompt} and relying only on the
selection facilities provided in the last step.
-In the last step, i.e. the label selection, two key bindings are
+In the last step, i.e., the label selection, two key bindings are
provided to set the reference macro. Type @key{v} in order to cycle
forward through the list of available macros or @key{V} to cycle
backward. The mode line of the selection buffer shows the macro
@code{reftex-ref-style-alist} to fit your liking.
For each entry in @code{reftex-ref-style-alist} a function with the name
-@code{reftex-<package>-<macro>} (e.g. @code{reftex-varioref-vref}) will
+@code{reftex-<package>-<macro>} (e.g., @code{reftex-varioref-vref}) will
be created automatically by @RefTeX{}. These functions can be used
instead of @kbd{C-c )} and provide an alternative way of having your
favorite referencing macro preselected and if cycling through the macros
-seems inconvenient to you.@footnote{You could e.g. bind
+seems inconvenient to you.@footnote{You could, e.g., bind
@code{reftex-varioref-vref} to @kbd{C-c v} and
@code{reftex-fancyref-fref} to @kbd{C-c f}.}
@item
Some @TeX{} systems provide stand-alone programs to do the file search just
-like @TeX{} and @BibTeX{}. E.g. Thomas Esser's @code{teTeX} uses the
+like @TeX{} and @BibTeX{}. E.g., Thomas Esser's @code{teTeX} uses the
@code{kpathsearch} library which provides the command @code{kpsewhich}
to search for files. @RefTeX{} can be configured to use this
program. Note that the exact syntax of the @code{kpsewhich}
commands of a document (@pxref{Style Files,,,auctex}). Support for
@RefTeX{} in such a style file is useful when the @LaTeX{} style
defines macros or environments connected with labels, citations, or the
-index. Many style files (e.g. @file{amsmath.el} or @file{natbib.el})
+index. Many style files (e.g., @file{amsmath.el} or @file{natbib.el})
distributed with @AUCTeX{} already support @RefTeX{} in this
way.
@cindex @code{iso-cvt}, Emacs package
@cindex Emacs packages, @code{iso-cvt}
When using packages which make the buffer representation of a file
-different from its disk representation (e.g. x-symbol, isotex,
+different from its disk representation (e.g., x-symbol, isotex,
iso-cvt) you may find that @RefTeX{}'s parsing information sometimes
reflects the disk state of a file. This happens only in @emph{unvisited}
parts of a multifile document, because @RefTeX{} visits these files
@vindex reftex-keep-temporary-buffers
@code{(setq reftex-keep-temporary-buffers t)}@*
This implies that @RefTeX{} will load all parts of a multifile
-document into Emacs (i.e. there won't be any temporary buffers).
+document into Emacs (i.e., there won't be any temporary buffers).
@item
@vindex reftex-initialize-temporary-buffers
@code{(setq reftex-initialize-temporary-buffers t)}@*
@cindex @code{pf}, LaTeX package
@cindex LaTeX packages, @code{pf}
Some packages use an additional argument to a @code{\begin} macro
-to specify a label. E.g. Lamport's @file{pf.sty} uses both
+to specify a label. E.g., Lamport's @file{pf.sty} uses both
@example
\step@{@var{label}@}@{@var{claim}@} and \begin@{step+@}@{@var{label}@}
@var{claim}
@end defopt
@defopt reftex-toc-max-level
-The maximum level of toc entries which will be included in the TOC.
+The maximum level of toc entries which will be included in the TOC@.
Section headings with a bigger level will be ignored. In RefTeX,
chapters are level 1, sections level 2 etc. This variable can be
changed from within the @file{*toc*} buffer with the @kbd{t} key.
1000 means to get text after the last macro argument.
@item
If a string, use as regexp to search @emph{backward} from the label.
-Context is then the text following the end of the match. E.g. setting
+Context is then the text following the end of the match. E.g., setting
this to @samp{\\caption[[@{]} will use the caption in a figure or table
environment. @samp{\\begin@{eqnarray@}\|\\\\} works for
eqnarrays.
Label context is used in two ways by @RefTeX{}: For display in the label
menu, and to derive a label string. If you want to use a different
method for each of these, specify them as a dotted pair.
-E.g. @code{(nil . t)} uses the text after the label (@code{nil}) for
+E.g., @code{(nil . t)} uses the text after the label (@code{nil}) for
display, and text from the default position (@code{t}) to derive a label
string. This is actually used for section labels.
t @r{This means to trust any label prefixes found.}
regexp @r{If a regexp, only prefixes matched by the regexp are trusted.}
list @r{List of accepted prefixes, as strings. The colon is part of}
- @r{the prefix, e.g. ("fn:" "eqn:" "item:").}
+ @r{the prefix, e.g., ("fn:" "eqn:" "item:").}
nil @r{Never trust a label prefix.}
@end example
The only disadvantage of using this feature is that the label context
displayed in the label selection buffer along with each label is
simply some text after the label definition. This is no problem if you
-place labels keeping this in mind (e.g. @i{before} the equation, @i{at
+place labels keeping this in mind (e.g., @i{before} the equation, @i{at
the beginning} of a fig/tab caption ...). Anyway, it is probably best
to use the regexp or the list value types to fine-tune this feature.
For example, if your document contains thousands of footnotes with
If non-@code{nil}, should be a function which produces the string to
insert as a reference. Note that the insertion format can also be
changed with @code{reftex-label-alist}. This hook also is used by the
-special commands to insert e.g. @code{\vref} and @code{\fref}
+special commands to insert, e.g., @code{\vref} and @code{\fref}
references, so even if you set this, your setting will be ignored by the
special commands. The function will be called with three arguments, the
@var{label}, the @var{default format} which normally is
completion. Valid values of this variable are:
@example
nil @r{Do not provide a default index}
-"tag" @r{The default index tag given as a string, e.g. "idx"}
+"tag" @r{The default index tag given as a string, e.g., "idx"}
last @r{The last used index tag will be offered as default}
@end example
@end defopt
@code{reftex-index-selection-or-word} is executed inside @TeX{} math mode,
the index key copied from the buffer is processed with this format
string through the @code{format} function. This can be used to add the
-math delimiters (e.g. @samp{$}) to the string. Requires the
+math delimiters (e.g., @samp{$}) to the string. Requires the
@file{texmathp.el} library which is part of @AUCTeX{}.
@end defopt
@item t
Always refontify.
@item 1
-Refontify when necessary, e.g. with old versions of the x-symbol
+Refontify when necessary, e.g., with old versions of the x-symbol
package.
@end table
The option is ignored when @code{reftex-use-fonts} is @code{nil}.
the current region.
@item
New option @code{reftex-toc-split-windows-fraction} to set the size of
-the window used by the TOC. This makes the old variable
+the window used by the TOC@. This makes the old variable
@code{reftex-toc-split-windows-horizontally-fraction} obsolete.
@item
A dedicated frame can show the TOC with the current section
@itemize @bullet
@item
The selection now uses a recursive edit, much like minibuffer input.
-This removes all restrictions during selection. E.g. you can now
+This removes all restrictions during selection. E.g., you can now
switch buffers at will, use the mouse etc.
@item
New option @code{reftex-highlight-selection}.
@noindent @b{Version 3.11}
@itemize @bullet
@item
-Fixed bug which led to naked label in (e.g.) footnotes.
+Fixed bug which led to naked label in (e.g.@:) footnotes.
@item
Added scroll-other-window functions to RefTeX-Select.
@end itemize
this mode is not trying to replace. Rather, it's how that data gets
there that's the question. Most of the time, we just want to say
"Remember so-and-so's phone number, or that I have to buy dinner for the
-cats tonight." That's the FACT. How it's stored is really the
+cats tonight." That's the FACT@. How it's stored is really the
computer's problem. But at this point in time, it's most definitely
also the user's problem, and sometimes so laboriously so that people
just let data slip, rather than expend the effort to record it.
@cindex attribute, attributing
Typical usage is as follows. You want to reply or followup to a message
-in your MUA. You will probably hit @kbd{r} (i.e., ``reply'') or @kbd{f}
+in your MUA@. You will probably hit @kbd{r} (i.e., ``reply'') or @kbd{f}
(i.e., ``forward'') to begin composing the reply. In response, the MUA
will create a reply buffer and initialize the outgoing mail headers
appropriately. The body of the reply will usually be empty at this
by calling a hook variable to which Supercite's top-level function
@code{sc-cite-original} has been added. When @code{sc-cite-original} is
executed, the original message must be set up in a very specific way,
-but this is handled automatically by the MUA. @xref{Hints to MUA
+but this is handled automatically by the MUA@. @xref{Hints to MUA
Authors}.@refill
@cindex info alist
cited text and want to re-fill it, you must use an add-on package such
as @cite{filladapt} or @cite{gin-mode}. These packages can recognize
Supercited text and will fill them appropriately. Emacs's built-in
-filling routines, e.g@. @code{fill-paragraph}, do not recognize cited
+filling routines, e.g., @code{fill-paragraph}, do not recognize cited
text and will not re-fill them properly because it cannot guess the
@code{fill-prefix} being used.
@xref{Post-yank Formatting Commands}, for details.@refill
informative citations throughout. Supercite tries to be as configurable
as possible to allow for a wide range of personalized citation styles,
but it is also immediately useful with the default configuration, once
-it has been properly connected to your MUA. @xref{Getting Connected},
+it has been properly connected to your MUA@. @xref{Getting Connected},
for more details.@refill
@node Citations
@dfn{Mail header information keys} are nuggets of information that
Supercite extracts from the various mail headers of the original
-message, placed in the reply buffer by the MUA. Information is kept in
+message, placed in the reply buffer by the MUA@. Information is kept in
the @dfn{Info Alist} as key-value pairs, and can be retrieved for use in
various places within Supercite, such as in header rewrite functions and
attribution selection. Other bits of data, composed and created by
@cindex header rewrite functions, built-in
Below are examples of the various built-in header rewrite functions.
-Please note the following:@: first, the text which appears in the
+Please note the following: first, the text which appears in the
examples below as @var{infokey} indicates that the corresponding value
of the info key from the info alist will be inserted there.
(@pxref{Information Keys and the Info Alist}). For example, in @code{sc-header-on-said}
@example
@group
-(@var{infokey} ((@var{regexp} @. @var{attribution})
- (@var{regexp} @. @var{attribution})
+(@var{infokey} ((@var{regexp} . @var{attribution})
+ (@var{regexp} . @var{attribution})
(@dots{})))
@end group
@end example
variables in your hook functions, you change the attribution and
citation strings used by Supercite. One possible use of this would be
to override any automatically derived attribution string when it is only
-one character long; e.g. you prefer to use @code{"initials"} but the
+one character long; e.g., you prefer to use @code{"initials"} but the
author only has one name.@refill
@node Author Names
association list, where each element is a cons cell of the form:
@example
-(@var{regexp} @. @var{position})
+(@var{regexp} . @var{position})
@end example
@noindent
@code{sc-name-filter-alist} would have an entry such as:
@example
-("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" @. 0)
+("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" . 0)
@end example
@noindent
respectively). These frames can contain alists of the form:
@example
-((@var{infokey} (@var{regexp} @. @var{frame}) (@var{regexp} @. @var{frame}) @dots{})
- (@var{infokey} (@var{regexp} @. @var{frame}) (@var{regexp} @. @var{frame}) @dots{})
+((@var{infokey} (@var{regexp} . @var{frame}) (@var{regexp} . @var{frame}) @dots{})
+ (@var{infokey} (@var{regexp} . @var{frame}) (@var{regexp} . @var{frame}) @dots{})
(@dots{}))
@end example
@item
Insert the original message, including the mail headers into the reply
buffer. At this point you should not modify the raw text in any way
-(except for any necessary decoding, e.g. of quoted-printable text), and
+(except for any necessary decoding, e.g., of quoted-printable text), and
you should place all the original headers into the body of the reply.
This means that many of the mail headers will be duplicated, one copy
above the @code{mail-header-separator} line and one copy below, however
which auxiliary modes are enabled; the defaults are SemanticDB mode
(@pxref{SemanticDB}) and Global Semantic Idle Scheduler mode
(@pxref{Idle Scheduler}). You can also toggle the auxiliary minor
-modes separately, using their mode functions (e.g. @kbd{M-x
+modes separately, using their mode functions (e.g., @kbd{M-x
semanticdb-minor-mode}), or via the @samp{Development} menu. The
various auxiliary minor modes are described in the following sections.
Semantic mode provides a number of commands for navigating, querying,
and editing source code in a language-aware manner. These commands
generally act on @dfn{tags}, which are the source-code units deemed
-``important'' by the present programming language (e.g. functions in
+``important'' by the present programming language (e.g., functions in
the C programming language).
These commands may be used in any buffer that has been parsed by
except in the local-variables part, since SES locates things by
counting newlines. Use @kbd{C-x C-e} at the end of a line to install
your edits into the spreadsheet data structures (this does not update
-the print area, use e.g. @kbd{C-c C-l} for that).
+the print area, use, e.g., @kbd{C-c C-l} for that).
The data area is maintained as an image of spreadsheet data
structures that area stored in buffer-local variables. If the data
@cindex IMAP
When your computer is not always connected to the internet, you
must get the mail from the remote mail host using a protocol such as
-POP3 or IMAP. POP3 essentially downloads all your mail from the mail
+POP3 or IMAP@. POP3 essentially downloads all your mail from the mail
host to your computer. The mail is stored in some file on your
computer, and again, all your MUA has to do is read mail from the
spool.
@cindex user name
Most SMTP servers require clients to authenticate themselves before
they are allowed to send mail. Authentication usually involves
-supplying a user name and password.
+supplying a user name and password.
If you have not configured anything, then the first time you try to
send mail via a server, Emacs (version 24.1 and later) prompts you
The process by which the SMTP library authenticates you to the server
is known as ``Simple Authentication and Security Layer'' (SASL).
There are various SASL mechanisms, and this library supports three of
-them: CRAM-MD5, PLAIN, and LOGIN. It tries each of them, in that order,
+them: CRAM-MD5, PLAIN, and LOGIN@. It tries each of them, in that order,
until one succeeds. The first uses a form of encryption to obscure
your password, while the other two do not.
@cindex plink method
This method is mostly interesting for Windows users using the PuTTY
-implementation of SSH. It uses @samp{plink -ssh} to log in to the
+implementation of SSH@. It uses @samp{plink -ssh} to log in to the
remote host.
This supports the @samp{-P} argument.
The first directory in the localname must be a share name on the remote
host. Remember that the @code{$} character, in which default shares
usually end, must be written @code{$$} due to environment variable
-substitution in file names. If no share name is given (i.e. remote
+substitution in file names. If no share name is given (i.e., remote
directory @code{/}), all available shares are listed.
Since authorization is done on share level, you will always be
The connection methods described in this section are based on GVFS
@uref{http://en.wikipedia.org/wiki/GVFS}. Via GVFS, the remote
-filesystem is mounted locally through FUSE. @value{tramp} uses
+filesystem is mounted locally through FUSE@. @value{tramp} uses
this local mounted directory internally.
The communication with GVFS is implemented via D-Bus messages.
@defopt tramp-gvfs-methods
This customer option, a list, defines the external methods which
-shall be used with GVFS. Per default, these are @option{dav},
+shall be used with GVFS@. Per default, these are @option{dav},
@option{davs}, @option{obex} and @option{synce}. Other possible
values are @option{ftp}, @option{sftp} and @option{smb}.
@end defopt
Disable version control. If you access remote files which are not
under version control, a lot of check operations can be avoided by
-disabling VC. This can be achieved by
+disabling VC@. This can be achieved by
@lisp
(setq vc-ignore-dir-regexp
@item Use configuration possibilities of your method:
-Several connection methods (i.e. the programs used) offer powerful
+Several connection methods (i.e., the programs used) offer powerful
configuration possibilities (@pxref{Customizing Completion}). In the
given case, this could be @file{~/.ssh/config}:
@cindex parsed URI
The return value of @code{url-generic-parse-url}, and the argument
expected by @code{url-recreate-url}, is a @dfn{parsed URI}: a CL
-structure whose slots hold the various components of the URI.
+structure whose slots hold the various components of the URI@.
@xref{top,the CL Manual,,cl,GNU Emacs Common Lisp Emulation}, for
details about CL structures. Most of the other functions in the
@code{url} library act on parsed URIs.
@table @code
@item type
-The URI scheme (a string, e.g.@: @code{http}). @xref{Supported URL
+The URI scheme (a string, e.g., @code{http}). @xref{Supported URL
Types}, for a list of schemes that the @code{url} library knows how to
process. This slot can also be @code{nil}, if the URI is not fully
specified.
webpage.
@item fullness
-This is @code{t} if the URI is fully specified, i.e.@: the
+This is @code{t} if the URI is fully specified, i.e., the
hierarchical components of the URI (the hostname and/or username
and/or password) are preceded by @samp{//}.
@end table
@defun url-encode-url url-string
This function return a properly URI-encoded version of
@var{url-string}. It also performs @dfn{URI normalization},
-e.g.@: converting the scheme component to lowercase if it was
+e.g., converting the scheme component to lowercase if it was
previously uppercase.
@end defun
@chapter Retrieving URLs
The @code{url} library defines the following three functions for
-retrieving the data specified by a URL. The actual retrieval protocol
+retrieving the data specified by a URL@. The actual retrieval protocol
depends on the URL's URI scheme, and is performed by lower-level
scheme-specific functions. (Those lower-level functions are not
documented here, and generally should not be called directly.)
Its default port is 80.
The @code{https} scheme is a secure version of @code{http}, with
-transmission via SSL. It is defined in RFC 2069, and its default port
+transmission via SSL@. It is defined in RFC 2069, and its default port
is 443. When using @code{https}, the @code{url} library performs SSL
encryption via the @code{ssl} library, by forcing the @code{ssl}
gateway method to be used. @xref{Gateways in general}.
the URL@.
@defun url-http-options url
-Returns a property list describing options available for URL. The
+Returns a property list describing options available for URL@. The
property list members are:
@table @code
email address. For example, @samp{mailto:foo@@bar.com} specifies
sending a message to @samp{foo@@bar.com}. The ``retrieval method''
for such URLs is to open a mail composition buffer in which the
-appropriate content (e.g.@: the recipient address) has been filled in.
+appropriate content (e.g., the recipient address) has been filled in.
As defined in RFC 2368, a @code{mailto} URL has the form
@vindex NNTPSERVER
@defopt url-news-server
This variable specifies the default news server from which to fetch
-news, if no server was specified in the URL. The default value,
+news, if no server was specified in the URL@. The default value,
@code{nil}, means to use the server specified by the standard
environment variable @samp{NNTPSERVER}, or @samp{news} if that
environment variable is unset.
VIP.
It is recommended that you read nodes on survey and on customization before
-you start using VIP. Other nodes may be visited as needed.
+you start using VIP@. Other nodes may be visited as needed.
Comments and bug reports are welcome. Please send messages to
@code{ms@@Sail.Stanford.Edu} if you are outside of Japan and to
@code{masahiko@@sato.riec.tohoku.junet} if you are in Japan.@refill
-@insertcopying
+@insertcopying
@end ifnottex
VIP.
It is recommended that you read chapters on survey and on customization
-before you start using VIP. Other chapters may be used as future
+before you start using VIP@. Other chapters may be used as future
references.
Comments and bug reports are welcome. Please send messages to
@kindex 032 @kbd{C-z} (@code{vip-change-mode-to-vi})
-You will be in this mode just after you loaded VIP. You can do all
+You will be in this mode just after you loaded VIP@. You can do all
normal Emacs editing in this mode. Note that the key @kbd{C-z} is globally
bound to @code{vip-change-mode-to-vi}. So, if you type @kbd{C-z} in this mode
then you will be in vi mode.@refill
@chapter Vi Commands
This chapter describes Vi commands other than Ex commands implemented in
-VIP. Except for the last section which discusses insert mode, all the
+VIP@. Except for the last section which discusses insert mode, all the
commands described in this chapter are to be used in vi mode.
@menu
@end menu
@node Ex Command Reference, Customization, Ex Commands, Ex Commands
@section Ex Command Reference
-In this section we briefly explain all the Ex commands supported by VIP.
+In this section we briefly explain all the Ex commands supported by VIP@.
Most Ex commands expect @var{address} as their argument, and they use
default addresses if they are not explicitly given. In the following, such
default addresses will be shown in parentheses.
@node Customizing Constants, Customizing Key Bindings, Customization, Customization
@section Customizing Constants
An easy way to customize VIP is to change the values of constants used
-in VIP. Here is the list of the constants used in VIP and their default
+in VIP@. Here is the list of the constants used in VIP and their default
values.
@table @code
A @dfn{point} is always between 2 characters, and is @dfn{looking at}
the right hand character. The cursor is positioned on the right hand
character. Thus, when the @dfn{point} is looking at the end-of-line,
-the cursor is on the end-of-line character, i.e.@: beyond the last
+the cursor is on the end-of-line character, i.e., beyond the last
character on the line. This is the default Emacs behavior.@refill
The default settings of Viper try to mimic the behavior of Vi, preventing
more information.@refill
Emacs uses Control and Meta modifiers. These are denoted as C and M,
-e.g.@: @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is
+e.g., @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is
usually located on each side of the Space bar; it is used in a manner
similar to the Control key, e.g., @kbd{M-x} means typing @kbd{x} while
holding the Meta key down. For keyboards that do not have a Meta key,
configuration. However, this may require some getting used to. For
instance, if you are typing in a frame, A, and then move the mouse to frame
B and click to invoke mouse search, search (or insertion) will be performed
-in frame A. To perform search/insertion in frame B, you will first have to
+in frame A@. To perform search/insertion in frame B, you will first have to
shift focus there, which doesn't happen until you type a character or
perform some other action in frame B---mouse search doesn't shift focus.
@item :[x,y]s/<pat>/<repl>/<f>
Substitute (on lines x through y) the pattern
<pat> (default the last pattern) with <repl>. Useful
-flags <f> are @samp{g} for @samp{global} (i.e.@: change every
+flags <f> are @samp{g} for @samp{global} (i.e., change every
non-overlapping occurrence of <pat>) and @samp{c} for
@samp{confirm} (type @samp{y} to confirm a particular
substitution, else @samp{n} ). Instead of @kbd{/} any
@item :[x,y]move [z]
Move text between @kbd{x} and @kbd{y} to the position after @kbd{z}.
@item &
-Repeat latest Ex substitute command, e.g.
+Repeat latest Ex substitute command, e.g.,
@kbd{:s/wrong/right}.
@item :x,yp
@itemx :g/Pat/p
@item :[x,y]s/<pat>/<repl>/<f>
Substitute (on lines x through y) the pattern <pat> (default the last
pattern) with <repl>. Useful
-flags <f> are @samp{g} for @samp{global} (i.e.@: change every
+flags <f> are @samp{g} for @samp{global} (i.e., change every
non-overlapping occurrence of <pat>) and @samp{c} for
@samp{confirm} (type @samp{y} to confirm a particular
substitution, else @samp{n}). Instead of @kbd{/} any
Note: @emph{The newline character (inserted as @kbd{C-qC-j})
can be used in <repl>}.
@item &
-Repeat latest Ex substitute command, e.g.@: @kbd{:s/wrong/right}.
+Repeat latest Ex substitute command, e.g., @kbd{:s/wrong/right}.
@item :global /<pattern>/<ex-command>
@itemx :g /<pattern>/<ex-command>
Execute <ex-command> on all lines that match <pattern>.
edmonds@@edmonds.home.cs.ubc.ca (Brian Edmonds),
gin@@mo.msk.ru (Golubev I.N.),
gviswana@@cs.wisc.edu (Guhan Viswanathan),
-gvr@@halcyon.com (George V.@: Reilly),
+gvr@@halcyon.com (George V. Reilly),
hatazaki@@bach.convex.com (Takao Hatazaki),
hpz@@ibmhpz.aug.ipp-garching.mpg.de (Hans-Peter Zehrfeld),
irie@@t.email.ne.jp (Irie Tetsuya),
jackr@@dblues.engr.sgi.com (Jack Repenning),
-jamesm@@bga.com (D.J.@: Miller II),
+jamesm@@bga.com (D.J. Miller II),
jjm@@hplb.hpl.hp.com (Jean-Jacques Moreau),
jl@@cse.ogi.edu (John Launchbury),
jobrien@@hchp.org (John O'Brien),
@vindex parent@r{ keyword}
@item :parent
-The parent of a nested widget (e.g.@: a @code{menu-choice} item or an
+The parent of a nested widget (e.g., a @code{menu-choice} item or an
element of a @code{editable-list} widget).
@vindex sibling-args@r{ keyword}
@vindex secret@r{ keyword}
@item :secret
-Character used to display the value. You can set this to e.g.@: @code{?*}
+Character used to display the value. You can set this to, e.g., @code{?*}
if the field contains a password or other secret information. By
default, this is @code{nil}, and the value is not secret.
@vindex button-args@r{ keyword}
@item :button-args
-A list of keywords to pass to the radio buttons. Useful for setting
-e.g.@: the @samp{:help-echo} for each button.
+A list of keywords to pass to the radio buttons. Useful for setting,
+e.g., the @samp{:help-echo} for each button.
@vindex buttons@r{ keyword}
@item :buttons
sequence given in the specification. By setting @code{:greedy} to
non-@code{nil}, it will allow the items to come in any sequence.
However, if you extract the value they will be in the sequence given
-in the checklist, i.e.@: the original sequence is forgotten.
+in the checklist, i.e., the original sequence is forgotten.
@vindex button-args@r{ keyword}
@item :button-args
-A list of keywords to pass to the checkboxes. Useful for setting
-e.g.@: the @samp{:help-echo} for each checkbox.
+A list of keywords to pass to the checkboxes. Useful for setting,
+e.g., the @samp{:help-echo} for each checkbox.
@vindex buttons@r{ keyword}
@item :buttons
@end defun
Occasionally it can be useful to know which kind of widget you have,
-i.e.@: the name of the widget type you gave when the widget was created.
+i.e., the name of the widget type you gave when the widget was created.
@defun widget-type widget
Return the name of @var{widget}, a symbol.
similar), which seems to be the standard mechanism under GNU/Linux, then
it parses that. To be precise, ``something very similar'' means
starting with @samp{man} and ending with @samp{.conf} and possibly more
-lowercase letters, e.g.@: @file{manual.configuration}.
+lowercase letters, e.g., @file{manual.configuration}.
The search path and/or precise full path name for this file are set by
the value of the customizable user option @code{woman-man.conf-path}.
If all else fails, WoMan uses a plausible default man search path.
network is involved. For this reason, it caches various amounts of
information, after which retrieving it from the cache is very fast. If
the cache ever gets out of synchronism with reality, running the
-@code{woman} command with a prefix argument (e.g.@: @kbd{C-u M-x woman})
+@code{woman} command with a prefix argument (e.g., @kbd{C-u M-x woman})
will force it to rebuild its cache. This is necessary only if the names
or locations of any man files change; it is not necessary if only their
contents change. It would always be necessary if such a change occurred
to a non-@code{nil} value (using @code{let}), in which case
@code{woman} will can use the suggested topic without confirmation if
possible. This may be useful to provide special private key bindings,
-e.g.@: this key binding for @kbd{C-c w} runs WoMan on the topic at
+e.g., this key binding for @kbd{C-c w} runs WoMan on the topic at
point without seeking confirmation:
@lisp
all (provided WoMan is installed and loaded or set up to autoload).
This command can be used to browse any accessible man file, regardless
of its filename or location. If the file is compressed then automatic
-file decompression must already be turned on (e.g.@: see the
+file decompression must already be turned on (e.g., see the
@samp{Help->Options} submenu)---it is turned on automatically only by
the @code{woman} topic interface.
Emacs provides an interface to detect automatically the format of a file
and decode it when it is visited. It is used primarily by the
-facilities for editing rich (i.e.@: formatted) text, as a way to store
+facilities for editing rich (i.e., formatted) text, as a way to store
formatting information transparently as @acronym{ASCII} markup. WoMan can in
principle use this interface, but it must be configured explicitly.
Man pages usually contain a ``SEE ALSO'' section containing references
to other man pages. If these man pages are installed then WoMan can
-easily be directed to follow the reference, i.e.@: to find and format the
+easily be directed to follow the reference, i.e., to find and format the
man page. When the mouse is passed over a correctly formatted reference
it is highlighted, in which case clicking the middle button
@kbd{Mouse-2} will cause WoMan to follow the reference. Alternatively,
@kindex q
@findex Man-quit
Bury the buffer containing the current man page (@code{Man-quit}),
-i.e.@: move it to the bottom of the buffer stack.
+i.e., move it to the bottom of the buffer stack.
@item k
@kindex k
@findex Man-kill
Kill the buffer containing the current man page (@code{Man-kill}),
-i.e.@: delete it completely so that it can be retrieved only by formatting
+i.e., delete it completely so that it can be retrieved only by formatting
the page again.
@item M-p
@kindex R
@findex woman-reformat-last-file
Call WoMan to reformat the last man page formatted by WoMan
-(@code{woman-reformat-last-file}), e.g.@: after changing the fill column.
+(@code{woman-reformat-last-file}), e.g., after changing the fill column.
@end table
change them only via the standard Emacs customization facilities.
WoMan defines a top-level customization group called @code{WoMan}
under the parent group @code{Help}. It can be accessed either via the
-standard Emacs facilities, e.g.@: via the @samp{Help->Customize}
+standard Emacs facilities, e.g., via the @samp{Help->Customize}
submenu, or via the WoMan major mode menu.
The top-level WoMan group contains only a few general options and three
@vtable @code
@item woman-show-log
A boolean value that defaults to @code{nil}. If non-@code{nil} then show the
-@code{*WoMan-Log*} buffer if appropriate, i.e.@: if any warning messages
+@code{*WoMan-Log*} buffer if appropriate, i.e., if any warning messages
are written to it. @xref{Log, , The *WoMan-Log* Buffer}.
@item woman-pre-format-hook
@end lisp
Any environment variables (names of which must have the Unix-style form
-@code{$NAME}, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR},
+@code{$NAME}, e.g., @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR},
regardless of platform) are evaluated first but each element must
evaluate to a @emph{single} directory name. Trailing @file{/}s are
ignored. (Specific directories in @code{woman-path} are also searched.)
On Microsoft platforms I recommend including drive letters explicitly,
-e.g.
+e.g.:
@lisp
("C:/Cygwin/usr/man" "C:/usr/man" "C:/usr/local/man")
and on other platforms is @code{nil}.
Any environment variables (names of which must have the Unix-style form
-@code{$NAME}, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR},
+@code{$NAME}, e.g., @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR},
regardless of platform) are evaluated first but each element must
evaluate to a @emph{single} directory name (regexp, see above). For
example
@item woman-dired-keys
A list of @code{dired} mode keys to be defined to run WoMan on the
-current file, e.g.@: @code{("w" "W")} or any non-@code{nil} atom to
+current file, e.g., @code{("w" "W")} or any non-@code{nil} atom to
automatically define @kbd{w} and @kbd{W} if they are unbound, or
@code{nil} to do nothing. Default is @code{t}.
initially only for MS-Windows and only for MS-Windows fonts. This
includes both non-@acronym{ASCII} characters from the main text font and use
of a separate symbol font. Later, support will be added for other font
-types (e.g.@: @code{bdf} fonts) and for the X Window System. In Emacs
+types (e.g., @code{bdf} fonts) and for the X Window System. In Emacs
20.7, the current support works partially under Windows 9x but may not
work on any other platform.
@cindex reporting bugs
@cindex bugs, reporting
-If WoMan fails completely, or formats a file incorrectly (i.e.@:
+If WoMan fails completely, or formats a file incorrectly (i.e.,
obviously wrongly or significantly differently from @code{man}) or
inelegantly, then please