@c This is part of the Emacs manual.
-@c Copyright (C) 1985,86,87,93,94,95,1997,2001, 2003 Free Software Foundation, Inc.
+@c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2001, 2002,
+@c 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
@c See file emacs.texi for copying conditions.
-@node Command Arguments, X Resources, Service, Top
-@appendix Command Line Arguments
+@node Emacs Invocation, X Resources, GNU Free Documentation License, Top
+@appendix Command Line Arguments for Emacs Invocation
@cindex command line arguments
@cindex arguments (command line)
@cindex options (command line)
@cindex switches (command line)
@cindex startup (command line arguments)
+@cindex invocation (command line arguments)
GNU Emacs supports command line arguments to request various actions
when invoking Emacs. These are for compatibility with other editors and
for sophisticated activities. We don't recommend using them for
ordinary editing.
- Arguments starting with @samp{-} are @dfn{options}. Other arguments
-specify files to visit. Emacs visits the specified files while it
-starts up. The last file name on your command line becomes the
-current buffer; the other files are also visited in other buffers. If
-there are two files, they are both displayed; otherwise the last file
-is displayed along with a buffer list that shows what other buffers
-there are. As with most programs, the special argument @samp{--} says
-that all subsequent arguments are file names, not options, even if
-they start with @samp{-}.
+ Arguments starting with @samp{-} are @dfn{options}, and so is
+@samp{+@var{linenum}}. All other arguments specify files to visit.
+Emacs visits the specified files while it starts up. The last file
+name on your command line becomes the current buffer; the other files
+are also visited in other buffers. If there are two files, they are
+both displayed; otherwise the last file is displayed along with a
+buffer list that shows what other buffers there are. As with most
+programs, the special argument @samp{--} says that all subsequent
+arguments are file names, not options, even if they start with
+@samp{-}.
Emacs command options can specify many things, such as the size and
position of the X window Emacs uses, its colors, and so on. A few
@cindex initial options (command line)
@cindex action options (command line)
+@vindex command-line-args
Most options specify how to initialize Emacs, or set parameters for
the Emacs session. We call them @dfn{initial options}. A few options
specify things to do: for example, load libraries, call functions, or
terminate Emacs. These are called @dfn{action options}. These and file
names together are called @dfn{action arguments}. Emacs processes all
-the action arguments in the order they are written.
+the action arguments in the order they are written. The @file{.emacs} file
+can access the values of the action arguments as the elements of a list in
+the variable @code{command-line-args}.
+
+
@menu
-* Action Arguments:: Arguments to visit files, load libraries,
- and call functions.
+* Action Arguments:: Arguments to visit files, load libraries,
+ and call functions.
* Initial Options:: Arguments that take effect while starting Emacs.
* Command Example:: Examples of using command line arguments.
-* Resume Arguments:: Specifying arguments when you resume a running Emacs.
+* Resume Arguments:: Specifying arguments when you resume a running Emacs.
* Environment:: Environment variables that Emacs uses.
* Display X:: Changing the default display and using remote login.
-* Font X:: Choosing a font for text, under X.
-* Colors:: Choosing display colors.
+* Font X:: Choosing a font for text, under X.
+* Colors:: Choosing display colors.
* Window Size X:: Start-up window size, under X.
-* Borders X:: Internal and external borders, under X.
+* Borders X:: Internal and external borders, under X.
* Title X:: Specifying the initial frame's title.
* Icons X:: Choosing what sort of icon to use, under X.
+* Misc X:: Other display options.
@end menu
@node Action Arguments
@table @samp
@item @var{file}
-@opindex --visit
-@itemx --visit=@var{file}
@opindex --file
@itemx --file=@var{file}
+@opindex --find-file
+@itemx --find-file=@var{file}
+@opindex --visit
+@itemx --visit=@var{file}
@cindex visiting files, command-line argument
@vindex inhibit-startup-buffer-menu
Visit @var{file} using @code{find-file}. @xref{Visiting}.
@opindex --load
@cindex loading Lisp libraries, command-line argument
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 @env{EMACSLOADPATH} (@pxref{General Variables}).
+@xref{Lisp Libraries}. If @var{file} is not an absolute file name,
+the library can be found either in the current directory, or in the
+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}
+@opindex --directory
+Add directory @var{dir} to the variable @code{load-path}.
@item -f @var{function}
@opindex -f
@itemx --funcall=@var{function}
@opindex --funcall
@cindex call Lisp functions, command-line argument
-Call Lisp function @var{function} with no arguments.
+Call Lisp function @var{function}. If it is an interactive function
+(a command), it reads the arguments interactively just as if you had
+called the same function with a key sequence. Otherwise, it calls the
+function with no arguments.
@item --eval=@var{expression}
@opindex --eval
@item --kill
@opindex --kill
Exit from Emacs without asking for confirmation.
-@end table
-@vindex command-line-args
- The init file can access the values of the action arguments as the
-elements of a list in the variable @code{command-line-args}. The init
-file can override the normal processing of the action arguments, or
-define new ones, by reading and setting this variable.
+@item --help
+@opindex --help
+Print a usage message listing all available options, then exit
+successfully.
+
+@item --version
+@opindex --version
+Print Emacs version, then exit successfully.
+@end table
@node Initial Options
@appendixsec Initial Options
Some initial options affect the loading of init files. The normal
actions of Emacs are to first load @file{site-start.el} if it exists,
then your own init file @file{~/.emacs} if it exists, and finally
-@file{default.el} if it exists; certain options prevent loading of some
-of these files or substitute other files for them.
+@file{default.el} if it exists. @xref{Init File}. Certain options
+prevent loading of some of these files or substitute other files for
+them.
@table @samp
@item -t @var{device}
@opindex --terminal
@cindex device for Emacs terminal I/O
Use @var{device} as the device for terminal input and output.
+@samp{--terminal} implies @samp{--no-window-system}.
@item -d @var{display}
@opindex -d
@item -batch
@opindex --batch
@itemx --batch
-Run Emacs in @dfn{batch mode}, which means that the text being edited is
-not displayed and the standard terminal interrupt characters such as
-@kbd{C-z} and @kbd{C-c} continue to have their normal effect. Emacs in
-batch mode outputs to @code{stderr} only what would normally be displayed
-in the echo area under program control, and functions which would
-normally read from the minibuffer take their input from @code{stdin}.
-
-Batch mode is used for running programs written in Emacs Lisp from
-shell scripts, makefiles, and so on. Normally the @samp{-l} option
-or @samp{-f} option will be used as well, to invoke a Lisp program
-to do the batch processing.
-
-@samp{--batch} implies @samp{-q} (do not load an init file). It also
-causes Emacs to exit after processing all the command options. In
-addition, it disables auto-saving except in buffers for which it has
-been explicitly requested.
+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.
+
+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}
+continue to have their normal effect. The functions @code{prin1},
+@code{princ} and @code{print} output to @code{stdout} instead of the
+echo area, while @code{message} and error messages output to
+@code{stderr}. Functions that would normally read from the minibuffer
+take their input from @code{stdin} instead.
+
+@samp{--batch} implies @samp{-q} (do not load an init file), but
+@file{site-start.el} is loaded nonetheless. It also causes Emacs to
+exit after processing all the command options. In addition, it
+disables auto-saving except in buffers for which it has been
+explicitly requested.
@item --script @var{file}
@opindex --script
+@cindex script mode
Run Emacs in batch mode, like @samp{--batch}, and then read and
execute the Lisp code in @var{file}.
@opindex -q
@itemx --no-init-file
@opindex --no-init-file
-@cindex bypassing init and site-start file
+@cindex bypassing init and @file{default.el} file
@cindex init file, not loading
@cindex @file{default.el} file, not loading
Do not load your Emacs init file @file{~/.emacs}, or @file{default.el}
-either. When invoked like this, Emacs does not allow saving options
+either. Regardless of this switch, @file{site-start.el} is still loaded.
+When invoked like this, Emacs does not allow saving options
changed with the @kbd{M-x customize} command and its variants.
@xref{Easy Customization}.
@opindex --no-site-file
@cindex @file{site-start.el} file, not loading
Do not load @file{site-start.el}. The options @samp{-q}, @samp{-u}
-and @samp{-batch} have no effect on the loading of this file---this is
-the only option that blocks it.
+and @samp{--batch} have no effect on the loading of this file---this
+option and @samp{-Q} are the only options that block it.
+
+@item -Q
+@opindex -Q
+@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
Do not display a splash screen on startup; this is equivalent to
setting the variable @code{inhibit-startup-message} to non-@code{nil}.
+@item --no-desktop
+@opindex --no-desktop
+Do not reload any saved desktop. @xref{Saving Emacs Sessions}.
+
@item -u @var{user}
@opindex -u
@itemx --user=@var{user}
@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
@cindex errors in init file
Enable the Emacs Lisp debugger for errors in the init file.
+@xref{Error Debugging,, Entering the Debugger on an Error, elisp, The
+GNU Emacs Lisp Reference Manual}.
@item --unibyte
@opindex --unibyte
+@itemx --no-multibyte
+@opindex --no-multibyte
@cindex unibyte operation, command-line argument
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. (Note that Emacs
always loads Lisp files in multibyte mode, even if @samp{--unibyte} is
specified; see @ref{Enabling Multibyte}.) Setting the environment
-variable @env{EMACS_UNIBYTE} has the same effect.
+variable @env{EMACS_UNIBYTE} has the same effect
+(@pxref{General Variables}).
@item --multibyte
@opindex --multibyte
+@itemx --no-unibyte
+@opindex --no-unibyte
Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs
uses multibyte characters by default, as usual.
@end table
to be a C program.
@example
-emacs -batch foo.c -l hack-c -f save-buffer >& log
+emacs --batch foo.c -l hack-c -f save-buffer >& log
@end example
@noindent
This says to visit @file{foo.c}, load @file{hack-c.el} (which makes
changes in the visited file), save @file{foo.c} (note that
@code{save-buffer} is the function that @kbd{C-x C-s} is bound to), and
-then exit back to the shell (because of @samp{-batch}). @samp{-batch}
+then exit back to the shell (because of @samp{--batch}). @samp{--batch}
also guarantees there will be no problem redirecting output to
@file{log}, because Emacs will not assume that it has a display terminal
to work with.
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.}
@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.
-@item MAILRC
-Name of file containing mail aliases. (The default is
-@file{~/.mailrc}.)
+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,,,Sending mail via SMTP,smtpmail}).
@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
@end smallexample
You can inhibit the direct use of the window system and GUI with the
-@samp{-nw} option. It tells Emacs to display using ordinary ASCII on
+@samp{-nw} option. It tells Emacs to display using ordinary @acronym{ASCII} on
its controlling terminal. This is also an initial option.
Sometimes, security arrangements prevent a program on a remote system
@appendixsec Font Specification Options
@cindex font name (X Window System)
- By default, Emacs displays text in the font named @samp{9x15}, which
-makes each character nine pixels wide and fifteen pixels high. You can
-specify a different font on your command line through the option
-@samp{-fn @var{name}} (or @samp{--font}, which is an alias for
-@samp{-fn}).
+ By default, Emacs displays text in a twelve point Courier font (when
+using X). You can specify a different font on your command line
+through the option @samp{-fn @var{name}} (or @samp{--font}, which is
+an alias for @samp{-fn}).
@table @samp
@item -fn @var{name}
Use font @var{name} as the default font.
@end table
- Under X, each font has a long name which consists of eleven words or
-numbers, separated by dashes. Some fonts also have shorter
-nicknames---@samp{9x15} is such a nickname. You can use either kind of
-name. You can use wildcard patterns for the font name; then Emacs lets
-X choose one of the fonts that match the pattern. Here is an example,
-which happens to specify the font whose nickname is @samp{6x13}:
+ Under X, each font has a long name which consists of fourteen words
+or numbers, separated by dashes. Some fonts also have shorter
+nicknames. For instance, @samp{9x15} is such a nickname. This font
+makes each character nine pixels wide and fifteen pixels high. You
+can use either kind of name. Case is insignificant in both kinds.
+You can use wildcard patterns for the font name; then Emacs lets X
+choose one of the fonts that match the pattern. The wildcard
+character @samp{*} matches any sequence of characters (including none)
+and @samp{?} matches any single character. However, matching is
+implementation-dependent, and can be inaccurate when wildcards match
+dashes in a long name. For reliable results, supply all 14 dashes and
+use wildcards only within a field. Here is an example, which happens
+to specify the font whose nickname is @samp{6x13}:
@smallexample
emacs -fn \
@smallexample
emacs.font: -misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
+@end smallexample
+
+ Note that if you use a wildcard pattern on the command line, you
+need to enclose it in single or double quotes, to prevent the shell
+from accidentally expanding it into a list of file names. On the
+other hand, you should not quote the name in the @file{.Xdefaults}
+file.
+
+The default font used by Emacs (under X) is:
+
+@smallexample
+-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1
@end smallexample
A long font name has the following form:
@smallexample
-@var{maker}-@var{family}-@var{weight}-@var{slant}-@var{widthtype}-@var{style}@dots{}
-@dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{charset}
+@dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{registry}-@var{encoding}
@end smallexample
@table @var
(character cell).
@item width
This is the average character width, in pixels, multiplied by ten.
-@item charset
-This is the character set that the font depicts.
-Normally you should use @samp{iso8859-1}.
+@item registry
+@itemx encoding
+These together make up the X font character set that the font depicts.
+(X font character sets are not the same as Emacs charsets, but they
+are solutions for the same problem.) You can use the
+@command{xfontsel} program to check which choices you have. However,
+normally you should use @samp{iso8859} for @var{registry} and @samp{1}
+for @var{encoding}.
@end table
@cindex listing system fonts
parts of the Emacs display. To find out what colors are available on
your system, type @kbd{M-x list-colors-display}, or press
@kbd{C-Mouse-2} and select @samp{Display Colors} from the pop-up menu.
+(A particular window system might support many more colors, but the
+list displayed by @code{list-colors-display} shows their portable
+subset that can be safely used on any display supported by Emacs.)
If you do not specify colors, on windowed displays the default for the
background is white and the default for all other colors is black. On a
monochrome display, the foreground is black, the background is white,
Use color mode for @var{num} colors. If @var{num} is -1, turn off
color support (equivalent to @samp{never}); if it is 0, use the
default color support for this terminal (equivalent to @samp{auto});
-otherwise use an appropriate standard mode for @var{num} colors. If
+otherwise use an appropriate standard mode for @var{num} colors.
+Depending on your terminal's capabilities, Emacs might be able to turn
+on a color mode for 8, 16, 88, or 256 as the value of @var{num}. If
there is no mode that supports @var{num} colors, Emacs acts as if
@var{num} were 0, i.e.@: it uses the terminal's default color support
mode.
@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
@table @samp
@item -g @var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]}
@opindex -g
+@itemx --geometry=@var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]}
+@opindex --geometry
+@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.
-@item --geometry=@var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]}
-@opindex --geometry
-This is another way of writing the same thing.
-
@item -fs
@opindex -fs
@itemx --fullscreen
@file{~/.emacs} file disables the tool bar, you will end up with a
frame geometry different from what you asked for. To get the intended
size with no tool bar, use an X resource to specify ``no tool bar''
-(@pxref{Table of Resources});then Emacs will already know there's no
+(@pxref{Table of Resources}); then Emacs will already know there's no
tool bar when it processes the specified geometry.
When using one of @samp{--fullscreen}, @samp{--fullwidth} or
@opindex -ib
@itemx --internal-border=@var{width}
@opindex --internal-border
-@cindex border width, command-line argument
-Specify @var{width} as the width of the internal border, in pixels.
+@cindex internal border width, command-line argument
+Specify @var{width} as the width of the internal border (between the text
+and the main border), in pixels.
@item -bw @var{width}
@opindex -bw
@itemx --border-width=@var{width}
@opindex --border-width
+@cindex main border width, command-line argument
Specify @var{width} as the width of the main border, in pixels.
@end table
line option:
@table @samp
-@item -title @var{title}
-@opindex --title
-@itemx --title=@var{title}
-@itemx -T @var{title}
+@item -T @var{title}
@opindex -T
+@itemx --title=@var{title}
+@opindex --title
@cindex frame title, command-line argument
Specify @var{title} as the title for the initial Emacs frame.
@end table
@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.
rather than showing a frame right away. In this situation, the icon
is the only indication that Emacs has started; the text frame doesn't
appear until you deiconify it.
+
+@node Misc X
+@appendixsec Other Display Options
+
+@table @samp
+@item -hb
+@opindex -hb
+@itemx --horizontal-scroll-bars
+@opindex --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 --vertical-scroll-bars
+@opindex --vertical-scroll-bars
+@cindex vertical scroll bars, command-line argument
+Enable vertical scroll bars.
+
+@item -lsp @var{pixels}
+@opindex -lsp
+@itemx --line-spacing=@var{pixels}
+@opindex --line-spacing
+@cindex line spacing, command-line argument
+Specify @var{pixels} as additional space to put between lines, in pixels.
+
+@item -nbc
+@opindex -nbc
+@itemx --no-blinking-cursor
+@opindex --no-blinking-cursor
+@cindex blinking cursor disable, command-line argument
+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
+X resource values.
+
+@ignore
+ arch-tag: fffecd9e-7329-4a51-a3cc-dd4a9889340e
+@end ignore