summaryrefslogtreecommitdiff
path: root/doc/emacs/cmdargs.texi
diff options
context:
space:
mode:
authorMichael Albinus <michael.albinus@gmx.de>2018-02-23 15:30:19 +0100
committerMichael Albinus <michael.albinus@gmx.de>2018-02-23 15:30:19 +0100
commit2dc24d5536abce1eb252dc2695a22371227166c5 (patch)
tree5691caa876fd1c44d05719226684aa11ce0f4b45 /doc/emacs/cmdargs.texi
parent76f5242838c84bcaf5003b18a31104114930f197 (diff)
downloademacs-2dc24d5536abce1eb252dc2695a22371227166c5.tar.gz
Fix @findex and @vindex entries in manuals
* doc/emacs/building.texi: * doc/emacs/calendar.texi: * doc/emacs/cmdargs.texi: * doc/emacs/mini.texi: * doc/emacs/misc.texi: * doc/emacs/trouble.texi: * doc/emacs/windows.texi: * doc/lispintro/emacs-lisp-intro.texi: * doc/lispref/edebug.texi: * doc/lispref/frames.texi: * doc/lispref/os.texi: * doc/lispref/windows.texi: * doc/misc/cc-mode.texi: * doc/misc/dired-x.texi: * doc/misc/ediff.texi: * doc/misc/mh-e.texi: * doc/misc/pcl-cvs.texi: * doc/misc/reftex.texi: * doc/misc/sc.texi: * doc/misc/vhdl-mode.texi: * doc/misc/viper.texi: Fix @findex and @vindex entries.
Diffstat (limited to 'doc/emacs/cmdargs.texi')
-rw-r--r--doc/emacs/cmdargs.texi80
1 files changed, 40 insertions, 40 deletions
diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi
index d18de8e7a02..ac48066550b 100644
--- a/doc/emacs/cmdargs.texi
+++ b/doc/emacs/cmdargs.texi
@@ -464,25 +464,25 @@ variables to be set, but it uses their values if they are set.
@c might be confused with general-purpose phrases.
@table @env
@item CDPATH
-@vindex CDPATH, environment variable
+@vindex CDPATH@r{, environment variable}
Used by the @code{cd} command to search for the directory you specify,
when you specify a relative directory,
@item DBUS_SESSION_BUS_ADDRESS
-@vindex DBUS_SESSION_BUS_ADDRESS, environment variable
+@vindex DBUS_SESSION_BUS_ADDRESS@r{, environment variable}
Used by D-Bus when Emacs is compiled with it. Usually, there is no
need to change it. Setting it to a dummy address, like
@samp{unix:path=/dev/null}, suppresses connections to the D-Bus session
bus as well as autolaunching the D-Bus session bus if not running yet.
@item EMACSDATA
-@vindex EMACSDATA, environment variable
+@vindex EMACSDATA@r{, environment variable}
Directory for the architecture-independent files that come with Emacs.
This is used to initialize the variable @code{data-directory}.
@item EMACSDOC
-@vindex EMACSDOC, environment variable
+@vindex EMACSDOC@r{, environment variable}
Directory for the documentation string file, which is used to
initialize the Lisp variable @code{doc-directory}.
@item EMACSLOADPATH
-@vindex EMACSLOADPATH, environment variable
+@vindex EMACSLOADPATH@r{, environment variable}
A colon-separated list of directories@footnote{Here and below,
whenever we say ``colon-separated list of directories'', it pertains
to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, the
@@ -496,28 +496,28 @@ the default @code{load-path}. To specify an empty element in the
middle of the list, use 2 colons in a row, as in
@samp{EMACSLOADPATH="/tmp::/foo"}.
@item EMACSPATH
-@vindex EMACSPATH, environment variable
+@vindex EMACSPATH@r{, environment variable}
A colon-separated list of directories to search for executable files.
If set, Emacs uses this in addition to @env{PATH} (see below) when
initializing the variable @code{exec-path} (@pxref{Shell}).
@item EMAIL
-@vindex EMAIL, environment variable
+@vindex EMAIL@r{, environment variable}
@vindex user-mail-address@r{, initialization}
Your email address; used to initialize the Lisp variable
@code{user-mail-address}, which the Emacs mail interface puts into the
@samp{From} header of outgoing messages (@pxref{Mail Headers}).
@item ESHELL
-@vindex ESHELL, environment variable
+@vindex ESHELL@r{, environment variable}
Used for shell-mode to override the @env{SHELL} environment variable
(@pxref{Interactive Shell}).
@item HISTFILE
-@vindex HISTFILE, environment variable
+@vindex HISTFILE@r{, environment variable}
The name of the file that shell commands are saved in between logins.
This variable defaults to @file{~/.bash_history} if you use Bash, to
@file{~/.sh_history} if you use ksh, and to @file{~/.history}
otherwise.
@item HOME
-@vindex HOME, environment variable
+@vindex HOME@r{, environment variable}
The location of your files in the directory tree; used for
expansion of file names starting with a tilde (@file{~}). On MS-DOS,
it defaults to the directory from which Emacs was started, with
@@ -529,7 +529,7 @@ where @var{username} is your user name), though for backwards
compatibility @file{C:/} will be used instead if a @file{.emacs} file
is found there.
@item HOSTNAME
-@vindex HOSTNAME, environment variable
+@vindex HOSTNAME@r{, environment variable}
The name of the machine that Emacs is running on.
@c complete.el is obsolete since 24.1.
@ignore
@@ -538,24 +538,24 @@ A colon-separated list of directories. Used by the @code{complete} package
to search for files.
@end ignore
@item INFOPATH
-@vindex INFOPATH, environment variable
+@vindex INFOPATH@r{, environment variable}
A colon-separated list of directories in which to search for Info files.
@item LC_ALL
-@vindex LC_ALL, environment variable
+@vindex LC_ALL@r{, environment variable}
@itemx LC_COLLATE
-@vindex LC_COLLATE, environment variable
+@vindex LC_COLLATE@r{, environment variable}
@itemx LC_CTYPE
-@vindex LC_CTYPE, environment variable
+@vindex LC_CTYPE@r{, environment variable}
@itemx LC_MESSAGES
-@vindex LC_MESSAGES, environment variable
+@vindex LC_MESSAGES@r{, environment variable}
@itemx LC_MONETARY
-@vindex LC_MONETARY, environment variable
+@vindex LC_MONETARY@r{, environment variable}
@itemx LC_NUMERIC
-@vindex LC_NUMERIC, environment variable
+@vindex LC_NUMERIC@r{, environment variable}
@itemx LC_TIME
-@vindex LC_TIME, environment variable
+@vindex LC_TIME@r{, environment variable}
@itemx LANG
-@vindex LANG, environment variable
+@vindex LANG@r{, environment variable}
The user's preferred locale. The locale has six categories, specified
by the environment variables @env{LC_COLLATE} for sorting,
@env{LC_CTYPE} for character encoding, @env{LC_MESSAGES} for system
@@ -578,70 +578,70 @@ matched against entries in @code{locale-language-names},
@code{locale-preferred-coding-systems}, to select a default language
environment and coding system. @xref{Language Environments}.
@item LOGNAME
-@vindex LOGNAME, environment variable
+@vindex LOGNAME@r{, environment variable}
The user's login name. See also @env{USER}.
@item MAIL
-@vindex MAIL, environment variable
+@vindex MAIL@r{, environment variable}
The name of your system mail inbox.
@ifnottex
@item MH
-@vindex MH, environment variable
+@vindex MH@r{, environment variable}
Name of setup file for the mh system. @xref{Top,,MH-E,mh-e, The Emacs
Interface to MH}.
@end ifnottex
@item NAME
-@vindex NAME, environment variable
+@vindex NAME@r{, environment variable}
Your real-world name. This is used to initialize the variable
@code{user-full-name} (@pxref{Mail Headers}).
@item NNTPSERVER
-@vindex NNTPSERVER, environment variable
+@vindex NNTPSERVER@r{, environment variable}
The name of the news server. Used by the mh and Gnus packages.
@item ORGANIZATION
-@vindex ORGANIZATION, environment variable
+@vindex ORGANIZATION@r{, environment variable}
The name of the organization to which you belong. Used for setting the
@samp{Organization:} header in your posts from the Gnus package.
@item PATH
-@vindex PATH, environment variable
+@vindex PATH@r{, environment variable}
A colon-separated list of directories containing executable files.
This is used to initialize the variable @code{exec-path}
(@pxref{Shell}).
@item PWD
-@vindex PWD, environment variable
+@vindex PWD@r{, environment variable}
If set, this should be the default directory when Emacs was started.
@item REPLYTO
-@vindex REPLYTO, environment variable
+@vindex REPLYTO@r{, environment variable}
If set, this specifies an initial value for the variable
@code{mail-default-reply-to} (@pxref{Mail Headers}).
@item SAVEDIR
-@vindex SAVEDIR, environment variable
+@vindex SAVEDIR@r{, environment variable}
The name of a directory in which news articles are saved by default.
Used by the Gnus package.
@item SHELL
-@vindex SHELL, environment variable
+@vindex SHELL@r{, environment variable}
The name of an interpreter used to parse and execute programs run from
inside Emacs.
@item SMTPSERVER
-@vindex SMTPSERVER, environment variable
+@vindex SMTPSERVER@r{, environment variable}
The name of the outgoing mail server. This is used to initialize the
variable @code{smtpmail-smtp-server} (@pxref{Mail Sending}).
@cindex background mode, on @command{xterm}
@item TERM
-@vindex TERM, environment variable
+@vindex TERM@r{, environment variable}
The type of the terminal that Emacs is using. This variable must be
set unless Emacs is run in batch mode. On MS-DOS, it defaults to
@samp{internal}, which specifies a built-in terminal emulation that
handles the machine's own display.
@item TERMCAP
-@vindex TERMCAP, environment variable
+@vindex TERMCAP@r{, environment variable}
The name of the termcap library file describing how to program the
terminal specified by @env{TERM}. This defaults to
@file{/etc/termcap}.
@item TMPDIR
-@vindex TMPDIR, environment variable
+@vindex TMPDIR@r{, environment variable}
@itemx TMP
-@vindex TMP, environment variable
+@vindex TMP@r{, environment variable}
@itemx TEMP
-@vindex TEMP, environment variable
+@vindex TEMP@r{, environment variable}
These environment variables are used to initialize the variable
@code{temporary-file-directory}, which specifies a directory in which
to put temporary files (@pxref{Backup}). Emacs tries to use
@@ -649,7 +649,7 @@ to put temporary files (@pxref{Backup}). Emacs tries to use
@file{/tmp}, but on MS-Windows and MS-DOS it instead falls back on
@env{TMP}, then @env{TEMP}, and finally @file{c:/temp}.
@item TZ
-@vindex TZ, environment variable
+@vindex TZ@r{, environment variable}
This specifies the default time zone and possibly also daylight
saving time information. @xref{Time Zone Rules,,, elisp, The GNU
Emacs Lisp Reference Manual}. On MS-DOS, if @env{TZ} is not set in the
@@ -657,11 +657,11 @@ environment when Emacs starts, Emacs defines a default value as
appropriate for the country code returned by DOS@. On MS-Windows, Emacs
does not use @env{TZ} at all.
@item USER
-@vindex USER, environment variable
+@vindex USER@r{, environment variable}
The user's login name. See also @env{LOGNAME}. On MS-DOS, this
defaults to @samp{root}.
@item VERSION_CONTROL
-@vindex VERSION_CONTROL, environment variable
+@vindex VERSION_CONTROL@r{, environment variable}
Used to initialize the @code{version-control} variable (@pxref{Backup
Names}).
@end table