@c This is part of the Emacs manual.
-@c Copyright (C) 1985, 86, 87, 93, 94, 95, 97,
-@c 2001, 03, 04, 2005 Free Software Foundation, Inc.
+@c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2001, 2002,
+@c 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
@c See file emacs.texi for copying conditions.
@node Emacs Invocation, X Resources, GNU Free Documentation License, Top
@appendix Command Line Arguments for Emacs Invocation
Emacs library search path as specified with @env{EMACSLOADPATH}
(@pxref{General Variables}).
+@strong{Warning:} If previous command-line arguments have visited
+files, the current directory is the directory of the last file
+visited.
+
@item -L @var{dir}
@opindex -L
@itemx --directory=@var{dir}
@itemx --batch
Run Emacs in @dfn{batch mode}. Batch mode is used for running
programs written in Emacs Lisp from shell scripts, makefiles, and so
-on. You should also use the @samp{-l} option or @samp{-f} option, to
-invoke a Lisp program to do batch processing.
+on. You should also use the @samp{-l}, @samp{-f} or @samp{--eval}
+option, to invoke a Lisp program to do batch processing.
In batch mode, Emacs does not display the text being edited, and the
standard terminal interrupt characters such as @kbd{C-z} and @kbd{C-c}
@item -Q
@opindex -Q
-Start emacs with minimum customizations and window decorations.
-This is like using @samp{-q} and @samp{--no-site-file}, but in
-addition it also disables the menu-bar, the tool-bar, the scroll-bars,
-tool tips, the blinking cursor, and the fancy startup screen.
+@itemx --quick
+@opindex --quick
+Start emacs with minimum customizations. This is like using @samp{-q}
+and @samp{--no-site-file}, but also disables the startup screen.
@item --no-splash
@opindex --no-splash
-@vindex inhibit-startup-message
-Do not display a splash screen on startup; this is equivalent to
-setting the variable @code{inhibit-startup-message} to non-@code{nil}.
+@vindex inhibit-splash-screen
+@cindex splash screen
+@cindex startup message
+Do not display a splash screen on startup. You can also achieve this
+effect by setting the variable @code{inhibit-splash-screen} to
+non-@code{nil} in you personal init file (but @emph{not} in
+@file{site-start.el}). (This variable was called
+@code{inhibit-startup-message} in previous Emacs versions.)
@item --no-desktop
@opindex --no-desktop
@opindex --user
@cindex load init file of another user
Load @var{user}'s Emacs init file @file{~@var{user}/.emacs} instead of
-your own.
+your own@footnote{
+This option has no effect on MS-Windows.}.
@item --debug-init
@opindex --debug-init
variable @code{doc-directory}.
@item EMACSLOADPATH
A colon-separated list of directories@footnote{
-Here and below, whenever we say ``colon-separated list of directories'',
+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 directories are separated by semi-colons instead, since DOS/Windows
file names might include a colon after a drive letter.}
@item EMACSPATH
A colon-separated list of directories to search for executable
files---used to initialize @code{exec-path}.
+@item EMAIL
+@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
Used for shell-mode to override the @env{SHELL} environment variable.
@item HISTFILE
@file{~/.sh_history} if you use ksh, and to @file{~/.history}
otherwise.
@item HOME
-The location of the user's 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 @samp{/bin}
-removed from the end if it was present. On Windows, the default value
-of @env{HOME} is @file{C:/}, the root directory of drive @file{C:}.
+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
+@samp{/bin} removed from the end if it was present. On Windows, the
+default value of @env{HOME} is the @file{Application Data}
+subdirectory of the user profile directory (normally, this is
+@file{C:/Documents and Settings/@var{username}/Application Data},
+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
The name of the machine that Emacs is running on.
@item INCPATH
@item LOGNAME
The user's login name. See also @env{USER}.
@item MAIL
-The name of the user's system mail inbox.
+The name of your system mail inbox.
@item MH
Name of setup file for the mh system. (The default is @file{~/.mh_profile}.)
@item NAME
-The real-world name of the user.
+Your real-world name.
@item NNTPSERVER
The name of the news server. Used by the mh and Gnus packages.
@item ORGANIZATION
inside Emacs.
@item SMTPSERVER
The name of the outgoing mail server. Used by the SMTP library
-(@pxref{Top,,Sending mail via SMTP,smtpmail}).
+(@pxref{Top,,,smtpmail,Sending mail via SMTP}).
@cindex background mode, on @command{xterm}
@item TERM
The type of the terminal that Emacs is using. This variable must be
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
-Names}).
+Used to initialize the @code{version-control} variable (@pxref{Numbered Backups}).
@end table
@node Misc Variables
@pindex addpm, MS-Windows installation program
@cindex registry, setting environment variables and resources on MS-Windows
-On MS-Windows, the installation program @command{addpm.exe} adds values
-for @env{emacs_dir}, @env{EMACSLOADPATH}, @env{EMACSDATA},
+Under MS-Windows, the installation program @command{addpm.exe} adds
+values for @env{emacs_dir}, @env{EMACSLOADPATH}, @env{EMACSDATA},
@env{EMACSPATH}, @env{EMACSDOC}, @env{SHELL} and @env{TERM} to the
@file{HKEY_LOCAL_MACHINE} section of the system registry, under
@file{/Software/GNU/Emacs}. It does this because there is no standard
place to set environment variables across different versions of
-Windows. Running @command{addpm.exe} is no longer strictly
-necessary in recent versions of Emacs, but if you are upgrading from
-an older version, running @command{addpm.exe} ensures that you do not have
+Windows. Running @command{addpm.exe} is no longer strictly necessary
+in recent versions of Emacs, but if you are upgrading from an older
+version, running @command{addpm.exe} ensures that you do not have
older registry entries from a previous installation, which may not be
compatible with the latest version of Emacs.
@node Colors
@appendixsec Window Color Options
-@cindex color of window
+@cindex color of window, from command line
@cindex text colors, from command line
@findex list-colors-display
@item --color=@var{mode}
@opindex --color
@cindex standard colors on a character terminal
-For a character terminal only, specify the mode of color support. The
-parameter @var{mode} can be one of the following:
+@cindex override character terminal color support
+For a character terminal only, specify the mode of color support.
+This option is intended for overriding the number of supported colors
+that the character terminal advertises in its @code{termcap} or
+@code{terminfo} database. The parameter @var{mode} can be one of the
+following:
@table @samp
@item never
@itemx no
@samp{-rv} option or with the X resource @samp{reverseVideo}.
The @samp{-fg}, @samp{-bg}, and @samp{-rv} options function on
-text-only terminals as well as on window systems.
+text-only terminals as well as on graphical displays.
@node Window Size X
@appendixsec Options for Window Size and Position
@cindex geometry, command-line argument
Specify the size @var{width} and @var{height} (measured in character
columns and lines), and positions @var{xoffset} and @var{yoffset}
-(measured in pixels). This applies to all frames.
+(measured in pixels). The @var{width} and @var{height} parameters
+apply to all frames, whereas @var{xoffset} and @var{yoffset} only to
+the initial frame.
@item -fs
@opindex -fs
@appendixsec Icons
@cindex icons (X Window System)
- Most window managers allow the user to ``iconify'' a frame, removing
+ Most window managers allow you to ``iconify'' a frame, removing
it from sight, and leaving a small, distinctive ``icon'' window in its
place. Clicking on the icon window makes the frame itself appear again.
If you have many clients running at once, you can avoid cluttering up
the screen by iconifying most of the clients.
@table @samp
-@item -i
-@opindex -i
-@itemx --icon-type
-@opindex --icon-type
+@item -nbi
+@opindex -nbi
+@itemx --no-bitmap-icon
+@opindex --no-bitmap-icon
@cindex Emacs icon, a gnu
-Use a picture of a gnu as the Emacs icon.
+Do not use a picture of a gnu as the Emacs icon.
@item -iconic
@opindex --iconic
Start Emacs in iconified state.
@end table
- The @samp{-i} or @samp{--icon-type} option tells Emacs to use an icon
-window containing a picture of the GNU gnu. If omitted, Emacs lets the
+ By default Emacs uses an icon window containing a picture of the GNU gnu.
+The @samp{-nbi} or @samp{--no-bitmap-icon} option tells Emacs to let the
window manager choose what sort of icon to use---usually just a small
rectangle containing the frame's title.
@opindex -hb
@itemx --horizontal-scroll-bars
@opindex --horizontal-scroll-bars
-@cindex horizontal scroll bars, command-line argument
-Enable horizontal scroll bars.
+@c @cindex horizontal scroll bars, command-line argument
+Enable horizontal scroll bars. Since horizontal scroll bars
+are not yet implemented, this actually does nothing.
@item -vb
@opindex -vb
@itemx --no-blinking-cursor
@opindex --no-blinking-cursor
@cindex blinking cursor disable, command-line argument
-Disable the blinking cursor on graphical terminals.
+Disable the blinking cursor on graphical displays.
+
+@item -D
+@opindex -D
+@itemx --basic-display
+@opindex --basic-display
+Disable the menu-bar, the tool-bar, the scroll-bars, and tool tips,
+and turn off the blinking cursor. This can be useful for making a
+test case that simplifies debugging of display problems.
@end table
The @samp{--xrm} option (@pxref{Resources}) specifies additional
HCoop / bpt / emacs.git / blobdiff