aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGerd Moellmann <[email protected]>2000-05-23 11:12:04 +0000
committerGerd Moellmann <[email protected]>2000-05-23 11:12:04 +0000
commit60a963715f5bd6e456da0062a3cc636660ac9804 (patch)
tree4ffae71f6368faf7d61a9c4781d6e7dca1df2250
parentd23ee514831a01d1d36d18de2bae63e7373b807f (diff)
*** empty log message ***
-rw-r--r--man/ChangeLog9
-rw-r--r--man/cmdargs.texi38
-rw-r--r--man/custom.texi8
-rw-r--r--man/ebrowse.texi318
-rw-r--r--man/ediff.texi20
-rw-r--r--man/entering.texi8
-rw-r--r--man/files.texi10
-rw-r--r--man/frames.texi2
-rw-r--r--man/misc.texi34
-rw-r--r--man/msdog.texi10
-rw-r--r--man/mule.texi2
-rw-r--r--man/programs.texi2
-rw-r--r--man/rmail.texi8
-rw-r--r--man/sending.texi4
-rw-r--r--man/text.texi4
-rw-r--r--man/trouble.texi10
16 files changed, 261 insertions, 226 deletions
diff --git a/man/ChangeLog b/man/ChangeLog
index 5116212a9f..a5bd422b27 100644
--- a/man/ChangeLog
+++ b/man/ChangeLog
@@ -1,9 +1,16 @@
-2000-05-20 Karl Eichwalder <[email protected]>
+2000-05-23 Gerd Moellmann <[email protected]>
* cmdargs.texi, custom.texi, dired-x.texi, ediff.texi,
entering.texi, files.texi, frames.texi, misc.texi, msdog.texi,
mule.texi, programs.texi, rmail.texi, sending.texi, text.texi,
trouble.texi: Fix markup; mostly replace @code with @env.
+
+ * ebrowse.texi: Use @command. Change title page.
+
+2000-05-23 Eli Zaretskii <[email protected]>
+
+ * ebrowse.texi: Various markup and index fixes. Changes for
+ MS-DOS.
2000-05-11 Gerd Moellmann <[email protected]>
diff --git a/man/cmdargs.texi b/man/cmdargs.texi
index 887fe34f94..b82649aa2f 100644
--- a/man/cmdargs.texi
+++ b/man/cmdargs.texi
@@ -91,7 +91,7 @@ Visit @var{file} using @code{find-file}, then go to line number
Load a Lisp library named @var{file} with the function @code{load}.
@xref{Lisp Libraries}. The library can be found either in the current
directory, or in the Emacs library search path as specified
-with @code{EMACSLOADPATH} (@pxref{General Variables}).
+with @env{EMACSLOADPATH} (@pxref{General Variables}).
@item -f @var{function}
@itemx --funcall=@var{function}
@@ -140,7 +140,7 @@ the initial Emacs frame.
@item -nw
@itemx --no-windows
-Don't communicate directly with X, disregarding the @code{DISPLAY}
+Don't communicate directly with X, disregarding the @env{DISPLAY}
environment variable even if it is set.
@need 3000
@@ -186,10 +186,10 @@ Enable the Emacs Lisp debugger for errors in the init file.
Set up to do almost everything with single-byte buffers and strings.
All buffers and strings are unibyte unless you (or a Lisp program)
explicitly ask for a multibyte buffer or string. Setting the
-environment variable @code{EMACS_UNIBYTE} has the same effect.
+environment variable @env{EMACS_UNIBYTE} has the same effect.
@item --multibyte
-Inhibit the effect of @code{EMACS_UNIBYTE}, so that Emacs
+Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs
uses multibyte characters by default, as usual.
@end table
@@ -240,7 +240,7 @@ within the shell that is the parent of the Emacs job. This is why
@code{edit} is an alias rather than a program or a shell script. It is
not possible to implement a resumption command that could be run from
other subjobs of the shell; no way to define a command that could be
-made the value of @code{EDITOR}, for example. Therefore, this feature
+made the value of @env{EDITOR}, for example. Therefore, this feature
does not take the place of the Emacs Server feature (@pxref{Emacs
Server}).
@@ -264,7 +264,7 @@ conventional to use upper case letters only.
Because environment variables come from the operating system there is no
general way to set them; it depends on the operating system and
especially the shell that you are using. For example, here's how to set
-the environment variable @code{ORGANIZATION} to @samp{not very much}
+the environment variable @env{ORGANIZATION} to @samp{not very much}
using bash:
@example
@@ -290,7 +290,7 @@ the X documentation for more information.
@node General Variables
@appendixsubsec General Variables
-@table @code
+@table @env
@item AUTHORCOPY
The name of a file used to archive news articles posted with the @sc{gnus}
package.
@@ -322,7 +322,7 @@ overrides the setting in @file{paths.h} when Emacs was built.
The location of Emacs-specific binaries. Setting this variable
overrides the setting in @file{paths.h} when Emacs was built.
@item ESHELL
-Used for shell-mode to override the @code{SHELL} environment variable.
+Used for shell-mode to override the @env{SHELL} environment variable.
@item HISTFILE
The name of the file that shell commands are saved in between logins.
This variable defaults to @file{~/.history} if you use (t)csh as shell,
@@ -355,7 +355,7 @@ entries in @code{locale-language-names},
environment and coding system. The first of these environment variables
with a nonempty value specifies the locale.
@item LOGNAME
-The user's login name. See also @code{USER}.
+The user's login name. See also @env{USER}.
@item MAIL
The name of the user's system mail inbox.
@item MAILRC
@@ -394,7 +394,7 @@ set unless Emacs is run in batch mode. On MS-DOS, it defaults to
handles the machine's own display.
@item TERMCAP
The name of the termcap library file describing how to program the
-terminal specified by the @code{TERM} variable. This defaults to
+terminal specified by the @env{TERM} variable. This defaults to
@file{/etc/termcap}.
@item TMPDIR
Used by the Emerge package as a prefix for temporary files.
@@ -403,7 +403,7 @@ This specifies the current time zone and possibly also daylight savings
information. On MS-DOS, the default is based on country code; see the
file @file{msdos.c} for details.
@item USER
-The user's login name. See also @code{LOGNAME}. On MS-DOS, this
+The user's login name. See also @env{LOGNAME}. On MS-DOS, this
defaults to @samp{root}.
@item VERSION_CONTROL
Used to initialize the @code{version-control} variable (@pxref{Backup
@@ -415,13 +415,13 @@ Names}).
These variables are used only on particular configurations:
-@table @code
+@table @env
@item COMSPEC
On MS-DOS, the name of the command interpreter to use. This is used to
-make a default value for the @code{SHELL} environment variable.
+make a default value for the @env{SHELL} environment variable.
@item NAME
-On MS-DOS, this variable defaults to the value of the @code{USER}
+On MS-DOS, this variable defaults to the value of the @env{USER}
variable.
@item TEMP
@@ -455,9 +455,9 @@ Used when initializing the Sun windows system.
@node Display X
@appendixsec Specifying the Display Name
@cindex display name (X Windows)
-@cindex @code{DISPLAY} environment variable
+@cindex @env{DISPLAY} environment variable
- The environment variable @code{DISPLAY} tells all X clients, including
+ The environment variable @env{DISPLAY} tells all X clients, including
Emacs, where to display their windows. Its value is set up by default
in ordinary circumstances, when you start an X server and run jobs
locally. Occasionally you may need to specify the display yourself; for
@@ -470,7 +470,7 @@ window displayed at their local terminal. You might need to use login
to another system because the files you want to edit are there, or
because the Emacs executable file you want to run is there.
- The syntax of the @code{DISPLAY} environment variable is
+ The syntax of the @env{DISPLAY} environment variable is
@samp{@var{host}:@var{display}.@var{screen}}, where @var{host} is the
host name of the X Window System server machine, @var{display} is an
arbitrarily-assigned number that distinguishes your server (X terminal)
@@ -481,10 +481,10 @@ included, @var{screen} is usually zero.
For example, if your host is named @samp{glasperle} and your server is
the first (or perhaps the only) server listed in the configuration, your
-@code{DISPLAY} is @samp{glasperle:0.0}.
+@env{DISPLAY} is @samp{glasperle:0.0}.
You can specify the display name explicitly when you run Emacs, either
-by changing the @code{DISPLAY} variable, or with the option @samp{-d
+by changing the @env{DISPLAY} variable, or with the option @samp{-d
@var{display}} or @samp{--display=@var{display}}. Here is an example:
@smallexample
diff --git a/man/custom.texi b/man/custom.texi
index 9fd6c363cf..891e3e1711 100644
--- a/man/custom.texi
+++ b/man/custom.texi
@@ -2286,7 +2286,7 @@ library. @xref{Hooks}.
@node Find Init
@subsection How Emacs Finds Your Init File
- Normally Emacs uses the environment variable @code{HOME} to find
+ Normally Emacs uses the environment variable @env{HOME} to find
@file{.emacs}; that's what @samp{~} means in a file name. But if you
have done @code{su}, Emacs tries to find your own @file{.emacs}, not
that of the user you are currently pretending to be. The idea is
@@ -2294,9 +2294,9 @@ that you should get your own editor customizations even if you are
running as the super user.
More precisely, Emacs first determines which user's init file to use.
-It gets the user name from the environment variables @code{LOGNAME} and
-@code{USER}; if neither of those exists, it uses effective user-ID.
-If that user name matches the real user-ID, then Emacs uses @code{HOME};
+It gets the user name from the environment variables @env{LOGNAME} and
+@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.
@c LocalWords: backtab
diff --git a/man/ebrowse.texi b/man/ebrowse.texi
index cfafef5c04..89eda96503 100644
--- a/man/ebrowse.texi
+++ b/man/ebrowse.texi
@@ -8,6 +8,7 @@
@setfilename ../info/ebrowse
@settitle A Class Browser for C++
@setchapternewpage odd
+@syncodeindex fn cp
@comment %**end of header
@ifinfo
@@ -24,7 +25,7 @@ this manual provided the copyright notice and this permission notice
are preserved on all copies.
@ignore
-Permission is granted to process this file through Tex and print the
+Permission is granted to process this file through TeX and print the
results, provided the printed document carries copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual).
@@ -45,36 +46,34 @@ translation approved by the Free Software Foundation instead of in the
original English.
@end ifinfo
+@iftex
@titlepage
-@sp 10
-@center @titlefont{A C++ Browser for GNU Emacs}
-@vskip 0pt plus 1filll
-Copyright @copyright{} 1992--1999, 2000 Free Software Foundation, Inc.
-
-Permission is granted to make and distribute verbatim copies of this
-manual provided the copyright notice and this permission notice are
-preserved on all copies.
+@title Ebrowse User's Manual
+@sp 4
+@subtitle Ebrowse/Emacs 21
+@sp 1
+@subtitle May 2000
+@sp 5
+@author Gerd Moellmann
+@page
-Permission is granted to copy and distribute modified versions of this
-manual under the conditions for verbatim copying, provided also that the
-sections entitled ``Distribution'' and ``General Public License'' are
-included exactly as in the original, and provided that the entire
-resulting derived work is distributed under the terms of a permission
-notice identical to this one.
+@vskip 0pt plus 1filll
+@noindent
+Copyright @copyright{} 2000 Free Software Foundation, Inc.
-Permission is granted to copy and distribute translations of this manual
-into another language, under the above conditions for modified versions,
-except that the sections entitled ``Distribution'' and ``General Public
-License'' may be included in a translation approved by the author
-instead of in the original English.
+Permission is granted to make and distribute verbatim copies of
+this manual provided the copyright notice and this permission notice
+are preserved on all copies.
@end titlepage
-
-
+@page
+@end iftex
@node Top, Overview, (dir), (dir)
+@ifnottex
You can browse C++ class hierarchies from within Emacs by using
Ebrowse.
+@end ifnottex
@menu
* Overview:: What is it and now does it work?
@@ -91,11 +90,6 @@ Ebrowse.
@node Overview, Generating browser files, Top, Top
@chapter Introduction
-@cindex tree buffer
-@cindex member buffer
-@cindex major modes
-@cindex parser
-@cindex @samp{*Globals*}
When working in software projects using C++, I frequently missed
software support for two things:
@@ -120,6 +114,7 @@ The design of Ebrowse reflects these two needs.
How does it work?
+@cindex parser for C++ sources
A fast parser written in C is used to process C++ source files.
The parser generates a data base containing information about classes,
members, global functions, defines, types etc. found in the sources.
@@ -129,15 +124,18 @@ the data base generated by the parser. It displays its contents in
various forms and allows you to perform operations on it, or do
something with the help of the knowledge contained in the data base.
+@cindex major modes, of Ebrowse buffers
@dfn{Navigational} use of Ebrowse is centered around two
types of buffers which define their own major modes:
+@cindex tree buffer
@dfn{Tree buffers} are used to view class hierarchies in tree form.
They allow you to quickly find classes, find or view class declarations,
perform operations like query replace on sets of your source files, and
finally tree buffers are used to produce the second buffer form---member
-buffers.
+buffers. @xref{Tree Buffers}.
+@cindex member buffer
Members are displayed in @dfn{member buffers}. Ebrowse
distinguishes between six different types of members; each type is
displayed as a member list of its own:
@@ -168,7 +166,7 @@ You can switch member buffers from one list to another, or to another
class. You can include inherited members in the display, you can set
filters that remove categories of members from the display, and most
importantly you can find or view member declarations and definitions
-with a keystroke.
+with a keystroke. @xref{Member Buffers}.
These two buffer types and the commands they provide support the
navigational use of the browser. The second form resembles Emacs' Tags
@@ -181,7 +179,7 @@ To list just a subset of what you can use the Tags part of Ebrowse for:
@itemize @bullet
@item
Jump to the definition or declaration of an identifier in your source
-code, with an electric position stack that let's you easily navigate
+code, with an electric position stack that lets you easily navigate
back and forth.
@item
@@ -203,16 +201,15 @@ them, if you like.
@node Generating browser files, Loading a Tree, Overview, Top
@comment node-name, next, previous, up
@chapter Processing Source Files
-@cindex command line
-@cindex options
-@cindex switches
-@cindex parser switches
+@cindex @command{ebrowse}, the program
+@cindex class data base creation
Before you can start browsing a class hierarchy, you must run the parser
-@file{ebrowse} on your source files in order to generate a Lisp data
+@command{ebrowse} on your source files in order to generate a Lisp data
base describing your program.
-The operation of @file{ebrowse} can be tailored with command line
+@cindex command line for @command{ebrowse}
+The operation of @command{ebrowse} can be tailored with command line
options. Under normal circumstances it suffices to let the parser use
its default settings. If you want to do that, call it with a command
line like:
@@ -222,7 +219,7 @@ ebrowse *.h *.cc
@end example
@noindent
-or, if your shell doesn't allow all file names to be specified on
+or, if your shell doesn't allow all the file names to be specified on
the command line,
@example
@@ -233,7 +230,8 @@ ebrowse --files=@var{file}
where @var{file} contains the names of the files to be parsed, one
per line.
-When invoked with option @samp{--help}, @file{ebrowse} prints a list of
+@findex --help
+When invoked with option @samp{--help}, @command{ebrowse} prints a list of
available command line options.@refill
@menu
@@ -250,19 +248,15 @@ available command line options.@refill
@comment name, next, prev, up
@node Input files, Output file, Generating browser files, Generating browser files
@section Specifying Input Files
-@cindex input files
-@cindex response files
-@cindex @samp{--files}
-@cindex @samp{--search-path}
-@cindex standard input
-@cindex header files
-@cindex friend functions
@table @samp
+@cindex input files, for @command{ebrowse}
@item file
-Each file name on the command line tells @file{ebrowse} to parse
+Each file name on the command line tells @command{ebrowse} to parse
that file.
+@cindex response files
+@findex --files
@item --files=@var{file}
This command line switch specifies that @var{file} contains a list of
file names to parse. Each line in @var{file} must contain one file
@@ -270,18 +264,22 @@ name. More than one option of this kind is allowed. You might, for
instance, want to use one file for header files, and another for source
files.
+@cindex standard input, specifying input files
@item standard input
-When @file{ebrowse} finds no file names on the command line, and no
+When @command{ebrowse} finds no file names on the command line, and no
@samp{--file} option is specified, it reads file names from standard
-input. This is sometimes convenient when @file{ebrowse} is used as part
+input. This is sometimes convenient when @command{ebrowse} is used as part
of a command pipe.
+@findex --search-path
@item --search-path=@var{paths}
This option let's you specify search paths for your input files.
@var{paths} is a list of directory names, separated from each other by a
either a colon or a semicolon, depending on the operating system.
@end table
+@cindex header files
+@cindex friend functions
It is generally a good idea to specify input files so that header files
are parsed before source files. This facilitates the parser's work of
properly identifying friend functions of a class.
@@ -291,20 +289,18 @@ properly identifying friend functions of a class.
@comment name, next, prev, up
@node Output file, Structs and unions, Input files, Generating browser files
@section Changing the Output File Name
-@cindex output file name
-@cindex @samp{BROWSE}
-@cindex appending output
-@cindex @samp{--output-file}
-@cindex @samp{--append}
@table @samp
+@cindex output file name
+@findex --output-file
+@cindex @file{BROWSE} file
@item --output-file=@var{file}
-This option instructs @file{ebrowse} to generate a Lisp data base with
+This option instructs @command{ebrowse} to generate a Lisp data base with
name @var{file}. By default, the data base is named @file{BROWSE}, and
-is written in the directory in which @file{ebrowse} is invoked.
+is written in the directory in which @command{ebrowse} is invoked.
If you regularly use data base names different from the default, you
-might want to add this to your init file
+might want to add this to your init file:
@lisp
(add-to-list 'auto-mode-alist '(@var{NAME} . ebrowse-tree-mode))
@@ -313,9 +309,11 @@ might want to add this to your init file
@noindent
where @var{NAME} is the Lisp data base name you are using.
+@findex --append
+@cindex appending output to class data base
@item --append
-By default, each run of @file{ebrowse} erases the old contents of the
-output file when writing to it. You can instruct @file{ebrowse} to
+By default, each run of @command{ebrowse} erases the old contents of the
+output file when writing to it. You can instruct @command{ebrowse} to
append its output to an existing file with this command line option.
@end table
@@ -327,9 +325,9 @@ append its output to an existing file with this command line option.
@section Structs and Unions
@cindex structs
@cindex unions
-@cindex @samp{--no-structs-or-unions}
@table @samp
+@findex --no-structs-or-unions
@item --no-structs-or-unions
This switch suppresses all classes in the data base declared as
@code{struct} or @code{union} in the output.
@@ -345,19 +343,14 @@ tree.
@comment name, next, prev, up
@node Matching, Verbosity, Structs and unions, Generating browser files
@section Regular Expressions
-@cindex regular expressions
-@cindex minimum regexp length
-@cindex maximum regexp length
-@cindex @samp{--min-regexp-length}
-@cindex @samp{--max-regexp-length}
-@cindex @samp{--no-regexps}
-The parser @file{ebrowse} normally writes strings to its output file
-that help the Lisp part of Ebrowse to find functions, variables etc. in
-their source files.
+@cindex regular expressions, recording
+The parser @command{ebrowse} normally writes regular expressions to its
+output file that help the Lisp part of Ebrowse to find functions,
+variables etc. in their source files.
-You can instruct @file{ebrowse} to omit these strings by calling it
-with the command line switch @samp{--no-regexps}.
+You can instruct @command{ebrowse} to omit these regular expressions by
+calling it with the command line switch @samp{--no-regexps}.
When you do this, the Lisp part of Ebrowse tries to guess, from member
or class names, suitable regular expressions to locate that class or
@@ -366,25 +359,30 @@ automatic generation of regular expressions can be too weak if unusual
coding styles are used.
@table @samp
+@findex --no-regexps
@item --no-regexps
This option turns regular expression recording off.
+@findex --min-regexp-length
+@cindex minimum regexp length for recording
@item --min-regexp-length=@var{n}
The number @var{n} following this option specifies the minimum length of
the regular expressions recorded to match class and member declarations
and definitions. The default value is set at compilation time of
-@file{ebrowse}.
+@command{ebrowse}.
The smaller the minimum length the higher the probability that
Ebrowse will find a wrong match. The larger the value, the
larger the output file and therefore the memory consumption once the
file is read from Emacs.
+@findex --max-regexp-length
+@cindex maximum regexp length for recording
@item --max-regexp-length=@var{n}
The number following this option specifies the maximum length of the
regular expressions used to match class and member declarations and
definitions. The default value is set at compilation time of
-@file{ebrowse}.
+@command{ebrowse}.
The larger the maximum length the higher the probability that the
browser will find a correct match, but the larger the value the larger
@@ -399,18 +397,18 @@ the probability that it will no longer match after editing the file.
@node Verbosity, , Matching, Generating browser files
@comment node-name, next, previous, up
@section Verbose Mode
-@cindex verbose
-@cindex @samp{--verbose}
-@cindex @samp{--very-verbose}
+@cindex verbose operation
@table @samp
+@findex --verbose
@item --verbose
-When this option is specified on the command line, @file{ebrowse} prints
+When this option is specified on the command line, @command{ebrowse} prints
a period for each file parsed, and it displays a @samp{+} for each
class written to the output file.
+@findex --very-verbose
@item --very-verbose
-This option makes @file{ebrowse} print out the names of the files and
+This option makes @command{ebrowse} print out the names of the files and
the names of the classes seen.
@end table
@@ -423,7 +421,7 @@ the names of the classes seen.
@cindex loading
@cindex browsing
-You start browsing a class hierarchy parsed by @file{ebrowse} by just
+You start browsing a class hierarchy parsed by @command{ebrowse} by just
finding the @file{BROWSE} file with @kbd{C-x C-f}.
An example of a tree buffer display is shown below.
@@ -437,12 +435,14 @@ An example of a tree buffer display is shown below.
| Dictionary
@end example
-When you run Emacs under X, you will notice that that certain areas in
-the tree buffer are highlighted when you move the mouse over them. This
-highlight marks mouse-sensitive regions in the buffer. Please notice
-the help strings in the echo area when the mouse moves over a sensitive
-region.
+@cindex mouse highlight in tree buffers
+When you run Emacs on a display which supports colors and the mouse, you
+will notice that that certain areas in the tree buffer are highlighted
+when you move the mouse over them. This highlight marks mouse-sensitive
+regions in the buffer. Please notice the help strings in the echo area
+when the mouse moves over a sensitive region.
+@cindex context menu
A click with @kbd{mouse-3} on a mouse-sensitive region opens a context
menu. In addition to this, each buffer also has a buffer-specific menu
that is opened with a click with @kbd{mouse-3} somewhere in the buffer
@@ -459,8 +459,6 @@ where no highlight is displayed.
@node Tree Buffers, Member Buffers, Loading a Tree, Top
@comment node-name, next, previous, up
@chapter Tree Buffers
-@cindex tree buffers
-@cindex tree
@cindex tree buffer mode
@cindex class trees
@@ -494,7 +492,7 @@ buffers.
@comment node-name, next, previous, up
@section Viewing and Finding Class Declarations
@cindex viewing, class
-@cindex finding, class
+@cindex finding a class
@cindex class declaration
You can view or find a class declaration when the cursor is on a class
@@ -522,10 +520,10 @@ The same functionality is available from the menu opened with
@node Member Display, Go to Class, Source Display, Tree Buffers
@comment node-name, next, previous, up
@section Displaying Members
-@cindex @samp{*Members*}
+@cindex @samp{*Members*} buffer
@cindex @samp{*Globals*}
-@cindex freezing
-@cindex member lists
+@cindex freezing a member buffer
+@cindex member lists, in tree buffers
Ebrowse distinguishes six different kinds of members, each of
which is displayed as a separate @dfn{member list}: instance variables,
@@ -550,23 +548,29 @@ pop to a member buffer displaying the member list. With prefix argument,
the member buffer will additionally be @dfn{frozen}.
@table @kbd
+@cindex instance member variables, list
@item L v
This command displays the list of instance member variables.
+@cindex static variables, list
@item L V
Display the list of static variables.
+@cindex friend functions, list
@item L d
Display the list of friend functions. This list is used for defines if
you are viewing the class @samp{*Globals*} which is a place holder for
global symbols.
+@cindex member functions, list
@item L f
Display the list of member functions.
+@cindex static member functions, list
@item L F
Display the list of static member functions.
+@cindex types, list
@item L t
Display a list of types.
@end table
@@ -582,15 +586,17 @@ These lists are also available from the class' context menu invoked with
@section Finding a Class
@cindex locate class
@cindex expanding branches
+@cindex class location
@table @kbd
+@cindex search for class
@item /
This command reads a class name from the minibuffer with completion and
positions the cursor on the class in the class tree.
If the branch of the class tree containing the class searched for is
currently collapsed, the class itself and all its base classes are
-recursively made visible. (See also @xref{Expanding and
+recursively made visible. (See also @ref{Expanding and
Collapsing}.)@refill
This function is also available from the tree buffer's context menu.
@@ -606,7 +612,7 @@ local copy of the regular expression last searched in it.
@node Quitting, File Name Display, Go to Class, Tree Buffers
@comment node-name, next, previous, up
@section Burying a Tree Buffer
-@cindex burying buffer, tree
+@cindex burying tree buffer
@table @kbd
@item q
@@ -619,9 +625,9 @@ Is a synonym for @kbd{M-x bury-buffer}.
@node File Name Display, Expanding and Collapsing, Quitting, Tree Buffers
@comment node-name, next, previous, up
@section Displaying File Names
-@cindex file name display
@table @kbd
+@cindex file names in tree buffers
@item T f
This command toggles the display of file names in a tree buffer. If
file name display is switched on, the names of the files containing the
@@ -652,14 +658,15 @@ Here is an example of a tree buffer with file names displayed.
@node Expanding and Collapsing, Tree Indentation, File Name Display, Tree Buffers
@comment node-name, next, previous, up
@section Expanding and Collapsing a Tree
-@cindex expand
-@cindex collapse
-@cindex branches
+@cindex expand tree branch
+@cindex collapse tree branch
+@cindex branches of class tree
+@cindex class tree, collapse or expand
You can expand and collapse parts of a tree to reduce the complexity of
large class hierarchies. Expanding or collapsing branches of a tree has
no impact on the functionality of other commands, like @kbd{/}. (See
-also @xref{Go to Class}.)@refill
+also @ref{Go to Class}.)@refill
Collapsed branches are indicated with an ellipsis following the class
name like in the example below.
@@ -692,7 +699,7 @@ This command expands all collapsed branches in the tree.
@comment node-name, next, previous, up
@section Changing the Tree Indentation
@cindex tree indentation
-@cindex indentation
+@cindex indentation of the tree
@table @kbd
@item T w
@@ -708,6 +715,7 @@ available from the tree buffer's context menu.
@comment node-name, next, previous, up
@section Removing Classes from the Tree
@cindex killing classes
+@cindex class, remove from tree
@table @kbd
@item C-k
@@ -723,7 +731,9 @@ deletion is actually performed.
@comment node-name, next, previous, up
@comment node-name, next, previous, up
@section Saving a Tree
-@cindex saving tree
+@cindex save tree to a file
+@cindex tree, save to a file
+@cindex class tree, save to a file
@table @kbd
@item C-x C-s
@@ -739,7 +749,9 @@ Writes the tree to a file whose name is read from the minibuffer.
@node Statistics, Marking Classes, Saving a Tree, Tree Buffers
@comment node-name, next, previous, up
-@cindex statistics
+@cindex statistics for a tree
+@cindex tree statistics
+@cindex class statistics
@table @kbd
@item x
@@ -754,17 +766,20 @@ context menu.
@node Marking Classes, , Statistics, Tree Buffers
@comment node-name, next, previous, up
@cindex marking classes
+@cindex operations on marked classes
Classes can be marked for operations similar to the standard Emacs
commands @kbd{M-x tags-search} and @kbd{M-x tags-query-replace} (see
also @xref{Tags-like Functions}.)@refill
@table @kbd
+@cindex toggle mark
@item M t
Toggle the mark of the line point is in or for as many lines as given by
a prefix command. This command can also be found in the class' context
menu.
+@cindex unmark all
@item M a
Unmark all classes. With prefix argument @kbd{C-u}, mark all classes in
the tree. Since this command operates on the whole buffer, it can also be
@@ -793,10 +808,11 @@ display, like in the following example
@node Member Buffers, Tags-like Functions, Tree Buffers, Top
@comment node-name, next, previous, up
@chapter Member Buffers
-@cindex member buffer
@cindex members
@cindex member buffer mode
+@cindex class members, types
+@cindex types of class members
@dfn{Member buffers} are used to operate on lists of members of a class.
Ebrowse distinguishes six kinds of lists:
@@ -843,16 +859,18 @@ buffer: members, classes, and the buffer itself.
@node Switching Member Lists, Finding/Viewing, Member Buffers, Member Buffers
@comment node-name, next, previous, up
@section Switching Member Lists
-@cindex member lists
+@cindex member lists, in member buffers
@cindex static members
@cindex friends
@cindex types
@cindex defines
@table @kbd
+@cindex next member list
@item L n
This command switches the member buffer display to the next member list.
+@cindex previous member list
@item L p
This command switches the member buffer display to the previous member
list.
@@ -860,6 +878,7 @@ list.
@item L f
Switch to the list of member functions.
+@cindex static
@item L F
Switch to the list of static member functions.
@@ -887,12 +906,12 @@ context menu.
@node Finding/Viewing, Inherited Members, Switching Member Lists, Member Buffers
@comment node-name, next, previous, up
@section Finding and Viewing Member Source
-@cindex finding members
-@cindex viewing members
-@cindex member definitions
-@cindex member declarations
-@cindex definitions
-@cindex declarations
+@cindex finding members, in member buffers
+@cindex viewing members, in member buffers
+@cindex member definitions, in member buffers
+@cindex member declarations, in member buffers
+@cindex definition of a member, in member buffers
+@cindex declaration of a member, in member buffers
@table @kbd
@item RET
@@ -925,8 +944,8 @@ displayed when clicking @kbd{mouse-2} on a member name.
@node Inherited Members, Searching Members, Finding/Viewing, Member Buffers
@comment node-name, next, previous, up
@section Display of Inherited Members
-@cindex superclasses
-@cindex base classes
+@cindex superclasses, members
+@cindex base classes, members
@cindex inherited members
@table @kbd
@@ -971,7 +990,7 @@ a mouse.
@node Switching to Tree, Filters, Searching Members, Member Buffers
@comment node-name, next, previous, up
@section Switching to Tree Buffer
-@cindex tree buffer
+@cindex tree buffer, switch to
@cindex buffer switching
@cindex switching buffers
@@ -991,37 +1010,38 @@ displayed in the member buffer.
@comment node-name, next, previous, up
@section Filters
@cindex filters
-@cindex @code{public}
-@cindex @code{protected}
-@cindex @code{private}
-@cindex @code{virtual}
-@cindex @code{inline}
-@cindex @code{const}
-@cindex pure virtual members
@table @kbd
+@cindex @code{public} members
@item F a u
This command toggles the display of @code{public} members. The
@samp{a} stands for `access'.
+@cindex @code{protected} members
@item F a o
This command toggles the display of @code{protected} members.
+@cindex @code{private} members
@item F a i
This command toggles the display of @code{private} members.
+@cindex @code{virtual} members
@item F v
This command toggles the display of @code{virtual} members.
+@cindex @code{inline} members
@item F i
This command toggles the display of @code{inline} members.
+@cindex @code{const} members
@item F c
This command toggles the display of @code{const} members.
+@cindex pure virtual members
@item F p
This command toggles the display of pure virtual members.
+@cindex remove filters
@item F r
This command removes all filters.
@end table
@@ -1035,15 +1055,7 @@ These commands are also found in the buffer's context menu.
@comment node-name, next, previous, up
@section Displaying Member Attributes
@cindex attributes
-@cindex member attributes
-@cindex @code{virtual}
-@cindex @code{extern "C"}
-@cindex @code{mutable}
-@cindex @code{explicit}
-@cindex @code{template}
-@cindex @code{inline}
-@cindex @code{const}
-@cindex pure virtual
+@cindex member attribute display
@table @kbd
@item D a
@@ -1055,27 +1067,35 @@ the of the member's name. A @samp{-} at a given position means that
the attribute is false. The list of attributes from left to right is
@table @samp
+@cindex @code{template} attribute
@item T
The member is a template.
+@cindex @code{extern "C"} attribute
@item C
The member is declared @code{extern "C"}.
+@cindex @code{virtual} attribute
@item v
Means the member is declared @code{virtual}.
+@cindex @code{inline}
@item i
The member is declared @code{inline}.
+@cindex @code{const} attribute
@item c
The member is @code{const}.
+@cindex pure virtual function attribute
@item 0
The member is a pure virtual function.
+@cindex @code{mutable} attribute
@item m
The member is declared @code{mutable}.
+@cindex @code{explicit} attribute
@item e
The member is declared @code{explicit}.
@@ -1094,7 +1114,6 @@ This command is also in the buffer's context menu.
@cindex display form
@cindex long display
@cindex short display
-@cindex @samp{--no-regexps}
@table @kbd
@item D l
@@ -1117,7 +1136,8 @@ expressions matching the member (if known):
@end example
Regular expressions will only be displayed when the Lisp database has
-not been produced with the @file{ebrowse} option @samp{--no-regexps}.
+not been produced with the @command{ebrowse} option @samp{--no-regexps}.
+@xref{Matching, --no-regexps, Regular Expressions}.
@end table
@@ -1136,7 +1156,8 @@ matching member definitions.
@end table
Regular expressions will only be displayed when the Lisp database has
-not been produced with the @file{ebrowse} option @samp{--no-regexps}.
+not been produced with the @command{ebrowse} option @samp{--no-regexps},
+see @ref{Matching, --no-regexps, Regular Expressions}.
@@ -1144,10 +1165,10 @@ not been produced with the @file{ebrowse} option @samp{--no-regexps}.
@node Switching Classes, Killing/Burying, Regexp Display, Member Buffers
@comment node-name, next, previous, up
@section Displaying Another Class
-@cindex base classes
-@cindex derived classes
-@cindex superclasses
-@cindex subclasses
+@cindex base class, display
+@cindex derived class, display
+@cindex superclass, display
+@cindex subclass, display
@cindex class display
@table @kbd
@@ -1206,7 +1227,7 @@ This command sets the column width depending on the display form used
@node Redisplay, Getting Help, Column Width, Member Buffers
@comment node-name, next, previous, up
@section Forced Redisplay
-@cindex redisplay
+@cindex redisplay of member buffers
@table @kbd
@item C-l
@@ -1258,11 +1279,16 @@ Emacs Tags facility, but better suited to the needs of C++ programmers.
@node Finding and Viewing, Position Stack, Tags-like Functions, Tags-like Functions
@comment node-name, next, previous, up
@section Finding and Viewing Members
-@cindex finding member
-@cindex viewing member
+@cindex finding class member, in C++ source
+@cindex viewing class member, in C++ source
@cindex tags
-@cindex member definition
-@cindex member declaration
+@cindex member definition, finding, in C++ source
+@cindex member declaration, finding, in C++ source
+
+The functions in this section are similar to those described in
+@ref{Source Display}, and also in @ref{Finding/Viewing}, except that
+they work in a C++ source buffer, not in member and tree buffers created
+by Ebrowse.
@table @kbd
@item C-c b f
@@ -1275,7 +1301,7 @@ front of the member name, this class name is used as initial input for
the completion.
@item C-c b F
-Fin the declaration of the member around point.
+Find the declaration of the member around point.
@item C-c b v
View the definition of the member around point.
@@ -1322,6 +1348,7 @@ jump and the position where you jumped to are recorded in a
move to positions in the stack:@refill
@table @kbd
+@cindex return to original position
@item C-c b -
This command sets point to the previous position in the position stack.
Directly after you performed a jump, this will put you back to the
@@ -1346,11 +1373,11 @@ view a position with @kbd{v}.
-@node Search & Replace, Members in Files, Position Stack, Tags-like Functions
+@node Search & Replace, Members in Files, Position Stack, Tags-like Functions
@comment node-name, next, previous, up
@section Searching and Replacing
-@cindex searching
-@cindex replacing
+@cindex searching multiple C++ files
+@cindex replacing in multiple C++ files
@cindex restart tags-operation
Ebrowse allows you to perform operations on all or a subset of the files
@@ -1388,7 +1415,8 @@ This restarts the last tags operation with the next file in the list.
@comment node-name, next, previous, up
@section Members in Files
@cindex files
-@cindex members in file
+@cindex members in file, listing
+@cindex list class members in a file
@cindex file, members
The command @kbd{C-c b l}, lists all members in a given file. The file
@@ -1400,7 +1428,7 @@ name is read from the minibuffer with completion.
@node Apropos, Symbol Completion, Members in Files, Tags-like Functions
@comment node-name, next, previous, up
@section Member Apropos
-@cindex apropos
+@cindex apropos on class members
@cindex members, matching regexp
The command @kbd{C-c b a} can be used to display all members matching a
@@ -1428,7 +1456,7 @@ The command @kbd{C-c b TAB} completes the symbol in front of point.
@node Member Buffer Display, , Symbol Completion, Tags-like Functions
@section Quick Member Display
-@cindex member buffer
+@cindex member buffer, for member at point
You can quickly display a member buffer containing the member the cursor
in on with the command @kbd{C-c b m}.
diff --git a/man/ediff.texi b/man/ediff.texi
index 8547b3fb72..d0832ec68f 100644
--- a/man/ediff.texi
+++ b/man/ediff.texi
@@ -114,7 +114,7 @@ you don't like).
Ediff even understands multi-file patches and can apply them interactively!
(Ediff can recognize multi-file patches only if they are in the context
format or GNU unified format. All other patches are treated as 1-file
-patches. Ediff is [hopefully] using the same algorithm as @file{patch} to
+patches. Ediff is [hopefully] using the same algorithm as @command{patch} to
determine which files need to be patched.)
Ediff is aware of version control, which lets you compare
@@ -222,7 +222,7 @@ the case. To avoid this extra prompt, you can invoke this command with a
prefix argument. With an odd prefix argument, Ediff assumes the patch
is in a file; with an even argument, a buffer is assumed.
-Note that @code{ediff-patch-file} will actually use the @file{patch}
+Note that @code{ediff-patch-file} will actually use the @command{patch}
utility to change the the original files on disk. This is not that
dangerous, since you will always have the original contents of the file
saved in another file that has the extension @file{.orig}.
@@ -249,7 +249,7 @@ appears in some other buffer that has the name ending with @emph{_patched}.
This function would refuse to apply a multifile patch to a buffer. Use
@code{ediff-patch-file} for that (and when you want the original file to be
-modified by the @file{patch} utility).
+modified by the @command{patch} utility).
Since the patch might be in a buffer or a file, you will be asked which is
the case. To avoid this extra prompt, you can invoke this command with a
@@ -340,7 +340,7 @@ the VMS version of @code{diff}.
The functions @code{ediff-files}, @code{ediff-buffers},
@code{ediff-files3}, @code{ediff-buffers3} first display the coarse,
-line-based difference regions, as reported by the @file{diff} program. The
+line-based difference regions, as reported by the @command{diff} program. The
total number of difference regions and the current difference number are
always displayed in the mode line of the control window.
@@ -446,9 +446,9 @@ Scrolls buffers to the right.
@item wd
Saves the output from the diff utility, for further reference.
-With prefix argument, saves the plain output from @file{diff} (see
+With prefix argument, saves the plain output from @command{diff} (see
@code{ediff-diff-program} and @code{ediff-diff-options}). Without the
-argument, it saves customized @file{diff} output (see
+argument, it saves customized @command{diff} output (see
@code{ediff-custom-diff-program} and @code{ediff-custom-diff-options}), if
it is available.
@@ -669,7 +669,7 @@ Runs @code{ediff-custom-diff-program} on the variants and displays the
buffer containing the output. This is useful when you must send the output
to your Mom.
-With a prefix argument, displays the plain @file{diff} output.
+With a prefix argument, displays the plain @command{diff} output.
@xref{Patch and Diff Programs}, for details.
@item R
@@ -980,7 +980,7 @@ change this variable.
@cindex Multi-file patches
A multi-file patch is a concatenated output of several runs of the Unix
-@file{diff} command (some versions of @file{diff} let you create a
+@command{diff} command (some versions of @command{diff} let you create a
multi-file patch in just one run). Ediff facilitates creation of
multi-file patches as follows. If you are in a session group buffer
created in response to @code{ediff-directories} or
@@ -988,7 +988,7 @@ created in response to @code{ediff-directories} or
desired Ediff sessions and then type @kbd{P} to create a
multi-file patch of those marked sessions.
Ediff will then display a buffer containing the patch.
-The patch is generated by invoking @file{diff} on all marked individual
+The patch is generated by invoking @command{diff} on all marked individual
sessions (represented by files) and session groups (represented by
directories). Ediff will also recursively descend into any @emph{unmarked}
session group and will search for marked sessions there. In this way, you
@@ -1762,7 +1762,7 @@ output from @code{diff} in your preferred format, which is specified via
the above two variables.
The output generated by @code{ediff-custom-diff-program} (which doesn't
-even have to be a standard-style @file{diff}!)@: is not used by Ediff. It is
+even have to be a standard-style @command{diff}!)@: is not used by Ediff. It is
provided exclusively so that you can
refer to
it later, send it over email, etc. For instance, after reviewing the
diff --git a/man/entering.texi b/man/entering.texi
index 3835b47f37..384cfb5a7a 100644
--- a/man/entering.texi
+++ b/man/entering.texi
@@ -6,7 +6,7 @@
@cindex entering Emacs
@cindex starting Emacs
- The usual way to invoke Emacs is with the shell command @samp{emacs}.
+ The usual way to invoke Emacs is with the shell command @command{emacs}.
Emacs clears the screen and then displays an initial help message and
copyright notice. Some operating systems discard all type-ahead when
Emacs starts up; they give Emacs no way to prevent this. Therefore, it
@@ -14,7 +14,7 @@ is advisable to wait until Emacs clears the screen before typing your
first editing command.
If you run Emacs from a shell window under the X Window System, run it
-in the background with @samp{emacs&}. This way, Emacs does not tie up
+in the background with @command{emacs&}. This way, Emacs does not tie up
the shell window, so you can use that to run other shell commands while
Emacs operates its own X windows. You can begin typing Emacs commands
as soon as you direct your keyboard input to the Emacs frame.
@@ -86,12 +86,12 @@ Kill Emacs (@code{save-buffers-kill-emacs}).
@findex suspend-emacs
To suspend Emacs, type @kbd{C-z} (@code{suspend-emacs}). This takes
you back to the shell from which you invoked Emacs. You can resume
-Emacs with the shell command @samp{%emacs} in most common shells.
+Emacs with the shell command @command{%emacs} in most common shells.
On systems that do not support suspending programs, @kbd{C-z} starts
an inferior shell that communicates directly with the terminal.
Emacs waits until you exit the subshell. (The way to do that is
-probably with @kbd{C-d} or @samp{exit}, but it depends on which shell
+probably with @kbd{C-d} or @command{exit}, but it depends on which shell
you use.) The only way on these systems to get back to the shell from
which Emacs was run (to log out, for example) is to kill Emacs.
diff --git a/man/files.texi b/man/files.texi
index 4fbaabc989..ce4d37fe53 100644
--- a/man/files.texi
+++ b/man/files.texi
@@ -98,7 +98,7 @@ first slash in the double slash; the result is @samp{/x1/rms/foo}.
@samp{$} in a file name is used to substitute environment variables.
For example, if you have used the shell command @samp{export
-FOO=rms/hacks} to set up an environment variable named @code{FOO}, then
+FOO=rms/hacks} to set up an environment variable named @env{FOO}, then
you can use @file{/u/$FOO/test.c} or @file{/u/$@{FOO@}/test.c} as an
abbreviation for @file{/u/rms/hacks/test.c}. The environment variable
name consists of all the alphanumeric characters after the @samp{$};
@@ -543,8 +543,8 @@ control the making of backups for that buffer's file. For example,
Rmail mode locally sets @code{version-control} to @code{never} to make sure
that there is only one backup for an Rmail file. @xref{Locals}.
-@cindex @code{VERSION_CONTROL} environment variable
- If you set the environment variable @code{VERSION_CONTROL}, to tell
+@cindex @env{VERSION_CONTROL} environment variable
+ If you set the environment variable @env{VERSION_CONTROL}, to tell
various GNU utilities what to do with backup files, Emacs also obeys the
environment variable by setting the Lisp variable @code{version-control}
accordingly at startup. If the environment variable's value is @samp{t}
@@ -2079,13 +2079,13 @@ file at any time. However, there are ways to restrict this, resulting
in behavior that resembles locking.
@cindex CVSREAD environment variable (CVS)
- For one thing, you can set the @code{CVSREAD} environment variable to
+ For one thing, you can set the @env{CVSREAD} environment variable to
an arbitrary value. If this variable is defined, CVS makes your work
files read-only by default. In Emacs, you must type @kbd{C-x C-q} to
make the file writeable, so that editing works in fact similar as if
locking was used. Note however, that no actual locking is performed, so
several users can make their files writeable at the same time. When
-setting @code{CVSREAD} for the first time, make sure to check out all
+setting @env{CVSREAD} for the first time, make sure to check out all
your modules anew, so that the file protections are set correctly.
@cindex cvs watch feature
diff --git a/man/frames.texi b/man/frames.texi
index 4421318cd6..a2d03e35b4 100644
--- a/man/frames.texi
+++ b/man/frames.texi
@@ -443,7 +443,7 @@ speedbar for it.
A single Emacs can talk to more than one X Windows display.
Initially, Emacs uses just one display---the one specified with the
-@code{DISPLAY} environment variable or with the @samp{--display} option
+@env{DISPLAY} environment variable or with the @samp{--display} option
(@pxref{Initial Options}). To connect to another display, use the
command @code{make-frame-on-display}:
diff --git a/man/misc.texi b/man/misc.texi
index 87d72d9f04..bc9a913629 100644
--- a/man/misc.texi
+++ b/man/misc.texi
@@ -370,11 +370,11 @@ returns the command's exit status when it is called from a Lisp program.
@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 @code{SHELL}
+shell to use. This variable is initialized based on your @env{SHELL}
environment variable when Emacs is started. If the file name does not
specify a directory, the directories in the list @code{exec-path} are
searched; this list is initialized based on the environment variable
-@code{PATH} when Emacs is started. Your @file{.emacs} file can override
+@env{PATH} when Emacs is started. Your @file{.emacs} file can override
either or both of these default initializations.@refill
Both @kbd{M-!} and @kbd{M-|} wait for the shell command to complete.
@@ -419,15 +419,15 @@ 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.
@vindex explicit-shell-file-name
-@cindex @code{ESHELL} environment variable
-@cindex @code{SHELL} environment variable
+@cindex @env{ESHELL} environment variable
+@cindex @env{SHELL} environment variable
The file name used to load the subshell is the value of the variable
@code{explicit-shell-file-name}, if that is non-@code{nil}. Otherwise,
-the environment variable @code{ESHELL} is used, or the environment
-variable @code{SHELL} if there is no @code{ESHELL}. If the file name
+the environment variable @env{ESHELL} is used, or the environment
+variable @env{SHELL} if there is no @env{ESHELL}. If the file name
specified is relative, the directories in the list @code{exec-path} are
searched; this list is initialized based on the environment variable
-@code{PATH} when Emacs is started. Your @file{.emacs} file can override
+@env{PATH} when Emacs is started. Your @file{.emacs} file can override
either or both of these default initializations.
To specify a coding system for the shell, you can use the command
@@ -473,7 +473,7 @@ most common command syntax; it may not work for unusual shells.
alternative and more aggressive method of tracking changes in the
current directory.
- Emacs defines the environment variable @code{EMACS} in the subshell,
+ 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.
@@ -1032,7 +1032,7 @@ type of terminal your 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 @code{TERMCAP} variable,
+@c shell, and your system understands the @env{TERMCAP} variable,
@c you can use the command @kbd{M-x shell-send-termcap}, which
@c sends a string specifying the terminal type and size.
@c (This command is also useful after the window has changed size.)
@@ -1096,13 +1096,13 @@ off directory tracking.
@pindex emacsclient
@cindex Emacs as a server
@cindex server, using Emacs as
-@cindex @code{EDITOR} environment variable
+@cindex @env{EDITOR} environment variable
Various programs such as @code{mail} can invoke your choice of editor
to edit a particular piece of text, such as a message that you are
sending. By convention, most of these programs use the environment
-variable @code{EDITOR} to specify which editor to run. If you set
-@code{EDITOR} to @samp{emacs}, they invoke Emacs---but in an
+variable @env{EDITOR} to specify which editor to run. If you set
+@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.
@@ -1111,18 +1111,18 @@ doesn't share the buffers in the existing Emacs process.
programs like @code{mail} by using the Emacs client and Emacs server
programs. Here is how.
-@cindex @code{TEXEDIT} environment variable
+@cindex @env{TEXEDIT} environment variable
First, the preparation. Within Emacs, call the function
@code{server-start}. (Your @file{.emacs} file can do this automatically
if you add the expression @code{(server-start)} to it.) Then, outside
-Emacs, set the @code{EDITOR} environment variable to @samp{emacsclient}.
+Emacs, set the @env{EDITOR} environment variable to @samp{emacsclient}.
(Note that some programs use a different environment variable; for
example, to make @TeX{} use @samp{emacsclient}, you should set the
-@code{TEXEDIT} environment variable to @samp{emacsclient +%d %s}.)
+@env{TEXEDIT} environment variable to @samp{emacsclient +%d %s}.)
@kindex C-x #
@findex server-edit
- Then, whenever any program invokes your specified @code{EDITOR}
+ Then, whenever any program invokes your specified @env{EDITOR}
program, the effect is to send a message to your principal Emacs telling
it to visit a file. (That's what the program @code{emacsclient} does.)
Emacs displays the buffer immediately and you can immediately begin
@@ -1131,7 +1131,7 @@ editing it.
When you've finished editing that buffer, type @kbd{C-x #}
(@code{server-edit}). This saves the file and sends a message back to
the @code{emacsclient} program telling it to exit. The programs that
-use @code{EDITOR} wait for the ``editor'' (actually, @code{emacsclient})
+use @env{EDITOR} wait for the ``editor'' (actually, @code{emacsclient})
to exit. @kbd{C-x #} also checks for other pending external requests
to edit various files, and selects the next such file.
diff --git a/man/msdog.texi b/man/msdog.texi
index 1c8747b108..a584a2e796 100644
--- a/man/msdog.texi
+++ b/man/msdog.texi
@@ -249,20 +249,20 @@ example, the name of a backup file for @file{docs.txt} is
turn on support for long file names. If you do that, Emacs doesn't
truncate file names or convert them to lower case; instead, it uses the
file names that you specify, verbatim. To enable long file name
-support, set the environment variable @code{LFN} to @samp{y} before
+support, set the environment variable @env{LFN} to @samp{y} before
starting Emacs. Unfortunately, Windows NT doesn't allow DOS programs to
access long file names, so Emacs built for MS-DOS will only see their
short 8+3 aliases.
-@cindex @code{HOME} directory under MS-DOS
+@cindex @env{HOME} directory under MS-DOS
MS-DOS has no notion of home directory, so Emacs on MS-DOS pretends
-that the directory where it is installed is the value of @code{HOME}
+that the directory where it is installed is the value of @env{HOME}
environment variable. That is, if your Emacs binary,
@file{emacs.exe}, is in the directory @file{c:/utils/emacs/bin}, then
-Emacs acts as if @code{HOME} were set to @samp{c:/utils/emacs}. In
+Emacs acts as if @env{HOME} were set to @samp{c:/utils/emacs}. In
particular, that is where Emacs looks for the init file @file{_emacs}.
With this in mind, you can use @samp{~} in file names as an alias for
-the home directory, as you would in Unix. You can also set @code{HOME}
+the home directory, as you would in Unix. You can also set @env{HOME}
variable in the environment before starting Emacs; its value will then
override the above default behavior.
diff --git a/man/mule.texi b/man/mule.texi
index 7f78888a72..b16d4802ec 100644
--- a/man/mule.texi
+++ b/man/mule.texi
@@ -111,7 +111,7 @@ conversion, uncompression and auto mode selection as
@vindex default-enable-multibyte-characters
To turn off multibyte character support by default, start Emacs with
the @samp{--unibyte} option (@pxref{Initial Options}), or set the
-environment variable @samp{EMACS_UNIBYTE}. You can also customize
+environment variable @env{EMACS_UNIBYTE}. You can also customize
@code{enable-multibyte-characters} or, equivalently, directly set the
variable @code{default-enable-multibyte-characters} in your init file to
have basically the same effect as @samp{--unibyte}.
diff --git a/man/programs.texi b/man/programs.texi
index febed8f4f6..6b2b89e3f9 100644
--- a/man/programs.texi
+++ b/man/programs.texi
@@ -1806,7 +1806,7 @@ In La@TeX{} text, the argument of any of the commands @code{\chapter},
tag.@refill
Other commands can make tags as well, if you specify them in the
-environment variable @code{TEXTAGS} before invoking @code{etags}. The
+environment variable @env{TEXTAGS} before invoking @code{etags}. The
value of this environment variable should be a colon-separated list of
command names. For example,
diff --git a/man/rmail.texi b/man/rmail.texi
index 12a3d49402..0376ef93a6 100644
--- a/man/rmail.texi
+++ b/man/rmail.texi
@@ -302,10 +302,10 @@ mail with Rmail. This operation is called @dfn{getting new mail}. You
can get new mail at any time in Rmail by typing @kbd{g}.
@vindex rmail-primary-inbox-list
-@cindex @code{MAIL} environment variable
+@cindex @env{MAIL} environment variable
The variable @code{rmail-primary-inbox-list} contains a list of the
files which are inboxes for your primary Rmail file. If you don't set
-this variable explicitly, it is initialized from the @code{MAIL}
+this variable explicitly, it is initialized from the @env{MAIL}
environment variable, or, as a last resort, set to @code{nil}, which
means to use the default inbox. The default inbox is
@file{/var/mail/@var{username}}, @file{/usr/spool/mail/@var{username}},
@@ -1122,13 +1122,13 @@ with POP if you compile it with the macro @code{MAIL_USE_POP} defined.
@code{movemail} only works with POP3, not with older
versions of POP.
-@cindex @code{MAILHOST} environment variable
+@cindex @env{MAILHOST} environment variable
@cindex POP inboxes
Assuming you have compiled and installed @code{movemail}
appropriately, you can specify a POP inbox by using a ``file name'' of
the form @samp{po:@var{username}}, in the inbox list of an Rmail file.
@code{movemail} handles such a name by opening a connection to the POP
-server. The @code{MAILHOST} environment variable specifies the machine
+server. The @env{MAILHOST} environment variable specifies the machine
to look for the server on; alternatively, you can specify the POP server
host name as part of the mailbox name using the syntax
@samp{po:@var{username}:@var{hostname}}.
diff --git a/man/sending.texi b/man/sending.texi
index bbaf83db65..eecf8ba127 100644
--- a/man/sending.texi
+++ b/man/sending.texi
@@ -171,14 +171,14 @@ the @samp{Reply-to} address in preference to the @samp{From} address.
By adding a @samp{Reply-to} field to your header, you can work around
any problems your @samp{From} address may cause for replies.
-@cindex @code{REPLYTO} environment variable
+@cindex @env{REPLYTO} environment variable
@vindex mail-default-reply-to
To put a fixed @samp{Reply-to} address into every outgoing message, set
the variable @code{mail-default-reply-to} to that address (as a string).
Then @code{mail} initializes the message with a @samp{Reply-to} field as
specified. You can delete or alter that header field before you send
the message, if you wish. When Emacs starts up, if the environment
-variable @code{REPLYTO} is set, @code{mail-default-reply-to} is
+variable @env{REPLYTO} is set, @code{mail-default-reply-to} is
initialized from that environment variable.
@item In-reply-to
diff --git a/man/text.texi b/man/text.texi
index b0cc13e399..c9bde2550f 100644
--- a/man/text.texi
+++ b/man/text.texi
@@ -1440,11 +1440,11 @@ view the progress of your output towards being printed. If your terminal
has the ability to display @TeX{} output files, you can preview the
output on the terminal with @kbd{C-c C-v} (@code{tex-view}).
-@cindex @code{TEXINPUTS} environment variable
+@cindex @env{TEXINPUTS} environment variable
@vindex tex-directory
You can specify the directory to use for running @TeX{} by setting the
variable @code{tex-directory}. @code{"."} is the default value. If
-your environment variable @code{TEXINPUTS} contains relative directory
+your environment variable @env{TEXINPUTS} contains relative directory
names, or if your files contains @samp{\input} commands with relative
file names, then @code{tex-directory} @emph{must} be @code{"."} or you
will get the wrong results. Otherwise, it is safe to specify some other
diff --git a/man/trouble.texi b/man/trouble.texi
index 0d942ffa70..9c480d55b9 100644
--- a/man/trouble.texi
+++ b/man/trouble.texi
@@ -570,9 +570,9 @@ specified dribble file until the Emacs process is killed.
@item
@findex open-termscript
@cindex termscript file
-@cindex @code{TERM} environment variable
+@cindex @env{TERM} environment variable
For possible display bugs, the terminal type (the value of environment
-variable @code{TERM}), the complete termcap entry for the terminal from
+variable @env{TERM}), the complete termcap entry for the terminal from
@file{/etc/termcap} (since that file is not identical on all machines),
and the output that Emacs actually sent to the terminal.
@@ -946,14 +946,14 @@ form that is clearly safe to install.
If you would like to help pretest Emacs releases to assure they work
well, or if you would like to work on improving Emacs, please contact
-the maintainers at @code{bug-gnu-emacs@@gnu.org}. A pretester
+the maintainers at @email{bug-gnu-emacs@@gnu.org}. A pretester
should be prepared to investigate bugs as well as report them. If you'd
like to work on improving Emacs, please ask for suggested projects or
suggest your own ideas.
If you have already written an improvement, please tell us about it. If
you have not yet started work, it is useful to contact
-@code{bug-gnu-emacs@@gnu.org} before you start; it might be
+@email{bug-gnu-emacs@@gnu.org} before you start; it might be
possible to suggest ways to make your extension fit in better with the
rest of Emacs.
@@ -966,7 +966,7 @@ ways to find it:
@itemize @bullet
@item
Send a message to the mailing list
-@code{help-gnu-emacs@@gnu.org}, or post your request on
+@email{help-gnu-emacs@@gnu.org}, or post your request on
newsgroup @code{gnu.emacs.help}. (This mailing list and newsgroup
interconnect, so it does not matter which one you use.)