aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2001-04-25 05:57:08 +0000
committerEli Zaretskii2001-04-25 05:57:08 +0000
commita8575fe53124527ec1284d3da52463c65d7b0a36 (patch)
tree534423c5b6bbd90764f29a645e6b77e4c34c6ac6
parent2e88b53c21d9f860609db533e9b367138b1c7733 (diff)
downloademacs-a8575fe53124527ec1284d3da52463c65d7b0a36.tar.gz
emacs-a8575fe53124527ec1284d3da52463c65d7b0a36.zip
Add @opindex entries to index all command-line options.
-rw-r--r--man/cmdargs.texi117
1 files changed, 104 insertions, 13 deletions
diff --git a/man/cmdargs.texi b/man/cmdargs.texi
index e2f4ac014a9..7a4ef3cca04 100644
--- a/man/cmdargs.texi
+++ b/man/cmdargs.texi
@@ -77,35 +77,51 @@ the action arguments in the order they are written.
77 77
78@table @samp 78@table @samp
79@item @var{file} 79@item @var{file}
80@opindex --visit
80@itemx --visit=@var{file} 81@itemx --visit=@var{file}
82@opindex --file
81@itemx --file=@var{file} 83@itemx --file=@var{file}
84@cindex visiting files, command-line argument
82Visit @var{file} using @code{find-file}. @xref{Visiting}. 85Visit @var{file} using @code{find-file}. @xref{Visiting}.
83 86
84@item +@var{linenum} @var{file} 87@item +@var{linenum} @var{file}
88@opindex +@var{linenum}
85Visit @var{file} using @code{find-file}, then go to line number 89Visit @var{file} using @code{find-file}, then go to line number
86@var{linenum} in it. 90@var{linenum} in it.
87 91
88@need 3000 92@need 3000
89@item -l @var{file} 93@item -l @var{file}
94@opindex -l
90@itemx --load=@var{file} 95@itemx --load=@var{file}
96@opindex --load
97@cindex loading Lisp libraries, command-line argument
91Load a Lisp library named @var{file} with the function @code{load}. 98Load a Lisp library named @var{file} with the function @code{load}.
92@xref{Lisp Libraries}. The library can be found either in the current 99@xref{Lisp Libraries}. The library can be found either in the current
93directory, or in the Emacs library search path as specified 100directory, or in the Emacs library search path as specified
94with @env{EMACSLOADPATH} (@pxref{General Variables}). 101with @env{EMACSLOADPATH} (@pxref{General Variables}).
95 102
96@item -f @var{function} 103@item -f @var{function}
104@opindex -f
97@itemx --funcall=@var{function} 105@itemx --funcall=@var{function}
106@opindex --funcall
107@cindex call Lisp functions, command-line argument
98Call Lisp function @var{function} with no arguments. 108Call Lisp function @var{function} with no arguments.
99 109
100@item --eval=@var{expression} 110@item --eval=@var{expression}
111@opindex --eval
101@itemx --execute=@var{expression} 112@itemx --execute=@var{expression}
113@opindex --execute
114@cindex evaluate expression, command-line argument
102Evaluate Lisp expression @var{expression}. 115Evaluate Lisp expression @var{expression}.
103 116
104@item --insert=@var{file} 117@item --insert=@var{file}
118@opindex --insert
119@cindex insert file contents, command-line argument
105Insert the contents of @var{file} into the current buffer. This is like 120Insert the contents of @var{file} into the current buffer. This is like
106what @kbd{M-x insert-file} does. @xref{Misc File Ops}. 121what @kbd{M-x insert-file} does. @xref{Misc File Ops}.
107 122
108@item --kill 123@item --kill
124@opindex --kill
109Exit from Emacs without asking for confirmation. 125Exit from Emacs without asking for confirmation.
110@end table 126@end table
111 127
@@ -131,16 +147,25 @@ of these files or substitute other files for them.
131 147
132@table @samp 148@table @samp
133@item -t @var{device} 149@item -t @var{device}
150@opindex -t
134@itemx --terminal=@var{device} 151@itemx --terminal=@var{device}
152@opindex --terminal
153@cindex device for Emacs terminal I/O
135Use @var{device} as the device for terminal input and output. 154Use @var{device} as the device for terminal input and output.
136 155
137@item -d @var{display} 156@item -d @var{display}
157@opindex -d
138@itemx --display=@var{display} 158@itemx --display=@var{display}
159@opindex --display
160@cindex display for Emacs frame
139Use the X Window System and use the display named @var{display} to open 161Use the X Window System and use the display named @var{display} to open
140the initial Emacs frame. 162the initial Emacs frame. @xref{Display X}, for more details.
141 163
142@item -nw 164@item -nw
165@opindex -nw
143@itemx --no-windows 166@itemx --no-windows
167@opindex --no-windows
168@cindex disable window system
144Don't communicate directly with the window system, disregarding the 169Don't communicate directly with the window system, disregarding the
145@env{DISPLAY} environment variable even if it is set. This forces Emacs 170@env{DISPLAY} environment variable even if it is set. This forces Emacs
146to run as if the display were a text-only terminal. 171to 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.
148@need 3000 173@need 3000
149@cindex batch mode 174@cindex batch mode
150@item -batch 175@item -batch
176@opindex --batch
151@itemx --batch 177@itemx --batch
152Run Emacs in @dfn{batch mode}, which means that the text being edited is 178Run Emacs in @dfn{batch mode}, which means that the text being edited is
153not displayed and the standard terminal interrupt characters such as 179not 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
167explicitly requested. 193explicitly requested.
168 194
169@item -q 195@item -q
196@opindex -q
170@itemx --no-init-file 197@itemx --no-init-file
198@opindex --no-init-file
199@cindex bypassing init and site-start file
200@cindex init file, not loading
171Do not load your Emacs init file @file{~/.emacs}, or @file{default.el} 201Do not load your Emacs init file @file{~/.emacs}, or @file{default.el}
172either. 202either.
173 203
174@item --no-site-file 204@item --no-site-file
205@opindex --no-site-file
206@cindex site-start file, not loading
175Do not load @file{site-start.el}. The options @samp{-q}, @samp{-u} 207Do not load @file{site-start.el}. The options @samp{-q}, @samp{-u}
176and @samp{-batch} have no effect on the loading of this file---this is 208and @samp{-batch} have no effect on the loading of this file---this is
177the only option that blocks it. 209the only option that blocks it.
178 210
179@item -u @var{user} 211@item -u @var{user}
212@opindex -u
180@itemx --user=@var{user} 213@itemx --user=@var{user}
214@opindex --user
215@cindex load init file of another user
181Load @var{user}'s Emacs init file @file{~@var{user}/.emacs} instead of 216Load @var{user}'s Emacs init file @file{~@var{user}/.emacs} instead of
182your own. 217your own.
183 218
184@item --debug-init 219@item --debug-init
220@opindex --debug-init
221@cindex errors in init file
185Enable the Emacs Lisp debugger for errors in the init file. 222Enable the Emacs Lisp debugger for errors in the init file.
186 223
187@item --unibyte 224@item --unibyte
225@opindex --unibyte
188@cindex unibyte operation, command-line argument 226@cindex unibyte operation, command-line argument
189Set up to do almost everything with single-byte buffers and strings. 227Set up to do almost everything with single-byte buffers and strings.
190All buffers and strings are unibyte unless you (or a Lisp program) 228All buffers and strings are unibyte unless you (or a Lisp program)
@@ -194,6 +232,7 @@ specified; see @ref{Enabling Multibyte}.) Setting the environment
194variable @env{EMACS_UNIBYTE} has the same effect. 232variable @env{EMACS_UNIBYTE} has the same effect.
195 233
196@item --multibyte 234@item --multibyte
235@opindex --multibyte
197Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs 236Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs
198uses multibyte characters by default, as usual. 237uses multibyte characters by default, as usual.
199@end table 238@end table
@@ -559,7 +598,10 @@ specify a different font on your command line through the option
559 598
560@table @samp 599@table @samp
561@item -fn @var{name} 600@item -fn @var{name}
601@opindex -fn
562@itemx --font=@var{name} 602@itemx --font=@var{name}
603@opindex --font
604@cindex specify default font from the command line
563Use font @var{name} as the default font. 605Use font @var{name} as the default font.
564@end table 606@end table
565 607
@@ -631,6 +673,7 @@ This is the character set that the font depicts.
631Normally you should use @samp{iso8859-1}. 673Normally you should use @samp{iso8859-1}.
632@end table 674@end table
633 675
676@cindex listing system fonts
634 You will probably want to use a fixed-width default font---that is, 677 You will probably want to use a fixed-width default font---that is,
635a font in which all characters have the same width. Any font with 678a font in which all characters have the same width. Any font with
636@samp{m} or @samp{c} in the @var{spacing} field of the long name is a 679@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}.
660 703
661@node Colors X 704@node Colors X
662@appendixsec Window Color Options 705@appendixsec Window Color Options
663@cindex color of window (X Window System) 706@cindex color of window
664@cindex text colors, from command line 707@cindex text colors, from command line
665 708
666@findex list-colors-display 709@findex list-colors-display
@@ -678,26 +721,45 @@ background is usually black and the foreground is white.
678 Here is a list of the command-line options for specifying colors: 721 Here is a list of the command-line options for specifying colors:
679 722
680@table @samp 723@table @samp
681@item -fg @var{color} 724@item -fg @var{color}
682@itemx --foreground-color=@var{color} 725@opindex -fg
726@itemx --foreground-color=@var{color}
727@opindex --foreground-color
728@cindex foreground color, command-line argument
683Specify the foreground color. @var{color} should be a standard color 729Specify the foreground color. @var{color} should be a standard color
684name, or a numeric specification of the color's red, green, and blue 730name, or a numeric specification of the color's red, green, and blue
685components as in @samp{#4682B4} or @samp{RGB:46/82/B4}. 731components as in @samp{#4682B4} or @samp{RGB:46/82/B4}.
686@item -bg @var{color} 732@item -bg @var{color}
687@itemx --background-color=@var{color} 733@opindex -bg
734@itemx --background-color=@var{color}
735@opindex --background-color
736@cindex background color, command-line argument
688Specify the background color. 737Specify the background color.
689@item -bd @var{color} 738@item -bd @var{color}
690@itemx --border-color=@var{color} 739@opindex -bd
740@itemx --border-color=@var{color}
741@opindex --border-color
742@cindex border color, command-line argument
691Specify the color of the border of the X window. 743Specify the color of the border of the X window.
692@item -cr @var{color} 744@item -cr @var{color}
693@itemx --cursor-color=@var{color} 745@opindex -cr
746@itemx --cursor-color=@var{color}
747@opindex --cursor-color
748@cindex cursor color, command-line argument
694Specify the color of the Emacs cursor which indicates where point is. 749Specify the color of the Emacs cursor which indicates where point is.
695@item -ms @var{color} 750@item -ms @var{color}
696@itemx --mouse-color=@var{color} 751@opindex -ms
752@itemx --mouse-color=@var{color}
753@opindex --mouse-color
754@cindex mouse pointer color, command-line argument
697Specify the color for the mouse cursor when the mouse is in the Emacs window. 755Specify the color for the mouse cursor when the mouse is in the Emacs window.
698@item -r 756@item -r
757@opindex -r
699@itemx -rv 758@itemx -rv
759@opindex -rv
700@itemx --reverse-video 760@itemx --reverse-video
761@opindex --reverse-video
762@cindex reverse video, command-line argument
701Reverse video---swap the foreground and background colors. 763Reverse video---swap the foreground and background colors.
702@end table 764@end table
703 765
@@ -716,7 +778,8 @@ text-only terminals as well as on window systems.
716 778
717@node Window Size X 779@node Window Size X
718@appendixsec Options for Window Geometry 780@appendixsec Options for Window Geometry
719@cindex geometry (X Window System) 781@cindex geometry of Emacs window
782@cindex position and size of Emacs frame
720 783
721 The @samp{-geometry} option controls the size and position of the 784 The @samp{-geometry} option controls the size and position of the
722initial Emacs frame. Here is the format for specifying the window 785initial Emacs frame. Here is the format for specifying the window
@@ -724,11 +787,13 @@ geometry:
724 787
725@table @samp 788@table @samp
726@item -g @var{width}x@var{height}@r{@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset} 789@item -g @var{width}x@var{height}@r{@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}
790@opindex -g
727Specify window size @var{width} and @var{height} (measured in character 791Specify window size @var{width} and @var{height} (measured in character
728columns and lines), and positions @var{xoffset} and @var{yoffset} 792columns and lines), and positions @var{xoffset} and @var{yoffset}
729(measured in pixels). 793(measured in pixels).
730 794
731@item --geometry=@var{width}x@var{height}@r{@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset} 795@item --geometry=@var{width}x@var{height}@r{@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}
796@opindex --geometry
732This is another way of writing the same thing. 797This is another way of writing the same thing.
733@end table 798@end table
734 799
@@ -793,11 +858,16 @@ the window.
793 858
794@table @samp 859@table @samp
795@item -ib @var{width} 860@item -ib @var{width}
861@opindex -ib
796@itemx --internal-border=@var{width} 862@itemx --internal-border=@var{width}
863@opindex --internal-border
864@cindex border width, command-line argument
797Specify @var{width} as the width of the internal border, in pixels. 865Specify @var{width} as the width of the internal border, in pixels.
798 866
799@item -bw @var{width} 867@item -bw @var{width}
868@opindex -bw
800@itemx --border-width=@var{width} 869@itemx --border-width=@var{width}
870@opindex --border-width
801Specify @var{width} as the width of the main border, in pixels. 871Specify @var{width} as the width of the main border, in pixels.
802@end table 872@end table
803 873
@@ -825,8 +895,11 @@ line option:
825 895
826@table @samp 896@table @samp
827@item -title @var{title} 897@item -title @var{title}
898@opindex --title
828@itemx --title=@var{title} 899@itemx --title=@var{title}
829@itemx -T @var{title} 900@itemx -T @var{title}
901@opindex -T
902@cindex frame title, command-line argument
830Specify @var{title} as the title for the initial Emacs frame. 903Specify @var{title} as the title for the initial Emacs frame.
831@end table 904@end table
832 905
@@ -845,11 +918,16 @@ the screen by iconifying most of the clients.
845 918
846@table @samp 919@table @samp
847@item -i 920@item -i
921@opindex -i
848@itemx --icon-type 922@itemx --icon-type
923@opindex --icon-type
924@cindex Emacs icon, a gnu
849Use a picture of a gnu as the Emacs icon. 925Use a picture of a gnu as the Emacs icon.
850 926
851@item -iconic 927@item -iconic
928@opindex --iconic
852@itemx --iconic 929@itemx --iconic
930@cindex start iconified, command-line argument
853Start Emacs in iconified state. 931Start Emacs in iconified state.
854@end table 932@end table
855 933
@@ -876,6 +954,12 @@ values for these options in your X resources file, usually named
876collection of related options, for one program or for several programs 954collection of related options, for one program or for several programs
877(optionally even for all programs). 955(optionally even for all programs).
878 956
957@cindex Registry (MS-Windows)
958 MS-Windows systems don't support @file{~/.Xdefaults} files, but
959Emacs compiled for Windows looks for X resources in the Windows
960Registry, under the keys @samp{HKEY_CURRENT_USER\SOFTWARE\GNU\Emacs}
961and @samp{HKEY_LOCAL_MACHINE\SOFTWARE\GNU\Emacs}.
962
879 Programs define named resources with particular meanings. They also 963 Programs define named resources with particular meanings. They also
880define how to group resources into named classes. For instance, in 964define how to group resources into named classes. For instance, in
881Emacs, the @samp{internalBorder} resource controls the width of the 965Emacs, the @samp{internalBorder} resource controls the width of the
@@ -920,7 +1004,9 @@ looks for resources under that name instead of @samp{emacs}.
920 1004
921@table @samp 1005@table @samp
922@item -name @var{name} 1006@item -name @var{name}
1007@opindex --name
923@itemx --name=@var{name} 1008@itemx --name=@var{name}
1009@cindex resource name, command-line argument
924Use @var{name} as the resource name (and the title) for the initial 1010Use @var{name} as the resource name (and the title) for the initial
925Emacs frame. This option does not affect subsequent frames, but Lisp 1011Emacs frame. This option does not affect subsequent frames, but Lisp
926programs can specify frame names when they create frames. 1012programs 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
929executable's name as the resource name. 1015executable's name as the resource name.
930 1016
931@item -xrm @var{resource-values} 1017@item -xrm @var{resource-values}
1018@opindex --xrm
932@itemx --xrm=@var{resource-values} 1019@itemx --xrm=@var{resource-values}
1020@cindex resource values, command-line argument
933Specify X resource values for this Emacs job (see below). 1021Specify X resource values for this Emacs job (see below).
934@end table 1022@end table
935 1023
@@ -1017,6 +1105,7 @@ If @samp{none}, don't make a minibuffer in this frame.
1017It will use a separate minibuffer frame instead. 1105It will use a separate minibuffer frame instead.
1018 1106
1019@item @code{paneFont} (class @code{Font}) 1107@item @code{paneFont} (class @code{Font})
1108@cindex font for menus
1020Font name for menu pane titles, in non-toolkit versions of Emacs. 1109Font name for menu pane titles, in non-toolkit versions of Emacs.
1021 1110
1022@item @code{pointerColor} (class @code{Foreground}) 1111@item @code{pointerColor} (class @code{Foreground})
@@ -1043,6 +1132,8 @@ toolkit versions, see @ref{Lucid Resources}, also see @ref{LessTif
1043Resources}.) 1132Resources}.)
1044 1133
1045@item @code{synchronous} (class @code{Synchronous}) 1134@item @code{synchronous} (class @code{Synchronous})
1135@cindex debugging X problems
1136@cindex synchronous X mode
1046Run Emacs in synchronous mode if @samp{on}. Synchronous mode is 1137Run Emacs in synchronous mode if @samp{on}. Synchronous mode is
1047useful for debugging X problems. 1138useful for debugging X problems.
1048 1139