]> code.delx.au - gnu-emacs/blobdiff - man/cmdargs.texi
Fixed reference to free variable.
[gnu-emacs] / man / cmdargs.texi
index 8a64fea68bf9a52057e5e01f9679859476402bfa..62cfaf14f224e8a62d0fabcf1fbaa66766a46fa5 100644 (file)
@@ -77,35 +77,51 @@ the action arguments in the order they are written.
 
 @table @samp
 @item @var{file}
+@opindex --visit
 @itemx --visit=@var{file}
+@opindex --file
 @itemx --file=@var{file}
+@cindex visiting files, command-line argument
 Visit @var{file} using @code{find-file}.  @xref{Visiting}.
 
 @item +@var{linenum} @var{file}
+@opindex +@var{linenum}
 Visit @var{file} using @code{find-file}, then go to line number
 @var{linenum} in it.
 
 @need 3000
 @item -l @var{file}
+@opindex -l
 @itemx --load=@var{file}
+@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}).
 
 @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.
 
 @item --eval=@var{expression}
+@opindex --eval
 @itemx --execute=@var{expression}
+@opindex --execute
+@cindex evaluate expression, command-line argument
 Evaluate Lisp expression @var{expression}.
 
 @item --insert=@var{file}
+@opindex --insert
+@cindex insert file contents, command-line argument
 Insert the contents of @var{file} into the current buffer.  This is like
 what @kbd{M-x insert-file} does.  @xref{Misc File Ops}.
 
 @item --kill
+@opindex --kill
 Exit from Emacs without asking for confirmation.
 @end table
 
@@ -131,16 +147,25 @@ of these files or substitute other files for them.
 
 @table @samp
 @item -t @var{device}
+@opindex -t
 @itemx --terminal=@var{device}
+@opindex --terminal
+@cindex device for Emacs terminal I/O
 Use @var{device} as the device for terminal input and output.
 
 @item -d @var{display}
+@opindex -d
 @itemx --display=@var{display}
+@opindex --display
+@cindex display for Emacs frame
 Use the X Window System and use the display named @var{display} to open
-the initial Emacs frame.
+the initial Emacs frame.  @xref{Display X}, for more details.
 
 @item -nw
+@opindex -nw
 @itemx --no-windows
+@opindex --no-windows
+@cindex disable window system
 Don't communicate directly with the window system, disregarding the
 @env{DISPLAY} environment variable even if it is set.  This forces Emacs
 to run as if the display were a text-only terminal.
@@ -148,12 +173,14 @@ to run as if the display were a text-only terminal.
 @need 3000
 @cindex batch mode
 @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 printed
-in the echo area under program control.
+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
@@ -166,24 +193,39 @@ addition, auto-saving is not done except in buffers for which it has been
 explicitly requested.
 
 @item -q
+@opindex -q
 @itemx --no-init-file
+@opindex --no-init-file
+@cindex bypassing init and site-start 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.
+either.  When invoked like this, Emacs does not allow to save options
+changed with the @kbd{M-x customize} command and its variants.
+@xref{Easy Customization}.
 
 @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 is
 the only option that blocks it.
 
 @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.
 
 @item --debug-init
+@opindex --debug-init
+@cindex errors in init file
 Enable the Emacs Lisp debugger for errors in the init file.
 
 @item --unibyte
+@opindex --unibyte
 @cindex unibyte operation, command-line argument
 Set up to do almost everything with single-byte buffers and strings.
 All buffers and strings are unibyte unless you (or a Lisp program)
@@ -193,6 +235,7 @@ specified; see @ref{Enabling Multibyte}.)  Setting the environment
 variable @env{EMACS_UNIBYTE} has the same effect.
 
 @item --multibyte
+@opindex --multibyte
 Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs
 uses multibyte characters by default, as usual.
 @end table
@@ -361,18 +404,24 @@ to search for files.
 @item INFOPATH
 A colon-separated list of directories in which to search for Info files.
 @item LC_ALL
+@itemx LC_COLLATE
 @itemx LC_CTYPE
+@itemx LC_MESSAGES
+@itemx LC_MONETARY
+@itemx LC_NUMERIC
+@itemx LC_TIME
 @itemx LANG
-The user's preferred locale.  (The first of these environment
-variables with a nonempty value specifies the locale.)  A locale name
-which contains @samp{8859-@var{n}}, @samp{8859_@var{n}} or
-@samp{8859@var{n}}, where @var{n} is between 1 and 4, automatically
-specifies the @samp{Latin-@var{n}} language environment when Emacs
-starts up.  There are a few extensions: if @var{n} is 9, that specifies
-@samp{Latin-5}, and if @var{n} is 14 or 15, that specifies
-@samp{Latin-8} and @samp{Latin-9}, respectively.
-
-The locale value you specify with one of these three variables is
+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
+messages, @env{LC_MONETARY} for monetary formats, @env{LC_NUMERIC} for
+numbers, and @env{LC_TIME} for dates and times.  If one of these
+variables is not set, the category defaults to the value of the
+@env{LANG} environment variable, or to the default @samp{C} locale if
+@env{LANG} is not set.  But if @env{LC_ALL} is specified, it overrides
+the settings of all the other locale environment variables.
+
+The value of the LC_CTYPE category is
 matched against entries in @code{locale-language-names},
 @code{locale-charset-language-names}, and
 @code{locale-preferred-coding-systems}, to select a default language
@@ -552,7 +601,10 @@ specify a different font on your command line through the option
 
 @table @samp
 @item -fn @var{name}
+@opindex -fn
 @itemx --font=@var{name}
+@opindex --font
+@cindex specify default font from the command line
 Use font @var{name} as the default font.
 @end table
 
@@ -624,6 +676,7 @@ This is the character set that the font depicts.
 Normally you should use @samp{iso8859-1}.
 @end table
 
+@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.  Any font with
 @samp{m} or @samp{c} in the @var{spacing} field of the long name is a
@@ -653,7 +706,7 @@ displays the entire font @samp{6x13}.
 
 @node Colors X
 @appendixsec Window Color Options
-@cindex color of window (X Window System)
+@cindex color of window
 @cindex text colors, from command line
 
 @findex list-colors-display
@@ -671,25 +724,45 @@ background is usually black and the foreground is white.
   Here is a list of the command-line options for specifying colors:
 
 @table @samp
-@item -fg @var{color} 
-@itemx --foreground-color=@var{color} 
+@item -fg @var{color}
+@opindex -fg
+@itemx --foreground-color=@var{color}
+@opindex --foreground-color
+@cindex foreground color, command-line argument
 Specify the foreground color.  @var{color} should be a standard color
 name, or a numeric specification of the color's red, green, and blue
 components as in @samp{#4682B4} or @samp{RGB:46/82/B4}.
-@item -bg @var{color} 
-@itemx --background-color=@var{color} 
+@item -bg @var{color}
+@opindex -bg
+@itemx --background-color=@var{color}
+@opindex --background-color
+@cindex background color, command-line argument
 Specify the background color.
-@item -bd @var{color} 
-@itemx --border-color=@var{color} 
+@item -bd @var{color}
+@opindex -bd
+@itemx --border-color=@var{color}
+@opindex --border-color
+@cindex border color, command-line argument
 Specify the color of the border of the X window.
-@item -cr @var{color} 
-@itemx --cursor-color=@var{color} 
+@item -cr @var{color}
+@opindex -cr
+@itemx --cursor-color=@var{color}
+@opindex --cursor-color
+@cindex cursor color, command-line argument
 Specify the color of the Emacs cursor which indicates where point is.
-@item -ms @var{color} 
-@itemx --mouse-color=@var{color} 
+@item -ms @var{color}
+@opindex -ms
+@itemx --mouse-color=@var{color}
+@opindex --mouse-color
+@cindex mouse pointer color, command-line argument
 Specify the color for the mouse cursor when the mouse is in the Emacs window.
 @item -r
+@opindex -r
+@itemx -rv
+@opindex -rv
 @itemx --reverse-video
+@opindex --reverse-video
+@cindex reverse video, command-line argument
 Reverse video---swap the foreground and background colors.
 @end table
 
@@ -701,14 +774,15 @@ emacs -ms coral -cr 'slate blue' &
 @end example
 
   You can reverse the foreground and background colors through the
-@samp{-r} option or with the X resource @samp{reverseVideo}.
+@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.
 
 @node Window Size X
 @appendixsec Options for Window Geometry
-@cindex geometry (X Window System)
+@cindex geometry of Emacs window
+@cindex position and size of Emacs frame
 
   The @samp{-geometry} option controls the size and position of the
 initial Emacs frame.  Here is the format for specifying the window
@@ -716,11 +790,13 @@ geometry:
 
 @table @samp
 @item -g @var{width}x@var{height}@r{@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}
+@opindex -g
 Specify window size @var{width} and @var{height} (measured in character
 columns and lines), and positions @var{xoffset} and @var{yoffset}
 (measured in pixels).
 
 @item --geometry=@var{width}x@var{height}@r{@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}
+@opindex --geometry
 This is another way of writing the same thing.
 @end table
 
@@ -785,11 +861,16 @@ the window.
 
 @table @samp
 @item -ib @var{width}
+@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.
 
 @item -bw @var{width}
+@opindex -bw
 @itemx --border-width=@var{width}
+@opindex --border-width
 Specify @var{width} as the width of the main border, in pixels.
 @end table
 
@@ -817,8 +898,11 @@ line option:
 
 @table @samp
 @item -title @var{title}
+@opindex --title
 @itemx --title=@var{title}
 @itemx -T @var{title}
+@opindex -T
+@cindex frame title, command-line argument
 Specify @var{title} as the title for the initial Emacs frame.
 @end table
 
@@ -837,11 +921,16 @@ the screen by iconifying most of the clients.
 
 @table @samp
 @item -i
+@opindex -i
 @itemx --icon-type
+@opindex --icon-type
+@cindex Emacs icon, a gnu
 Use a picture of a gnu as the Emacs icon.
 
 @item -iconic
+@opindex --iconic
 @itemx --iconic
+@cindex start iconified, command-line argument
 Start Emacs in iconified state.
 @end table
 
@@ -868,6 +957,12 @@ values for these options in your X resources file, usually named
 collection of related options, for one program or for several programs
 (optionally even for all programs).
 
+@cindex Registry (MS-Windows)
+  MS-Windows systems don't support @file{~/.Xdefaults} files, but
+Emacs compiled for Windows looks for X resources in the Windows
+Registry, under the keys @samp{HKEY_CURRENT_USER\SOFTWARE\GNU\Emacs}
+and @samp{HKEY_LOCAL_MACHINE\SOFTWARE\GNU\Emacs}.
+
   Programs define named resources with particular meanings.  They also
 define how to group resources into named classes.  For instance, in
 Emacs, the @samp{internalBorder} resource controls the width of the
@@ -912,7 +1007,9 @@ looks for resources under that name instead of @samp{emacs}.
 
 @table @samp
 @item -name @var{name}
+@opindex --name
 @itemx --name=@var{name}
+@cindex resource name, command-line argument
 Use @var{name} as the resource name (and the title) for the initial
 Emacs frame.  This option does not affect subsequent frames, but Lisp
 programs can specify frame names when they create frames.
@@ -921,7 +1018,9 @@ If you don't specify this option, the default is to use the Emacs
 executable's name as the resource name.
 
 @item -xrm @var{resource-values}
+@opindex --xrm
 @itemx --xrm=@var{resource-values}
+@cindex resource values, command-line argument
 Specify X resource values for this Emacs job (see below).
 @end table
 
@@ -1009,6 +1108,7 @@ If @samp{none}, don't make a minibuffer in this frame.
 It will use a separate minibuffer frame instead.
 
 @item @code{paneFont} (class @code{Font})
+@cindex font for menus
 Font name for menu pane titles, in non-toolkit versions of Emacs.
 
 @item @code{pointerColor} (class @code{Foreground})
@@ -1035,6 +1135,8 @@ toolkit versions, see @ref{Lucid Resources}, also see @ref{LessTif
 Resources}.)
 
 @item @code{synchronous} (class @code{Synchronous})
+@cindex debugging X problems
+@cindex synchronous X mode
 Run Emacs in synchronous mode if @samp{on}.  Synchronous mode is
 useful for debugging X problems.