Add @opindex entries to index all command-line options.
This commit is contained in:
parent
2e88b53c21
commit
a8575fe531
1 changed files with 104 additions and 13 deletions
117
man/cmdargs.texi
117
man/cmdargs.texi
|
@ -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,6 +173,7 @@ 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
|
||||
|
@ -167,24 +193,36 @@ 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
|
||||
Do not load your Emacs init file @file{~/.emacs}, or @file{default.el}
|
||||
either.
|
||||
|
||||
@item --no-site-file
|
||||
@opindex --no-site-file
|
||||
@cindex site-start 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)
|
||||
|
@ -194,6 +232,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
|
||||
|
@ -559,7 +598,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
|
||||
|
||||
|
@ -631,6 +673,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
|
||||
|
@ -660,7 +703,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
|
||||
|
@ -678,26 +721,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
|
||||
|
||||
|
@ -716,7 +778,8 @@ 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
|
||||
|
@ -724,11 +787,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
|
||||
|
||||
|
@ -793,11 +858,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
|
||||
|
||||
|
@ -825,8 +895,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
|
||||
|
||||
|
@ -845,11 +918,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
|
||||
|
||||
|
@ -876,6 +954,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
|
||||
|
@ -920,7 +1004,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.
|
||||
|
@ -929,7 +1015,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
|
||||
|
||||
|
@ -1017,6 +1105,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})
|
||||
|
@ -1043,6 +1132,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.
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue