@c This is part of the Emacs manual.
-@c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000
+@c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000, 2001
@c Free Software Foundation, Inc.
@c See file emacs.texi for copying conditions.
@iftex
As opposed to most normal Emacs packages, Gnus uses a number of
different buffers to display information and to receive commands. The
three buffers users spend most of their time in are the @dfn{group
-buffer}, the @dfn{summary buffer} and the @dfn{article buffer}.
+buffer}, the @dfn{summary buffer} and the @dfn{article buffer}.
The @dfn{group buffer} contains a list of groups. This is the first
buffer Gnus displays when it starts up. It normally displays only the
@node Summary of Gnus
@subsection Summary of Gnus Commands
-Reading news is a two step process:
+Reading news is a two-step process:
@enumerate
@item
and display the first unread article in that group.
@need 1000
-In the summary buffer,
+In the summary buffer,
@itemize @bullet
@item
@item
Have Gnus score articles according to various criteria, like author
name, subject, or string in the body of the articles.@*
-@xref{Scoring, , , gnus, The Gnus Manual}.
+@xref{Scoring, , , gnus, The Gnus Manual}.
@item
Send an article to a newsgroup.@*
@cindex shell commands
Emacs has commands for passing single command lines to inferior shell
-processes; it can also run a shell interactively with input and output to
-an Emacs buffer named @samp{*shell*}.
+processes; it can also run a shell interactively with input and output
+to an Emacs buffer named @samp{*shell*} or run a shell inside a terminal
+emulator window.
+
+There is a shell implemented entirely in Emacs, documented in a separate
+manual. @xref{Top,Eshell,Eshell, eshell, Eshell: The Emacs Shell}.
@table @kbd
@item M-! @var{cmd} @key{RET}
Run a subshell with input and output through an Emacs buffer.
You can then give commands interactively.
Full terminal emulation is available.
+@item M-x eshell
+@findex eshell
+Start the Emacs shell.
@end table
@menu
* Interactive Shell:: Permanent shell taking input via Emacs.
* Shell Mode:: Special Emacs commands used with permanent shell.
* History: Shell History. Repeating previous commands in a shell buffer.
+* Directory Tracking:: Keeping track when the subshell changes directory.
* Options: Shell Options. Options for customizing Shell mode.
* Terminal emulator:: An Emacs window as a terminal emulator.
* Term Mode:: Special Emacs commands used in Term mode.
@kbd{M-!} (@code{shell-command}) reads a line of text using the
minibuffer and executes it as a shell command in a subshell made just
for that command. Standard input for the command comes from the null
-device. If the shell command produces any output, the output goes into
-an Emacs buffer named @samp{*Shell Command Output*}, which is displayed
-in another window but not selected. A numeric argument, as in @kbd{M-1
-M-!}, directs this command to insert any output into the current buffer.
-In that case, point is left before the output and the mark is set after
-the output.
+device. If the shell command produces any output, the output appears
+either in the echo area (if it is short), or in an Emacs buffer named
+@samp{*Shell Command Output*}, which is displayed in another window
+but not selected (if the output is long).
+
+ For instance, one way to decompress a file @file{foo.gz} from Emacs
+is to 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, as in @kbd{M-1 M-!}, says 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 @key{RET}} would insert the
+uncompressed equivalent of @file{foo.gz} into the current buffer.
If the shell command line ends in @samp{&}, it runs asynchronously.
For a synchronous shell command, @code{shell-command} returns the
command's exit status (0 means success), when it is called from a Lisp
-program.
+program. You do not get any status information for an asynchronous
+command, since it hasn't finished yet.
@kindex M-|
@findex shell-command-on-region
first and the output replaces it as the contents of the region. It
returns the command's exit status when it is called from a Lisp program.
+ One use for @kbd{M-|} is to run @code{uudecode}. For instance, if
+the buffer contains uuencoded text, type @kbd{C-x h M-| uudecode
+@key{RET}} to feed the entire buffer contents to the @code{uudecode}
+program. That program will ignore everything except the encoded text,
+and will store the decoded output into the file whose name is
+specified in the encoded text.
+
@vindex shell-file-name
-@cindex environment
Both @kbd{M-!} and @kbd{M-|} use @code{shell-file-name} to specify the
shell to use. This variable is initialized based on your @env{SHELL}
environment variable when Emacs is started. If the file name does not
process it; this happens whenever Emacs is waiting for keyboard input or
for time to elapse.
- To make multiple subshells, rename the buffer @samp{*shell*} to
-something different using @kbd{M-x rename-uniquely}. Then type @kbd{M-x
-shell} again to create a new buffer @samp{*shell*} with its own
-subshell. If you rename this buffer as well, you can create a third
-one, and so on. All the subshells run independently and in parallel.
+@cindex @code{comint-highlight-input} face
+@cindex @code{comint-highlight-prompt} face
+ Input lines, once you submit them, are displayed using the face
+@code{comint-highlight-input}, and prompts are displayed using the
+face @code{comint-highlight-prompt}. This makes it easier to see
+previous input lines in the buffer. @xref{Faces}.
+
+ To make multiple subshells, you can invoke @kbd{M-x shell} with a
+prefix argument (e.g. @kbd{C-u M-x shell}), which will read a buffer
+name and create (or reuse) a subshell in that buffer. You can also
+rename the @samp{*shell*} buffer using @kbd{M-x rename-uniquely}, then
+create a new @samp{*shell*} buffer using plain @kbd{M-x shell}. All the
+subshells in different buffers run independently and in parallel.
@vindex explicit-shell-file-name
+@cindex environment variables for subshells
@cindex @env{ESHELL} environment variable
@cindex @env{SHELL} environment variable
The file name used to load the subshell is the value of the variable
@env{PATH} when Emacs is started. Your @file{.emacs} file can override
either or both of these default initializations.
+ Emacs sends the new shell the contents of the file
+@file{~/.emacs_@var{shellname}} as input, if it exists, where
+@var{shellname} is the name of the file that the shell was loaded
+from. For example, if you use bash, the file sent to it is
+@file{~/.emacs_bash}.
+
To specify a coding system for the shell, you can use the command
@kbd{C-x @key{RET} c} immediately before @kbd{M-x shell}. You can also
specify a coding system after starting the shell by using @kbd{C-x
@key{RET} p} in the shell buffer. @xref{Specify Coding}.
- As soon as the subshell is started, it is sent as input the contents
-of the file @file{~/.emacs_@var{shellname}}, if that file exists, where
-@var{shellname} is the name of the file that the shell was loaded from.
-For example, if you use bash, the file sent to it is
-@file{~/.emacs_bash}.
-
-@vindex shell-pushd-regexp
-@vindex shell-popd-regexp
-@vindex shell-cd-regexp
- @code{cd}, @code{pushd} and @code{popd} commands given to the inferior
-shell are watched by Emacs so it can keep the @samp{*shell*} buffer's
-default directory the same as the shell's working directory. These
-commands are recognized syntactically by examining lines of input that are
-sent. If you use aliases for these commands, you can tell Emacs to
-recognize them also. For example, if the value of the variable
-@code{shell-pushd-regexp} matches the beginning of a shell command line,
-that line is regarded as a @code{pushd} command. Change this variable when
-you add aliases for @samp{pushd}. Likewise, @code{shell-popd-regexp} and
-@code{shell-cd-regexp} are used to recognize commands with the meaning of
-@samp{popd} and @samp{cd}. These commands are recognized only at the
-beginning of a shell command line.@refill
-
-@vindex shell-set-directory-error-hook
- If Emacs gets an error while trying to handle what it believes is a
-@samp{cd}, @samp{pushd} or @samp{popd} command, it runs the hook
-@code{shell-set-directory-error-hook} (@pxref{Hooks}).
-
-@findex dirs
- If Emacs does not properly track changes in the current directory of
-the subshell, use the command @kbd{M-x dirs} to ask the shell what its
-current directory is. This command works for shells that support the
-most common command syntax; it may not work for unusual shells.
-
-@findex dirtrack-mode
- You can also use @kbd{M-x dirtrack-mode} to enable (or disable) an
-alternative and more aggressive method of tracking changes in the
-current directory.
-
- Emacs defines the environment variable @env{EMACS} in the subshell,
-with value @code{t}. A shell script can check this variable to
-determine whether it has been run from an Emacs subshell.
+@cindex @env{EMACS} environment variable
+ Unless the environment variable @env{EMACS} is already defined,
+Emacs defines it in the subshell, with value @code{t}. A shell script
+can check this variable to determine whether it has been run from an
+Emacs subshell.
@node Shell Mode
@subsection Shell Mode
@item @key{RET}
@kindex RET @r{(Shell mode)}
@findex comint-send-input
-At end of buffer send line as input; otherwise, copy current line to end
-of buffer and send it (@code{comint-send-input}). When a line is
-copied, any text at the beginning of the line that matches the variable
-@code{shell-prompt-pattern} is left out; this variable's value should be
-a regexp string that matches the prompts that your shell uses.
+At end of buffer send line as input; otherwise, copy current line to
+end of buffer and send it (@code{comint-send-input}). When a line is
+copied, any prompt at the beginning of the line (text output by
+programs preceding your input) is omitted. (See also the variable
+@code{comint-use-prompt-regexp-instead-of-fields}.)
@item @key{TAB}
@kindex TAB @r{(Shell mode)}
@vindex shell-completion-fignore
@vindex comint-completion-fignore
The variable @code{shell-completion-fignore} specifies a list of file
-name extensions to ignore in Shell mode completion. The default setting
-ignores file names ending in @samp{~}, @samp{#} or @samp{%}. Other
+name extensions to ignore in Shell mode completion. The default
+setting is @code{nil}, but some users prefer @code{("~" "#" "%")} to
+ignore file names ending in @samp{~}, @samp{#} or @samp{%}. Other
related Comint modes use the variable @code{comint-completion-fignore}
instead.
@item C-c C-a
@kindex C-c C-a @r{(Shell mode)}
-@findex comint-bol
+@findex comint-bol-or-process-mark
Move to the beginning of the line, but after the prompt if any
-(@code{comint-bol}). If you repeat this command twice in a row, the
-second time it moves back to the process mark, which is the beginning of
-the input that you have not yet sent to the subshell. (Normally that is
-the same place---the end of the prompt on this line---but after @kbd{C-c
-@key{SPC}} the process mark may be in a previous line.)
+(@code{comint-bol-or-process-mark}). If you repeat this command twice
+in a row, the second time it moves back to the process mark, which is
+the beginning of the input that you have not yet sent to the subshell.
+(Normally that is the same place---the end of the prompt on this
+line---but after @kbd{C-c @key{SPC}} the process mark may be in a
+previous line.)
@item C-c @key{SPC}
Accumulate multiple lines of input, then send them together. This
@item C-c C-o
@kindex C-c C-o @r{(Shell mode)}
-@findex comint-kill-output
-Kill the last batch of output from a shell command
-(@code{comint-kill-output}). This is useful if a shell command spews
-out lots of output that just gets in the way.
+@findex comint-delete-output
+Delete the last batch of output from a shell command
+(@code{comint-delete-output}). This is useful if a shell command spews
+out lots of output that just gets in the way. This command used to be
+called @code{comint-kill-output}.
+
+@item C-c C-s
+@kindex C-c C-s @r{(Shell mode)}
+@findex comint-write-output
+Write the last batch of output from a shell command to a file
+(@code{comint-write-output}). With a prefix argument, the file is
+appended to instead. Any prompt at the end of the output is not
+written.
@item C-c C-r
@itemx C-M-l
Shell mode is a derivative of Comint mode, a general-purpose mode for
communicating with interactive subprocesses. Most of the features of
Shell mode actually come from Comint mode, as you can see from the
-command names listed above. The special features of Shell mode in
-particular include the choice of regular expression for detecting
-prompts, the directory tracking feature, and a few user commands.
+command names listed above. The special features of Shell mode include
+the directory tracking feature, and a few user commands.
Other Emacs features that use variants of Comint mode include GUD
(@pxref{Debuggers}) and @kbd{M-x run-lisp} (@pxref{External Lisp}).
@item C-c C-x @r{(Shell mode)}
@findex comint-get-next-from-history
Fetch the next subsequent command from the history.
+
+@item C-c . @r{(Shell mode)}
+@findex comint-input-previous-argument
+Fetch one argument from an old shell command.
@end table
Shell buffers provide a history of previously entered shell commands. To
The history search commands @kbd{M-r} and @kbd{M-s} read a regular
expression and search through the history for a matching command. Aside
from the choice of which command to fetch, they work just like @kbd{M-p}
-and @kbd{M-r}. If you enter an empty regexp, these commands reuse the
+and @kbd{M-n}. If you enter an empty regexp, these commands reuse the
same regexp used last time.
When you find the previous input you want, you can resubmit it by
can reexecute several successive commands by typing @kbd{C-c C-x
@key{RET}} over and over.
+ The command @kbd{C-c .}@: (@code{comint-input-previous-argument})
+copies an individual argument from a previous command, like @kbd{ESC
+.} in Bash. The simplest use copies the last argument from the
+previous shell command. With a prefix argument @var{n}, it copies the
+@var{n}th argument instead. Repeating @kbd{C-c .} copies from an
+earlier shell command instead, always using the same value of @var{n}
+(don't give a prefix argument when you repeat the @kbd{C-c .}
+command).
+
These commands get the text of previous shell commands from a special
history list, not from the shell buffer itself. Thus, editing the shell
buffer, or even killing large parts of it, does not affect the history
@subsubsection Shell History References
@cindex history reference
- Various shells including csh and bash support @dfn{history references}
-that begin with @samp{!} and @samp{^}. Shell mode can understand these
-constructs and perform the history substitution for you. If you insert
-a history reference and type @key{TAB}, this searches the input history
-for a matching command, performs substitution if necessary, and places
-the result in the buffer in place of the history reference. For
-example, you can fetch the most recent command beginning with @samp{mv}
-with @kbd{! m v @key{TAB}}. You can edit the command if you wish, and
-then resubmit the command to the shell by typing @key{RET}.
+ Various shells including csh and bash support @dfn{history
+references} that begin with @samp{!} and @samp{^}. Shell mode
+recognizes these constructs, and can perform the history substitution
+for you.
+
+ If you insert a history reference and type @key{TAB}, this searches
+the input history for a matching command, performs substitution if
+necessary, and places the result in the buffer in place of the history
+reference. For example, you can fetch the most recent command
+beginning with @samp{mv} with @kbd{! m v @key{TAB}}. You can edit the
+command if you wish, and then resubmit the command to the shell by
+typing @key{RET}.
+
+@vindex comint-input-autoexpand
+@findex comint-magic-space
+ Shell mode can optionally expand history references in the buffer
+when you send them to the shell. To request this, set the variable
+@code{comint-input-autoexpand} to @code{input}. You can make
+@key{SPC} perform history expansion by binding @key{SPC} to the
+command @code{comint-magic-space}.
@vindex shell-prompt-pattern
@vindex comint-prompt-regexp
- History references take effect only following a shell prompt. The
-variable @code{shell-prompt-pattern} specifies how to recognize a shell
-prompt. Comint modes in general use the variable
-@code{comint-prompt-regexp} to specify how to find a prompt; Shell mode
-uses @code{shell-prompt-pattern} to set up the local value of
-@code{comint-prompt-regexp}.
+@vindex comint-use-prompt-regexp-instead-of-fields
+@cindex prompt, shell
+ Shell mode recognizes history references when they follow a prompt.
+Normally, any text output by a program at the beginning of an input
+line is considered a prompt. However, if the variable
+@code{comint-use-prompt-regexp-instead-of-fields} is non-@code{nil},
+then Comint mode uses a regular expression to recognize prompts. In
+general, the variable @code{comint-prompt-regexp} specifies the
+regular expression; Shell mode uses the variable
+@code{shell-prompt-pattern} to set up @code{comint-prompt-regexp} in
+the shell buffer.
+
+@node Directory Tracking
+@subsection Directory Tracking
+@cindex directory tracking
-@vindex comint-input-autoexpand
- Shell mode can optionally expand history references in the buffer when
-you send them to the shell. To request this, set the variable
-@code{comint-input-autoexpand} to @code{input}.
+@vindex shell-pushd-regexp
+@vindex shell-popd-regexp
+@vindex shell-cd-regexp
+ Shell mode keeps track of @samp{cd}, @samp{pushd} and @samp{popd}
+commands given to the inferior shell, so it can keep the
+@samp{*shell*} buffer's default directory the same as the shell's
+working directory. It recognizes these commands syntactically, by
+examining lines of input that are sent.
-@findex comint-magic-space
- You can make @key{SPC} perform history expansion by binding @key{SPC} to
-the command @code{comint-magic-space}.
+ If you use aliases for these commands, you can tell Emacs to
+recognize them also. For example, if the value of the variable
+@code{shell-pushd-regexp} matches the beginning of a shell command
+line, that line is regarded as a @code{pushd} command. Change this
+variable when you add aliases for @samp{pushd}. Likewise,
+@code{shell-popd-regexp} and @code{shell-cd-regexp} are used to
+recognize commands with the meaning of @samp{popd} and @samp{cd}.
+These commands are recognized only at the beginning of a shell command
+line.
+
+@ignore @c This seems to have been deleted long ago.
+@vindex shell-set-directory-error-hook
+ If Emacs gets an error while trying to handle what it believes is a
+@samp{cd}, @samp{pushd} or @samp{popd} command, it runs the hook
+@code{shell-set-directory-error-hook} (@pxref{Hooks}).
+@end ignore
+
+@findex dirs
+ If Emacs gets confused about changes in the current directory of the
+subshell, use the command @kbd{M-x dirs} to ask the shell what its
+current directory is. This command works for shells that support the
+most common command syntax; it may not work for unusual shells.
+
+@findex dirtrack-mode
+ You can also use @kbd{M-x dirtrack-mode} to enable (or disable) an
+alternative and more aggressive method of tracking changes in the
+current directory.
@node Shell Options
@subsection Shell Mode Options
@vindex comint-scroll-show-maximum-output
If @code{comint-scroll-show-maximum-output} is non-@code{nil}, then
-scrolling due to arrival of output tries to place the last line of text
-at the bottom line of the window, so as to show as much useful text as
-possible. (This mimics the scrolling behavior of many terminals.)
-The default is @code{nil}.
+scrolling due to the arrival of output tries to place the last line of
+text at the bottom line of the window, so as to show as much useful
+text as possible. (This mimics the scrolling behavior of many
+terminals.) The default is @code{nil}.
@vindex comint-scroll-to-bottom-on-output
By setting @code{comint-scroll-to-bottom-on-output}, you can opt for
having point jump to the end of the buffer whenever output arrives---no
matter where in the buffer point was before. If the value is
@code{this}, point jumps in the selected window. If the value is
-@code{all}, point jumps in each window that shows the comint buffer. If
+@code{all}, point jumps in each window that shows the Comint buffer. If
the value is @code{other}, point jumps in all nonselected windows that
show the current buffer. The default value is @code{nil}, which means
point does not jump to the end.
@code{comint-completion-autolist}, if non-@code{nil}, says to list all
the possible completions whenever completion is not exact.
-@findex comint-dynamic-complete-variable
- The command @code{comint-dynamic-complete-variable} does variable-name
-completion using the environment variables as set within Emacs. The
-variables controlling file name completion apply to variable-name
-completion too. This command is normally available through the menu
-bar.
-
-@vindex shell-command-execonly
+@vindex shell-completion-execonly
Command completion normally considers only executable files.
-If you set @code{shell-command-execonly} to @code{nil},
+If you set @code{shell-completion-execonly} to @code{nil},
it considers nonexecutable files as well.
@findex shell-pushd-tohome
(@code{shell-pushd-dunique}). The values you choose should match the
underlying shell, of course.
+ If you want Shell mode to handle color output from shell commands,
+you can enable ANSI Color mode. Here is how to do this:
+
+@example
+(add-hook 'shell-mode-hook 'ansi-color-for-comint-mode-on)
+@end example
+
@node Terminal emulator
-@subsection Interactive Inferior Shell with Terminal Emulator
+@subsection Emacs Terminal Emulator
@findex term
- To run a subshell in a terminal emulator, putting its typescript in an Emacs
-buffer, use @kbd{M-x term}. This creates (or reuses) a buffer named
-@samp{*term*} and runs a subshell with input coming from your keyboard and
-output going to that buffer.
+ To run a subshell in a terminal emulator, putting its typescript in
+an Emacs buffer, use @kbd{M-x term}. This creates (or reuses) a
+buffer named @samp{*terminal*}, and runs a subshell with input coming
+from your keyboard, and output going to that buffer.
+
+ The terminal emulator uses Term mode, which has two input modes. In
+line mode, Term basically acts like Shell mode; see @ref{Shell Mode}.
-All the normal keys that you type are sent without any interpretation
-by Emacs directly to the subshell, as ``terminal input''.
-Any ``echo'' of your input is the responsibility of the subshell.
-(The exception is the terminal escape character,
-which by default is @kbd{C-c}. @xref{Term Mode}.)
+ In char mode, each character is sent directly to the inferior
+subshell, as ``terminal input.'' Any ``echoing'' of your input is the
+responsibility of the subshell. The sole exception is the terminal
+escape character, which by default is @kbd{C-c} (@pxref{Term Mode}).
Any ``terminal output'' from the subshell goes into the buffer,
advancing point.
- Some programs (such as Emacs itself) need to control the
-appearance on the terminal screen in detail. They do this by
-sending special control codes. The exact control
-codes needed vary from terminal to terminal, but nowadays
-most terminals and terminal emulators (including @code{xterm})
-understand the ANSI-standard (VT100-style) escape sequences.
-Term mode also understands these escape sequences,
-and for each control code does the appropriate thing
-to change the buffer so that the appearance of the window
-matches what it would be on a real terminal.
-Thus you can actually run Emacs inside an Emacs Term window!
-
- Emacs does not wait for the subshell to do anything. You can switch
-windows or buffers and edit them while the shell is waiting, or while
-it is running a command. Output from the subshell waits until Emacs
-has time to process it; this happens whenever Emacs is waiting for
-keyboard input or for time to elapse.
-
- To make multiple terminal emulators, rename the buffer @samp{*term*}
-to something different using @kbd{M-x rename-uniquely},
-just as with Shell mode.
-
- The file name used to load the subshell is determined
-the same way as for Shell mode.
-
-Unlike Shell mode, Term mode does not track the current directory
-by examining your input. Instead, if you use a programmable
-shell, you can have it tell Term what the current directory is.
-This is done automatically by @code{bash} version 1.15 and later.
+ Some programs (such as Emacs itself) need to control the appearance
+on the terminal screen in detail. They do this by sending special
+control codes. The exact control codes needed vary from terminal to
+terminal, but nowadays most terminals and terminal emulators
+(including @code{xterm}) understand the ANSI-standard (VT100-style)
+escape sequences. Term mode recognizes these escape sequences, and
+handles each one appropriately, changing the buffer so that the
+appearance of the window matches what it would be on a real terminal.
+You can actually run Emacs inside an Emacs Term window.
+
+ The file name used to load the subshell is determined the same way
+as for Shell mode. To make multiple terminal emulators, rename the
+buffer @samp{*terminal*} to something different using @kbd{M-x
+rename-uniquely}, just as with Shell mode.
+
+ Unlike Shell mode, Term mode does not track the current directory by
+examining your input. But some shells can tell Term what the current
+directory is. This is done automatically by @code{bash} version 1.15
+and later.
@node Term Mode
@subsection Term Mode
@cindex Term mode
@cindex mode, Term
- Term uses Term mode, which has two input modes:
-In line mode, Term basically acts like Shell mode. @xref{Shell Mode}.
-In Char mode, each character is sent directly to the inferior subshell,
-except for the Term escape character, normally @kbd{C-c}.
+ The terminal emulator uses Term mode, which has two input modes. In
+line mode, Term basically acts like Shell mode; see @ref{Shell Mode}.
+In char mode, each character is sent directly to the inferior
+subshell, except for the Term escape character, normally @kbd{C-c}.
+
+ To switch between line and char mode, use these commands:
-To switch between line and char mode, use these commands:
@table @kbd
-@kindex C-c C-k @r{(Term mode)}
+@kindex C-c C-j @r{(Term mode)}
@findex term-char-mode
-@item C-c C-k
+@item C-c C-j
Switch to line mode. Do nothing if already in line mode.
-@kindex C-c C-j @r{(Term mode)}
+@kindex C-c C-k @r{(Term mode)}
@findex term-line-mode
-@item C-c C-j
+@item C-c C-k
Switch to char mode. Do nothing if already in char mode.
@end table
-The following commands are only available in Char mode:
+ The following commands are only available in char mode:
+
@table @kbd
@item C-c C-c
Send a literal @key{C-c} to the sub-shell.
@end table
@node Paging in Term
-@subsection Paging in the terminal emulator
+@subsection Page-At-A-Time Output
+@cindex page-at-a-time
-Term mode has a pager feature. When the pager is enabled,
-term mode will pause at the end of each screenful.
+ Term mode has a page-at-a-time feature. When enabled it makes
+output pause at the end of each screenful.
@table @kbd
@kindex C-c C-q @r{(Term mode)}
@findex term-pager-toggle
@item C-c C-q
-Toggles the pager feature: Disables the pager if it is enabled,
-and vice versa. This works in both line and char modes.
-If the pager enabled, the mode-line contains the word @samp{page}.
+Toggle the page-at-a-time feature. This command works in both line
+and char modes. When page-at-a-time is enabled, the mode-line
+displays the word @samp{page}.
@end table
-If the pager is enabled, and Term receives more than a screenful
-of output since your last input, Term will enter More break mode.
-This is indicated by @samp{**MORE**} in the mode-line.
-Type a @kbd{Space} to display the next screenful of output.
-Type @kbd{?} to see your other options. The interface is similar
-to the Unix @code{more} program.
+ With page-at-a-time enabled, whenever Term receives more than a
+screenful of output since your last input, it pauses, displaying
+@samp{**MORE**} in the mode-line. Type @key{SPC} to display the next
+screenful of output. Type @kbd{?} to see your other options. The
+interface is similar to the @code{more} program.
@node Remote Host
@subsection Remote Host Shell
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
-echoing of the password, so the password will not show up in the buffer.
-This will happen just as if you were using a real terminal, if
-the buffer is in char mode. If it is in line mode, the password
-will be temporarily visible, but will be erased when you hit return.
-(This happens automatically; there is no special password processing.)
+ A program that asks you for a password will normally suppress
+echoing of the password, so the password will not show up in the
+buffer. This will happen just as if you were using a real terminal,
+if the buffer is in char mode. If it is in line mode, the password is
+temporarily visible, but will be erased when you hit return. (This
+happens automatically; there is no special password processing.)
-When you log in to a different machine, you need to specify the
-type of terminal your using. Terminal types @samp{ansi}
-or @samp{vt100} will work on most systems.
+ When you log in to a different machine, you need to specify the type
+of terminal you're using. Terminal types @samp{ansi} or @samp{vt100}
+will work on most systems.
@c If you are talking to a Bourne-compatible
@c shell, and your system understands the @env{TERMCAP} variable,
@c whether or not gdb is running on a different computer than Emacs,
@c as long as Emacs can access the source files specified by gdb.
-You cannot log into to a remove comuter using the Shell mode.
+@ignore
+ You cannot log in to a remote computer using the Shell mode.
@c (This will change when Shell is re-written to use Term.)
Instead, Emacs provides two commands for logging in to another computer
-and communicating with it through an Emacs buffer.
+and communicating with it through an Emacs buffer using Comint mode:
@table @kbd
@item M-x telnet @key{RET} @var{hostname} @key{RET}
argument means use local names, and a negative argument means turn
off directory tracking.
+@end ignore
+
@node Emacs Server, Hardcopy, Shell, Top
@section Using Emacs as a Server
@pindex emacsclient
@env{EDITOR} to @samp{emacs}, they invoke Emacs---but in an
inconvenient fashion, by starting a new, separate Emacs process. This
is inconvenient because it takes time and because the new Emacs process
-doesn't share the buffers in the existing Emacs process.
+doesn't share the buffers in any existing Emacs process.
You can arrange to use your existing Emacs process as the editor for
programs like @code{mail} by using the Emacs client and Emacs server
to exit. @kbd{C-x #} also checks for other pending external requests
to edit various files, and selects the next such file.
- You can switch to a server buffer manually if you wish; you don't have
-to arrive at it with @kbd{C-x #}. But @kbd{C-x #} is the only way to
-say that you are ``finished'' with one.
+ You can switch to a server buffer manually if you wish; you don't
+have to arrive at it with @kbd{C-x #}. But @kbd{C-x #} is the way to
+say that you are finished with one.
+
+@vindex server-kill-new-buffers
+@vindex server-temp-file-regexp
+ Finishing with a server buffer also kills the buffer, unless it
+already existed in the Emacs session before the server asked to create
+it. However, if you set @code{server-kill-new-buffers} to @code{nil},
+then a different criterion is used: finishing with a server buffer
+kills it if the file name matches the regular expression
+@code{server-temp-file-regexp}. This is set up to distinguish certain
+``temporary'' files.
@vindex server-window
If you set the variable @code{server-window} to a window or a frame,
input. So the terminal that @code{mail} was using is effectively
blocked for the duration. In order to edit with your principal Emacs,
you need to be able to use it without using that terminal. There are
-two ways to do this:
+three ways to do this:
@itemize @bullet
@item
switching windows.
@item
-Use Shell mode in Emacs to run the other program such as @code{mail};
-then, @code{emacsclient} blocks only the subshell under Emacs, and you
-can still use Emacs to edit the file.
-@end itemize
-
-@vindex server-temp-file-regexp
- Some programs write temporary files for you to edit. After you edit
-the temporary file, the program reads it back and deletes it. If the
-Emacs server is later asked to edit the same file name, it should assume
-this has nothing to do with the previous occasion for that file name.
-The server accomplishes this by killing the temporary file's buffer when
-you finish with the file. Use the variable
-@code{server-temp-file-regexp} to specify which files are temporary in
-this sense; its value should be a regular expression that matches file
-names that are temporary.
+Using virtual terminals, run @code{mail} in one virtual terminal
+and run Emacs in another.
-@vindex server-kill-new-buffers
- If the variable @code{server-kill-new-buffers} is set to non-nil,
-buffers which still have a client are killed when you are done with
-them, unless they were already present before Emacs Server visited
-them. This overrides the effect of the @code{server-temp-file-regexp}
-variable. By default, @code{server-kill-new-buffers} has a non-nil
-value; set it to nil if you want the old behavior governed by
-@code{server-temp-file-regexp}.
+@item
+Use Shell mode or Term mode in Emacs to run the other program such as
+@code{mail}; then, @code{emacsclient} blocks only the subshell under
+Emacs, and you can still use Emacs to edit the file.
+@end itemize
If you run @code{emacsclient} with the option @samp{--no-wait}, it
-returns immediately without waiting for you to ``finish'' the buffer in
-Emacs. Note that it this case, buffers for temporary files will not be
-killed automatically with the default value of
-@code{server-kill-new-buffers}, since those buffers will not have a
-client.
-
- If you have forgotten to start Emacs, then the option
-@samp{--alternate-editor=@var{command}} may be useful. It specifies a
-command to run if @code{emacsclient} fails to contact Emacs. For
-example, the following setting for the @var{EDITOR} environment variable
-will always give an editor, even if Emacs is not running.
-
-@example
-EDITOR="emacsclient --alternate-editor vi +%d %s"
-@end example
-
-The environment variable @var{ALTERNATE_EDITOR} has the same effect, but
-the value of the @samp{--alternate-editor} takes precedence.
-
-@pindex emacs.bash
-Alternatively, the file @file{etc/emacs.bash} defines a function for
-@command{bash} which will use a running Emacs server or start one if
-none exists.
+returns immediately without waiting for you to ``finish'' the buffer
+in Emacs. Note that server buffers created in this way are not killed
+automatically when you finish with them.
@menu
* Invoking emacsclient::
and optionally line numbers as well. Do it like this:
@example
-emacsclient @r{@{}@r{[}+@var{line}@r{]} @var{filename}@r{@}}@dots{}
+emacsclient @r{@{}@r{[}+@var{line}@r{[}@var{column}@r{]}@r{]} @var{filename}@r{@}}@dots{}
@end example
+@noindent
This tells Emacs to visit each of the specified files; if you specify a
line number for a certain file, Emacs moves to that line in the file.
+If you specify a column number as well, Emacs puts point on that column
+in the line.
-Ordinarily, @code{emacsclient} does not return until you use the
-@kbd{C-x #} command on each of these buffers. When that happens, Emacs
-sends a message to the @code{emacsclient} program telling it to return.
+ Ordinarily, @code{emacsclient} does not return until you use the
+@kbd{C-x #} command on each of these buffers. When that happens,
+Emacs sends a message to the @code{emacsclient} program telling it to
+return.
-But if you use the option @samp{-n} or @samp{--no-wait} when running
-@code{emacsclient}, then it returns immediately. (You can take as long
-as you like to edit the files in Emacs.)
+ But if you use the option @samp{-n} or @samp{--no-wait} when running
+@code{emacsclient}, then it returns immediately. (You can take as
+long as you like to edit the files in Emacs.)
+ The option @samp{--alternate-editor=@var{command}} is useful when
+running @code{emacsclient} in a script. It specifies a command to run
+if @code{emacsclient} fails to contact Emacs. For example, the
+following setting for the @var{EDITOR} environment variable will
+always give an editor, even if Emacs is not running:
+
+@example
+EDITOR="emacsclient --alternate-editor vi +%d %s"
+@end example
+
+@noindent
+The environment variable @var{ALTERNATE_EDITOR} has the same effect, but
+the value of the @samp{--alternate-editor} takes precedence.
+
+@pindex emacs.bash
+ Alternatively, the file @file{etc/emacs.bash} defines a bash
+function which will communicate with a running Emacs server, or start
+one if none exists.
+
+If you use several displays, you can tell Emacs on which display to
+open the given files with the option @samp{--display=@var{DISPLAY}}.
+This can be used typically when connecting from home to an Emacs
+server running on your machine at your workplace.
+
+You can also use @code{emacsclient} to execute any piece of Emacs Lisp
+code, using the option @samp{--eval}. When this option is given, the
+rest of the arguments is not taken as a list of files to visit but as
+a list of expressions to evaluate.
@node Hardcopy, PostScript, Emacs Server, Top
@section Hardcopy Output
@cindex handwriting
@kbd{M-x handwrite} is more frivolous. It generates a PostScript
rendition of the current buffer as a cursive handwritten document. It
-can be customized in group @code{handwrite}.
+can be customized in group @code{handwrite}. This function only
+supports ISO 8859-1 characters.
@ifinfo
The following section describes variables for customizing these commands.
is @code{nil}, @code{printer-name} is used.
@vindex ps-print-header
-@vindex ps-print-color-p
The variable @code{ps-print-header} controls whether these commands
add header lines to each page---set it to @code{nil} to turn headers
-off. You can turn off color processing by setting
-@code{ps-print-color-p} to @code{nil}.
+off.
+
+@cindex color emulation on black-and-white printers
+@vindex ps-print-color-p
+ If your printer doesn't support colors, you should turn off color
+processing by setting @code{ps-print-color-p} to @code{nil}. By
+default, if the display supports colors, Emacs produces hardcopy output
+with color information; on black-and-white printers, colors are emulated
+with shades of gray. This might produce illegible output, even if your
+screen colors only use shades of gray.
+
+@vindex ps-use-face-background
+ By default, PostScript printing ignores the background colors of the
+faces, unless the variable @code{ps-use-face-background} is
+non-@code{nil}. This is to avoid unwanted interference with the zebra
+stripes and background image/text.
@vindex ps-paper-type
@vindex ps-page-dimensions-database
@code{Times}. The variable @code{ps-font-size} specifies the size of
the font for ordinary text. It defaults to 8.5 points.
+@vindex ps-multibyte-buffer
+@cindex Intlfonts for PostScript printing
+@cindex fonts for PostScript printing
+ Emacs supports more scripts and characters than a typical PostScript
+printer. Thus, some of the characters in your buffer might not be
+printable using the fonts built into your printer. You can augment
+the fonts supplied with the printer with those from the GNU Intlfonts
+package, or you can instruct Emacs to use Intlfonts exclusively. The
+variable @code{ps-multibyte-buffer} controls this: the default value,
+@code{nil}, is appropriate for printing ASCII and Latin-1
+characters; a value of @code{non-latin-printer} is for printers which
+have the fonts for ASCII, Latin-1, Japanese, and Korean
+characters built into them. A value of @code{bdf-font} arranges for
+the BDF fonts from the Intlfonts package to be used for @emph{all}
+characters. Finally, a value of @code{bdf-font-except-latin}
+instructs the printer to use built-in fonts for ASCII and Latin-1
+characters, and Intlfonts BDF fonts for the rest.
+
+@vindex bdf-directory-list
+ To be able to use the BDF fonts, Emacs needs to know where to find
+them. The variable @code{bdf-directory-list} holds the list of
+directories where Emacs should look for the fonts; the default value
+includes a single directory @file{/usr/local/share/emacs/fonts/bdf}.
+
Many other customization variables for these commands are defined and
-described in the Lisp file @file{ps-print.el}.
+described in the Lisp files @file{ps-print.el} and @file{ps-mule.el}.
@node Sorting, Narrowing, PostScript Variables, Top
@section Sorting Text
field 1, etc. A negative argument means count fields from the right
instead of from the left; thus, minus 1 means sort by the last field.
If several lines have identical contents in the field being sorted, they
-keep same relative order that they had in the original buffer.
+keep the same relative order that they had in the original buffer.
@item M-x sort-numeric-fields
Like @kbd{M-x sort-fields} except the specified field is converted
columns by putting point at one of the columns and the mark at the other
column. Because this means you cannot put point or the mark at the
beginning of the first line of the text you want to sort, this command
-uses an unusual definition of `region': all of the line point is in is
+uses an unusual definition of ``region'': all of the line point is in is
considered part of the region, and so is all of the line the mark is in,
as well as all the lines in between.
paragraph by eliminating clutter. It can also be used to restrict the
range of operation of a replace command or repeating keyboard macro.
-@c WideCommands
@table @kbd
@item C-x n n
Narrow down to between point and mark (@code{narrow-to-region}).
@findex narrow-to-region
The primary narrowing command is @kbd{C-x n n} (@code{narrow-to-region}).
It sets the current buffer's restrictions so that the text in the current
-region remains accessible but all text before the region or after the region
-is inaccessible. Point and mark do not change.
+region remains accessible, but all text before the region or after the
+region is inaccessible. Point and mark do not change.
@kindex C-x n p
@findex narrow-to-page
@end table
@noindent
-Other Hexl commands let you insert strings (sequences) of binary bytes,
-move by short's or int's, etc.; type @kbd{C-h a hexl- RET} for details.
+Other Hexl commands let you insert strings (sequences) of binary
+bytes, move by @code{short}s or @code{int}s, etc.; type @kbd{C-h a
+hexl-@key{RET}} for details.
@node Saving Emacs Sessions, Recursive Edit, Editing Binary Files, Top
@section Saving Emacs Sessions
@cindex saving sessions
+@cindex restore session
+@cindex remember editing session
+@cindex reload files
@cindex desktop
You can use the Desktop library to save the state of Emacs from one
@vindex save-place
@cindex Saveplace
@findex toggle-save-place
-There is a simpler mechanism provided by Saveplace library which records
-your position in each file when you kill its buffer (or kill Emacs), and
+ The Saveplace library provides a simpler feature that records your
+position in each file when you kill its buffer (or kill Emacs), and
jumps to the same position when you visit the file again (even in
another Emacs session). Use @kbd{M-x toggle-save-place} to turn on
-place-saving in a given file. Customize the option @code{save-place} to
-turn it on for all files in each session.
+place-saving in a given file. Customize the option @code{save-place}
+to turn it on for all files in each session.
@node Recursive Edit, Emulation, Saving Emacs Sessions, Top
@section Recursive Editing Levels
The mode line shows you when you are in a recursive edit by displaying
square brackets around the parentheses that always surround the major and
-minor mode names. Every window's mode line shows this, in the same way,
+minor mode names. Every window's mode line shows this in the same way,
since being in a recursive edit is true of Emacs as a whole rather than
any particular window or buffer.
@cindex other editors
@cindex EDT
@cindex vi
-@cindex CRiSP
-@cindex Brief
-@cindex PC keybindings
+@cindex PC key bindings
@cindex scrolling all windows
-@cindex PC selecion
-@cindex Motif keybindings
-@cindex Macintosh keybindings
+@cindex PC selection
+@cindex Motif key bindings
+@cindex Macintosh key bindings
@cindex WordStar
GNU Emacs can be programmed to emulate (more or less) most other
@findex scroll-all-mode
@cindex CRiSP mode
@cindex Brief emulation
+@cindex emulation of Brief
@cindex mode, CRiSP
-You can turn on keybindings to emulate the CRiSP/Brief editor with
+You can turn on key bindings to emulate the CRiSP/Brief editor with
@kbd{M-x crisp-mode}. Note that this rebinds @kbd{M-x} to exit Emacs
unless you change the user option @code{crisp-override-meta-x}. You can
also use the command @kbd{M-x scroll-all-mode} or set the user option
are done in the global keymap, so there is no problem switching
buffers or major modes while in EDT emulation.
-@item `PC' bindings
+@item ``PC'' bindings
@findex pc-bindings-mode
-@cindex `PC' key bindings
-The command @kbd{M-x pc-bindings-mode} sets up certain key bindings for
-`PC compatibility'---what people are often used to on PCs---as follows:
-@kbd{Delete} and its variants) delete forward instead of backward,
-@kbd{C-Backspace} kills backward a word (as @kbd{C-Delete} normally
-would), @kbd{M-Backspace} does undo, @kbd{Home} and @kbd{End} move to
-beginning and end of line, @kbd{C-Home} and @kbd{C-End} move to
-beginning and end of buffer and @kbd{C-Escape} does @code{list-buffers}.
+@cindex ``PC'' key bindings
+The command @kbd{M-x pc-bindings-mode} sets up certain key bindings
+for ``PC compatibility''---what people are often used to on PCs---as
+follows: @kbd{Delete} and its variants delete forward instead of
+backward, @kbd{C-Backspace} kills backward a word (as @kbd{C-Delete}
+normally would), @kbd{M-Backspace} does undo, @kbd{Home} and @kbd{End}
+move to beginning and end of line, @kbd{C-Home} and @kbd{C-End} move
+to beginning and end of buffer and @kbd{C-Escape} does
+@code{list-buffers}.
@item PC Selection mode
@findex pc-selection-mode
@cindex PC Selection minor mode
@cindex mode, PC selection
-@cindex selection, `PC'
-The command @kbd{M-x pc-selction-mode} turns on a global minor mode
-which emulates the mark, copy, cut and paste
-look-and-feel of Motif programs (which is the same as the Macintosh GUI
-and MS-Windows). It makes the keybindings of PC mode and also modifies
-the bindings of the cursor keys and the @kbd{next}, @kbd{prior},
-@kbd{home} and @kbd{end} keys. It does not provide the full set of CUA
-keybindings---the fundamental Emacs keys @kbd{C-c}, @kbd{C-v} and
-@kbd{C-x} are not rebound.
-
-The standard keys for moving around (@kbd{right}, @kbd{left}, @kbd{up},
-@kbd{down}, @kbd{home}, @kbd{end}, @kbd{prior}, @kbd{next}, called
-``move-keys'') will always de-activate the mark. Using @kbd{Shift}
-together with the ``move keys'' activates the region over which they
-move. The copy, cut and paste functions (as in many other programs)
-operate on the active region, bound to @kbd{C-insert}, @kbd{S-delete}
-and @kbd{S-insert} respectively.
+@cindex selection, PC
+The command @kbd{M-x pc-selection-mode} toggles a global minor mode
+that emulates the mark, copy, cut and paste commands of various other
+systems---an interface known as CUA. It establishes the key bindings
+of PC mode, and also modifies the bindings of the cursor keys and the
+@kbd{next}, @kbd{prior}, @kbd{home} and @kbd{end} keys. It does not
+provide the full set of CUA key bindings---the fundamental Emacs keys
+@kbd{C-c}, @kbd{C-v} and @kbd{C-x} are not changed.
+
+The standard keys for moving around (@kbd{right}, @kbd{left},
+@kbd{up}, @kbd{down}, @kbd{home}, @kbd{end}, @kbd{prior}, @kbd{next},
+called ``move-keys'') deactivate the mark in PC selection mode.
+However, using @kbd{Shift} together with the ``move keys'' activates
+the region over which they move. The copy, cut and paste functions
+are available on @kbd{C-insert}, @kbd{S-delete} and @kbd{S-insert}
+respectively.
+
+Turning @code{pc-selection-mode} off restores the old key bindings of
+these keys.
@cindex s-region package
The @code{s-region} package provides similar, but less complete,
@item WordStar (old wordprocessor)
@findex wordstar-mode
@kbd{M-x wordstar-mode} provides a major mode with WordStar-like
-keybindings.
+key bindings.
@end table
@node Hyperlinking, Dissociated Press, Emulation, Top
@section Hyperlinking and Navigation Features
@cindex hyperlinking
-@cindex URLs
@cindex navigation
-Various modes documented elsewhere have hypertext features whereby you
-can follow links, usually with @kbd{mouse-2} or @kbd{RET} on the text of
-the link. Info mode, Help mode and the Dired-like modes are examples.
-The Tags facility links between uses and definitions in source files,
-see @ref{Tags}. Imenu provides navigation amongst items indexed in the
-current buffer, see @ref{Imenu}. Info-lookup provides mode-specific
-lookup of definitions in Info indexes, see @ref{Documentation}.
-Speedbar maintains a frame in which links to files, and locations in
-files are displayed, see @ref{Speedbar}.
-
-Other non-mode-specific facilities described in this section enable
-following links from the current buffer in a context-sensitive fashion.
+ Various modes documented elsewhere have hypertext features so that
+you can follow links, usually by clicking @kbd{Mouse-2} on the link or
+typing @key{RET} while point is on the link. Info mode, Help mode and
+the Dired-like modes are examples. The Tags facility links between
+uses and definitions in source files, see @ref{Tags}. Imenu provides
+navigation amongst items indexed in the current buffer, see
+@ref{Imenu}. Info-lookup provides mode-specific lookup of definitions
+in Info indexes, see @ref{Documentation}. Speedbar maintains a frame
+in which links to files, and locations in files are displayed, see
+@ref{Speedbar}.
+
+ Other non-mode-specific facilities described in this section enable
+following links from the current buffer in a context-sensitive
+fashion.
@menu
* Browse-URL:: Following URLs.
@cindex URLs
@table @kbd
-@item M-x browse-url @key{RET} @var{url} @key{ret}
+@item M-x browse-url @key{RET} @var{url} @key{RET}
Load a URL into a Web browser.
@end table
The Browse-URL package provides facilities for following URLs specifying
links on the World Wide Web. Usually this works by invoking a web
-browser but you can, for instance, arrange to invoke @code{compose-mail}
-from @samp{mailto:} URLs. Packages such as Gnus may make active links
-from URLs themselves. Otherwise you can use @kbd{M-x browse-url} to
-follow a link, defaulting to the URL at point. Other commands are
-available which you might like to bind to keys, such as
+browser, but you can, for instance, arrange to invoke @code{compose-mail}
+from @samp{mailto:} URLs.
+
+ The general way to use this feature is to type @kbd{M-x browse-url},
+which displays a specified URL. If point is located near a plausible
+URL, that URL is used as the default. Other commands are available
+which you might like to bind to keys, such as
@code{browse-url-at-point} and @code{browse-url-at-mouse}.
@vindex browse-url-browser-function
-You can customize Browse-URL's behaviour via various options in the
+ You can customize Browse-URL's behavior via various options in the
@code{browse-url} Customize group, particularly
-@code{browse-url-browser-function}. You can invoke actions dependent on
-the type of URL by defining @code{browse-url-browser-function} as an
-association list. The package's commentary available via @kbd{C-h p}
-provides more information. Packages with facilities for following URLs
-should use Browse-URL, so customizing options in the @code{browse-url}
-group should be sufficient to determine how they all work in that
-respect.
+@code{browse-url-browser-function}. You can invoke actions dependent
+on the type of URL by defining @code{browse-url-browser-function} as
+an association list. The package's commentary available via @kbd{C-h
+p} provides more information. Packages with facilities for following
+URLs should always go through Browse-URL, so that the customization
+options for Browse-URL will affect all browsing in Emacs.
@node Goto-address
@subsection Activating URLs
Activate URLs and e-mail addresses in the current buffer.
@end table
-You can arrange to activate URLs in any buffer with @kbd{M-x
-goto-address}. It may be useful to add @code{goto-address} to hooks
-invoked when buffers are displayed in particular modes.
-@code{rmail-show-message-hook} is the appropriate hook if you use Rmail,
-or @code{mh-show-mode-hook} if you use MH.
+ You can make URLs in the current buffer active with @kbd{M-x
+goto-address}. This finds all the URLs in the buffer, and establishes
+bindings for @kbd{Mouse-2} and @kbd{C-c @key{RET}} on them. After
+activation, if you click on a URL with @kbd{Mouse-2}, or move to a URL
+and type @kbd{C-c @key{RET}}, that will display the web page that the URL
+specifies. For a @samp{mailto} URL, it sends mail instead, using your
+selected mail-composition method (@pxref{Mail Methods}).
+
+ It can be useful to add @code{goto-address} to mode hooks and the
+hooks used to display an incoming message.
+@code{rmail-show-message-hook} is the appropriate 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.
+
@node FFAP
@subsection Finding Files and URLs at Point
-@findex ffap
@findex find-file-at-point
@findex ffap
@findex ffap-dired-at-point
@findex ffap-next
@findex ffap-menu
-@cindex FFAP
-@cindex URLs
@cindex finding file at point
-@table @kbd
-@item M-x ffap @key{RET} @var{filename} @key{RET}
-Find @var{filename}, guessing a default from text around point.
-@item M-x ffap-next
-Search buffer for next file or URL, and run `ffap'. With single prefix
-arg, search backwards, with double arg wrap search forwards, with triple
-arg wrap search backwards.
-@item M-x ffap-menu
-Put up a menu of files and URLs mentioned in current buffer and try to
-fetch the selected one.
-@item M-x ffap-dired-at-point
-Start Dired, defaulting to file at point.
-@end table
+ FFAP mode replaces certain key bindings for finding files, including
+@kbd{C-x C-f}, with commands that provide more sensitive defaults.
+These commands behave like the ordinary ones when given a prefix
+argument. Otherwise, they get the default file name or URL from the
+text around point. If what is found in the buffer has the form of a
+URL rather than a file name, the commands use @code{browse-url} to
+view it.
-The command @kbd{M-x find-file-at-point} (or @kbd{M-x ffap}) can be used
-as a replacement for @kbd{M-x find-file}. With a prefix argument it
-behaves as @kbd{M-x find-file}. Otherwise it tries to guess a default
-file or URL from the text around point. In the case of a URL, it will
-invoke @code{browse-url} rather than finding a file. This is useful for
-following references in mail or news buffers, @file{README}s,
-@file{MANIFEST}s, and so on. The @samp{ffap} package's
-commentary available via @kbd{C-h p} and the @code{ffap} Custom group
-provide details.
+ This feature is useful for following references in mail or news
+buffers, @file{README} files, @file{MANIFEST} files, and so on. The
+@samp{ffap} package's commentary available via @kbd{C-h p} and the
+@code{ffap} Custom group provide details.
@cindex FFAP minor mode
@findex ffap-mode
-You can turn on FFAP minor mode to make the following key bindings and
-to install hooks for using @code{ffap} in Rmail, Gnus and VM article
-buffers.
+ You can turn on FFAP minor mode to make the following key bindings
+and to install hooks for using @code{ffap} in Rmail, Gnus and VM
+article buffers.
@table @kbd
-@item C-x C-f
+@item C-x C-f @var{filename} @key{RET}
@kindex C-x C-f @r{(FFAP)}
-@kbd{find-file-at-point};
+Find @var{filename}, guessing a default from text around point
+(@code{find-file-at-point}).
@item C-x 4 f
@kindex C-x 4 f @r{(FFAP)}
-@code{ffap-other-window}, analagous to @kbd{M-x find-file-other-window};
+@code{ffap-other-window}, analogous to @code{find-file-other-window}.
@item C-x 5 f
@kindex C-x 5 f @r{(FFAP)}
-@code{ffap-other-frame}, analagous to @kbd{M-x find-file-other-frame};
-@item C-x d
+@code{ffap-other-frame}, analogous to @code{find-file-other-frame}.
+@item M-x ffap-next
+Search buffer for next file name or URL, then find that file or URL.
+@item C-x d @var{directory} @key{RET}
@kindex C-x d @r{(FFAP)}
-@code{ffap-dired-at-point}, analogous to @kbd{M-x dired};
-@item S-mouse-3
-@kindex S-mouse-3 @r{(FFAP)}
+Start Dired on @var{directory}, defaulting to the directory name at
+point (@code{ffap-dired-at-point}).
+@item S-Mouse-3
+@kindex S-Mouse-3 @r{(FFAP)}
@code{ffap-at-mouse} finds the file guessed from text around the position
-of a mouse click;
-@item C-S-mouse-3
-@kindex C-S-mouse-3 @r{(FFAP)}
-@code{ffap-menu} puts up a selectable menu of files and URLs mentioned in
-the current buffer.
+of a mouse click.
+@item C-S-Mouse-3
+@kindex C-S-Mouse-3 @r{(FFAP)}
+Display a menu of files and URLs mentioned in current buffer, then
+find the one you select (@code{ffap-menu}).
@end table
@node Find-func
@subsection Finding Function and Variable Definitions
-@findex find-function
-@findex find-function-on-key
-@findex find-variable
-@cindex examples of Lisp functions
-@cindex Lisp examples
-@cindex Find-func
-@cindex Lisp definitions
-@cindex definitions, locating in sources
-@cindex tags
+@cindex definitions, finding in Lisp sources
+@cindex Lisp definitions, finding in sources
@table @kbd
@item M-x find-function @key{RET} @var{function} @key{RET}
-Find the definition of the @var{function} at point.
+Find the definition of @var{function} in its source file.
@item M-x find-variable @key{RET} @var{variable} @key{RET}
-Find the definition of the @var{variable} at point.
-@item M-x find-function-on-key @var{key}
+Find the definition of @var{variable} in its source file.
+@item M-x find-function-on-key @key{RET} @var{key}
Find the definition of the function that @var{key} invokes.
@end table
-The Find-func package provides convenient facilities for finding the
-definitions of Emacs Lisp functions and variables. It has a somewhat
-similar function to the Tags facility (@pxref{Tags}) but uses Emacs's
-introspective facilities which maintain information about loaded
-libraries. In contrast to Tags, it only works for functions and
-variables with definitions which are already loaded but it relates to
-the code actually running and doesn't require maintaining tags files.
-
-You need to have the Lisp source (@samp{.el}) files available on your
-load path along with the compiled (@samp{.elc}) versions for this to
-work. You can use compressed source files if you turn on
-@code{auto-compression-mode}.
-
-The commands available include @kbd{M-x find-function} to find the
-definition of a named function, @kbd{find-function-on-key} to find the
-definition of the function bound to a key and @kbd{find-variable} to
-find a variable's definition. These only work for things defined in
-Lisp source files, not primitive functions or variables defined
-primitively in the Emacs layer implemented in C.
-
-Find-func is useful for finding examples of how to do things if you want
-to write an Emacs Lisp extension similar to some existing function.
+ These commands provide an easy way to find the definitions of Emacs
+Lisp functions and variables. They are similar in purpose to the Tags
+facility (@pxref{Tags}), but don't require a tags table; on the other
+hand, they only work for function and variable definitions that are
+already loaded in the Emacs session.
+
+@findex find-function
+@findex find-function-on-key
+@findex find-variable
+ To find the definition of a function, use @kbd{M-x find-function}.
+@kbd{M-x find-variable} finds the definition of a specified variable.
+@kbd{M-x find-function-on-key} finds the definition of the function
+bound to a specified key.
+
+ To use these commands, you must have the Lisp source (@samp{.el})
+files available along with the compiled (@samp{.elc}) files, in
+directories in @code{load-path}. You can use compressed source files
+if you enable Auto Compression mode. These commands only handle
+definitions written in Lisp, not primitive functions or variables
+defined in the C code of Emacs.
@node Dissociated Press, Amusements, Hyperlinking, Top
@section Dissociated Press
buffer to another. In order to produce plausible output rather than
gibberish, it insists on a certain amount of overlap between the end of
one run of consecutive words or characters and the start of the next.
-That is, if it has just printed out `president' and then decides to jump
+That is, if it has just output `president' and then decides to jump
to a different point in the file, it might spot the `ent' in `pentagon'
and continue from there, producing `presidentagon'.@footnote{This
dissociword actually appeared during the Vietnam War, when it was very
@cindex tower of Hanoi
If you are a little bit bored, you can try @kbd{M-x hanoi}. If you are
-considerably bored, give it a numeric argument. If you are very very
+considerably bored, give it a numeric argument. If you are very, very
bored, try an argument of 9. Sit back and watch.
@cindex Go Moku
@findex life
@cindex Life
-@kbd{M-x life} runs Conway's `Life' cellular automaton.
+@kbd{M-x life} runs Conway's ``Life'' cellular automaton.
@findex morse-region
@findex unmorse-region
@findex pong
@cindex Pong game
-@kbd{M-x pong} plays an implementation of the game Pong, bouncing the
-ball off opposing bats.
+@kbd{M-x pong} plays a Pong-like game, bouncing the ball off opposing
+bats.
@findex solitaire
@cindex solitaire
@findex studlify-region
@cindex StudlyCaps
-@kbd{M-x studlify-region} studlify-cases the region, that is
+@kbd{M-x studlify-region} studlify-cases the region, producing
+text like this:
@example
M-x stUdlIfY-RegioN stUdlIfY-CaSeS thE region.
@findex tetris
@cindex Tetris
-@kbd{M-x tetris} runs an implementation of the well-known Tetris game.
@findex snake
@cindex Snake
+@kbd{M-x tetris} runs an implementation of the well-known Tetris game.
Likewise, @kbd{M-x snake} provides an implementation of Snake.
When you are frustrated, try the famous Eliza program. Just do
HCoop / bpt / emacs.git / blobdiff