@c This is part of the Emacs manual.
-@c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2001, 2002,
-@c 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+@c Copyright (C) 1985-1987, 1993-1995, 1997, 2001-2011
+@c 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
other files for them.
@table @samp
+@item -chdir @var{directory}
+@opindex -chdir
+@itemx --chdir=@var{directory}
+@opindex --chdir
+@cindex change Emacs directory
+Change to @var{directory} before doing anything else. This is mainly used
+by session management in X so that Emacs starts in the same directory as it
+stopped. This makes desktop saving and restoring easier.
+
@item -t @var{device}
@opindex -t
@itemx --terminal=@var{device}
@item --no-site-file
@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
-option and @samp{-Q} are the only options that block it.
+Do not load @file{site-start.el} (@pxref{Init File}). The @samp{-Q}
+option does this too, but other options like @samp{-q} do not.
+
+@item --no-site-lisp
+@opindex --no-site-lisp
+@cindex @file{site-start.el} file, not loading
+Do not include the @file{site-lisp} directories in @code{load-path}
+(@pxref{Init File}). The @samp{-Q} option does this too.
@item --no-splash
@opindex --no-splash
@opindex -Q
@itemx --quick
@opindex --quick
-Start emacs with minimum customizations. This is like using
-@samp{-q}, @samp{--no-site-file}, and @samp{--no-splash} together.
+Start emacs with minimum customizations, similar to using @samp{-q},
+@samp{--no-site-file}, @samp{--no-site-lisp}, and @samp{--no-splash}
+together. This also stops Emacs from processing X resources by
+setting @code{inhibit-x-resources} to @code{t} (@pxref{Resources}).
@item -daemon
@opindex -daemon
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
-(@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
@node Command Example
@vindex initial-environment
Inside Emacs, the command @kbd{M-x getenv} gets the value of an
environment variable. @kbd{M-x setenv} sets a variable in the Emacs
-environment. (Environment variable substitutions with @samp{$} work
-in the value just as in file names; see @ref{File Names with $}.) The
-variable @code{initial-environment} stores the initial environment
-inherited by Emacs.
+environment, and @kbd{C-u M-x setenv} removes a variable.
+(Environment variable substitutions with @samp{$} work in the value
+just as in file names; see @ref{File Names with $}.) The variable
+@code{initial-environment} stores the initial environment inherited by
+Emacs.
The way to set environment variables outside of Emacs depends on the
operating system, and especially the shell that you are using. For
@item CDPATH
Used by the @code{cd} command to search for the directory you specify,
when you specify a relative directory name.
-@item EMACS_UNIBYTE
-@cindex unibyte operation, environment variable
-Defining this environment variable with a nonempty value directs Emacs
-to do almost everything with single-byte buffers and strings. It is
-equivalent to using the @samp{--unibyte} command-line option on each
-invocation. @xref{Initial Options}.
@item EMACSDATA
Directory for the architecture-independent files that come with Emacs.
This is used to initialize the Lisp variable @code{data-directory}.
@item EMACSDOC
-Directory for the documentation string file,
-@file{DOC-@var{emacsversion}}. This is used to initialize the Lisp
-variable @code{doc-directory}.
+Directory for the documentation string file, which is used to
+initialize the Lisp variable @code{doc-directory}.
@item EMACSLOADPATH
A colon-separated list of directories@footnote{
Here and below, whenever we say ``colon-separated list of directories,''
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 @env{DISPLAY} environment variable is
+ @env{DISPLAY} has the syntax
@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)
-from other servers on the same machine, and @var{screen} is a
-rarely-used field that allows an X server to control multiple terminal
-screens. The period and the @var{screen} field are optional. If
-included, @var{screen} is usually zero.
+arbitrarily-assigned number that distinguishes your server (X
+terminal) from other servers on the same machine, and @var{screen} is
+a rarely-used field that allows an X server to control multiple
+terminal screens. The period and the @var{screen} field are optional.
+If 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
@appendixsec Font Specification Options
@cindex font name (X Window System)
- By default, Emacs displays text in X using a twelve point monospace
-font. You can specify a different font using the command line option
-@samp{-fn @var{font}} (or @samp{--font}, which is an alias for
-@samp{-fn}).
+You can use the command line option @samp{-fn @var{font}} (or
+@samp{--font}, which is an alias for @samp{-fn}) to specify a default
+font:
@table @samp
@item -fn @var{font}
When passing a font specification to Emacs on the command line, you
may need to ``quote'' it, by enclosing it in quotation marks, if it
contains characters that the shell treats specially (e.g. spaces).
-Here is an example:
+For example:
@smallexample
emacs -fn "DejaVu Sans Mono-12"
@end smallexample
-@cindex X defaults file
-@cindex X resources file
- You can also specify the font using your X resources file (usually a
-file named @file{.Xdefaults} or @file{.Xresources} in your home
-directory), by adding a line like this:
-
-@smallexample
-emacs.font: @var{font}
-@end smallexample
-
-@noindent
-You must restart X, or use the @command{xrdb} command, for the X
-resources file to take effect. @xref{Resources}. When specifying a
-font in your X resources file, you should not quote it.
-
-@cindex fontconfig
- Emacs recognizes two types of fonts: @dfn{client-side} fonts, which
-are provided by the Xft and Fontconfig libraries, and
-@dfn{server-side} fonts, which are provided by the X server itself.
-Most client-side fonts support advanced font features such as
-antialiasing and subpixel hinting, while server-side fonts do not.
-
- There are four different ways to express a ``font name''. The first
-format consists of @dfn{Fontconfig patterns}. Fontconfig patterns
-match only client-side fonts provided by Xft and Fontconfig, and have
-the following form:
-
-@smallexample
-@var{fontname}[-@var{fontsize}][:@var{name1}=@var{values1}][:@var{name2}=@var{values2}]...
-@end smallexample
-
-@noindent
-Within this format, any of the elements in braces may be omitted.
-Here, @var{fontname} is the ``family name'' of the font, such as
-@samp{Monospace} or @samp{DejaVu Serif}; @var{fontsize} is the ``point
-size'' of the font (one ``printer's point'' is about 1/72 of an inch);
-and the @samp{@var{name}=@var{values}} entries specify settings such
-as the slant and weight of the font. Each @var{values} may be a
-single value, or a list of values separated by commas. In addition,
-some property values are valid with only one kind of property name, in
-which case the @samp{@var{name}=} part may be omitted.
-
-Here is a list of common font properties:
-
-@table @samp
-@item slant
-One of @samp{italic}, @samp{oblique} or @samp{roman}.
-
-@item weight
-One of @samp{light}, @samp{medium}, @samp{demibold}, @samp{bold} or
-@samp{black}.
-
-@item style
-Some fonts define special styles which are a combination of slant and
-weight. For instance, the font @samp{Dejavu Sans} defines the style
-@samp{book}. This property, if specified, overrides the slant and
-weight properties.
-
-@item width
-One of @samp{condensed}, @samp{normal}, or @samp{expanded}.
-
-@item spacing
-One of @samp{monospace}, @samp{proportional}, @samp{dual-width}, or
-@samp{charcell}.
-@end table
-
-@noindent
-Here are some examples of Fontconfig patterns:
-
-@smallexample
-Monospace
-Monospace-12
-Monospace-12:bold
-DejaVu Sans Mono:bold:italic
-Monospace-12:weight=bold:slant=italic
-@end smallexample
-
-See the Fontconfig manual for a more detailed description of
-Fontconfig patterns. This manual is located in the file
-@file{fontconfig-user.html}, which is distributed with Fontconfig. It
-is also available online at
-@url{http://fontconfig.org/fontconfig-user.html}. In particular, the
-manual describes additional font properties that influence how the
-font is hinted, antialiased, or scaled.
-
- The second way to specify a font is to use a @dfn{GTK font
-description}. Like Fontconfig patterns, GTK font descriptions match
-only client-side fonts provided by Xft and Fontconfig. They have the
-syntax
-
-@smallexample
-@var{fontname} [@var{properties}] [@var{fontsize}]
-@end smallexample
-
-@noindent
-where @var{fontname} is the family name, @var{properties} is a list of
-property values separated by spaces, and @var{fontsize} is the point
-size. The properties that you may specify are as follows:
-
-@table @samp
-@item style
-One of @samp{roman}, @samp{italic} or @samp{oblique}. If omitted, the
-@samp{roman} style is used.
-@item weight
-One of @samp{medium}, @samp{ultra-light}, @samp{light},
-@samp{semi-bold}, or @samp{bold}. If omitted, @samp{medium} weight is
-used.
-@end table
-
-@noindent
-Here are some examples of GTK font descriptions:
-
-@smallexample
-Monospace 12
-Monospace Bold Italic 12
-@end smallexample
-
-@cindex XLFD
-@cindex X Logical Font Description
- The third way to specify a font is to use an @dfn{XLFD} (@dfn{X
-Logical Font Description}), which is the traditional method for
-specifying fonts under X. Each XLFD consists of fourteen words or
-numbers, separated by dashes, like this:
-
-@smallexample
--misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
-@end smallexample
-
-@noindent
-A wildcard character (@samp{*}) in an XLFD 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.
-Case is insignificant in an XLFD. The syntax for an XLFD is as
-follows:
-
-@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{registry}-@var{encoding}
-@end smallexample
-
-@noindent
-The entries have the following meanings:
-
-@table @var
-@item maker
-The name of the font manufacturer.
-@item family
-The name of the font family (e.g. @samp{courier}).
-@item weight
-The font weight---normally either @samp{bold}, @samp{medium} or
-@samp{light}. Some font names support other values.
-@item slant
-The font slant---normally @samp{r} (roman), @samp{i} (italic),
-@samp{o} (oblique), @samp{ri} (reverse italic), or @samp{ot} (other).
-Some font names support other values.
-@item widthtype
-The font width---normally @samp{condensed}, @samp{extended},
-@samp{semicondensed} or @samp{normal} (some font names support other
-values).
-@item style
-An optional additional style name. Usually it is empty---most long
-font names have two hyphens in a row at this point.
-@item pixels
-The font height, in pixels.
-@item height
-The font height on the screen, measured in tenths of a printer's
-point. This is the point size of the font, times ten. For a given
-vertical resolution, @var{height} and @var{pixels} are proportional;
-therefore, it is common to specify just one of them and use @samp{*}
-for the other.
-@item horiz
-The horizontal resolution, in pixels per inch, of the screen for which
-the font is intended.
-@item vert
-The vertical resolution, in pixels per inch, of the screen for which
-the font is intended. Normally the resolution of the fonts on your
-system is the right value for your screen; therefore, you normally
-specify @samp{*} for this and @var{horiz}.
-@item spacing
-This is @samp{m} (monospace), @samp{p} (proportional) or @samp{c}
-(character cell).
-@item width
-The average character width, in pixels, multiplied by ten.
-@item registry
-@itemx encoding
-The X font character set that the font depicts. (X font character
-sets are not the same as Emacs character sets, but they are similar.)
-You can use the @command{xfontsel} program to check which choices you
-have. Normally you should use @samp{iso8859} for @var{registry} and
-@samp{1} for @var{encoding}.
-@end table
-
- Some fonts have shorter nicknames, which you can use instead of a
-normal font specification. For instance,
-
-@smallexample
--misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
-@end smallexample
-
-@noindent
-is equivalent to @samp{6x13}. This is the fourth and final method of
-specifying a font.
-
-@cindex listing system fonts
- You will probably want to use a fixed-width default font---that is,
-a font in which all characters have the same width. Here's how to use
-the @command{fc-list} command to list all fixed-width Xft and
-Fontconfig fonts available on your system:
-
-@example
-fc-list :spacing=mono
-fc-list :spacing=charcell
-@end example
-
- For server-side X fonts, any font with @samp{m} or @samp{c} in the
-@var{spacing} field of the XLFD is a fixed-width font. Here's how to
-use the @command{xlsfonts} program to list all the fixed-width fonts
-available on your system:
-
-@example
-xlsfonts -fn '*x*' | egrep "^[0-9]+x[0-9]+"
-xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*'
-xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*'
-@end example
-
-@noindent
-To see what a particular font looks like, use the @command{xfd} command.
-For example:
-
-@example
-xfd -fn 6x13
-@end example
-
-@noindent
-displays the entire font @samp{6x13}.
-
- While running Emacs, you can set the font of a specific kind of text
-(@pxref{Faces}), or of a particular frame (@pxref{Frame Parameters}).
+@xref{Fonts}, for other ways to specify the default font and font name
+formats.
@node Colors
@appendixsec Window Color Options
@itemx --fullscreen
@opindex --fullscreen
@cindex fullscreen, command-line argument
-Specify that width and height shall be the size of the screen.
+Specify that width and height shall be the size of the screen. Normally
+no window manager decorations are shown.
+
+@item -mm
+@opindex -mm
+@itemx --maximized
+@opindex --maximized
+@cindex maximized, command-line argument
+Specify that the Emacs frame shall be maximized. This normally
+means that the frame has window manager decorations.
@item -fh
@opindex -fh
(@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
-@samp{--fullheight} there may be some space around the frame
+ When using one of @samp{--fullscreen}, @samp{--maximized}, @samp{--fullwidth}
+or @samp{--fullheight} there may be some space around the frame
anyway. That is because Emacs rounds the sizes so they are an
even number of character heights and widths.
@c Enable horizontal scroll bars. Since horizontal scroll bars
@c are not yet implemented, this actually does nothing.
+@item --parent-id @var{ID}
+Open Emacs as a client X window via the XEmbed protocol, with @var{ID}
+as the parent X window id. Currently, this option is mainly useful
+for developers.
+
@item -vb
@opindex -vb
@itemx --vertical-scroll-bars
The @samp{--xrm} option (@pxref{Resources}) specifies additional
X resource values.
-
-@ignore
- arch-tag: fffecd9e-7329-4a51-a3cc-dd4a9889340e
-@end ignore