aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2004-02-21 13:16:02 +0000
committerEli Zaretskii2004-02-21 13:16:02 +0000
commitb77b6b5c6ebff2717f70eda0344f6b064c51d61d (patch)
treee19625d1ea1e10f23b60567c619e52628159b58e
parent8bc5e4c131dba618a458f481a5fcbff60f252228 (diff)
downloademacs-b77b6b5c6ebff2717f70eda0344f6b064c51d61d.tar.gz
emacs-b77b6b5c6ebff2717f70eda0344f6b064c51d61d.zip
(Action Arguments): Add alias --find-file. Add
--directory, --help, --version. Move text about command-line-args to Command Arguments. (Initial Options): Remove alias -batch. Add @cindex for --script. Fix @cindex for -q. Add --no-desktop. Add alias --no-multibyte, --no-unibyte. (Window Size X): Join -g and --geometry. Add @cindex. (Borders X): Fix @cindex for -ib. Add @cindex for -bw. (Title X): Remove alias -title. (Icons X): Remove alias -iconic. (Misc X): New node.
-rw-r--r--man/ChangeLog14
-rw-r--r--man/cmdargs.texi119
2 files changed, 102 insertions, 31 deletions
diff --git a/man/ChangeLog b/man/ChangeLog
index 02c2aed55a9..41740d2dae0 100644
--- a/man/ChangeLog
+++ b/man/ChangeLog
@@ -1,3 +1,17 @@
12004-02-08 Juri Linkov <juri@jurta.org>
2
3 * cmdargs.texi (Action Arguments): Add alias --find-file. Add
4 --directory, --help, --version. Move text about command-line-args
5 to Command Arguments.
6 (Initial Options): Remove alias -batch. Add @cindex for --script.
7 Fix @cindex for -q. Add --no-desktop. Add alias --no-multibyte,
8 --no-unibyte.
9 (Window Size X): Join -g and --geometry. Add @cindex.
10 (Borders X): Fix @cindex for -ib. Add @cindex for -bw.
11 (Title X): Remove alias -title.
12 (Icons X): Remove alias -iconic.
13 (Misc X): New node.
14
12004-02-15 Jan Dj,Ad(Brv <jan.h.d@swipnet.se> 152004-02-15 Jan Dj,Ad(Brv <jan.h.d@swipnet.se>
2 16
3 * frames.texi (Drag and drop): Add Motif to list of supported 17 * frames.texi (Drag and drop): Add Motif to list of supported
diff --git a/man/cmdargs.texi b/man/cmdargs.texi
index b273fb15bf9..3daf96f0d00 100644
--- a/man/cmdargs.texi
+++ b/man/cmdargs.texi
@@ -1,5 +1,5 @@
1@c This is part of the Emacs manual. 1@c This is part of the Emacs manual.
2@c Copyright (C) 1985,86,87,93,94,95,1997,2001, 2003 Free Software Foundation, Inc. 2@c Copyright (C) 1985,86,87,93,94,95,97,2001,03,2004 Free Software Foundation, Inc.
3@c See file emacs.texi for copying conditions. 3@c See file emacs.texi for copying conditions.
4@node Command Arguments, X Resources, Service, Top 4@node Command Arguments, X Resources, Service, Top
5@appendix Command Line Arguments 5@appendix Command Line Arguments
@@ -46,27 +46,33 @@ and the tables below always show an equal sign.
46 46
47@cindex initial options (command line) 47@cindex initial options (command line)
48@cindex action options (command line) 48@cindex action options (command line)
49@vindex command-line-args
49 Most options specify how to initialize Emacs, or set parameters for 50 Most options specify how to initialize Emacs, or set parameters for
50the Emacs session. We call them @dfn{initial options}. A few options 51the Emacs session. We call them @dfn{initial options}. A few options
51specify things to do: for example, load libraries, call functions, or 52specify things to do: for example, load libraries, call functions, or
52terminate Emacs. These are called @dfn{action options}. These and file 53terminate Emacs. These are called @dfn{action options}. These and file
53names together are called @dfn{action arguments}. Emacs processes all 54names together are called @dfn{action arguments}. Emacs processes all
54the action arguments in the order they are written. 55the action arguments in the order they are written. The @file{.emacs} file
56can access the values of the action arguments as the elements of a list in
57the variable @code{command-line-args}.
58
59
55 60
56@menu 61@menu
57* Action Arguments:: Arguments to visit files, load libraries, 62* Action Arguments:: Arguments to visit files, load libraries,
58 and call functions. 63 and call functions.
59* Initial Options:: Arguments that take effect while starting Emacs. 64* Initial Options:: Arguments that take effect while starting Emacs.
60* Command Example:: Examples of using command line arguments. 65* Command Example:: Examples of using command line arguments.
61* Resume Arguments:: Specifying arguments when you resume a running Emacs. 66* Resume Arguments:: Specifying arguments when you resume a running Emacs.
62* Environment:: Environment variables that Emacs uses. 67* Environment:: Environment variables that Emacs uses.
63* Display X:: Changing the default display and using remote login. 68* Display X:: Changing the default display and using remote login.
64* Font X:: Choosing a font for text, under X. 69* Font X:: Choosing a font for text, under X.
65* Colors:: Choosing display colors. 70* Colors:: Choosing display colors.
66* Window Size X:: Start-up window size, under X. 71* Window Size X:: Start-up window size, under X.
67* Borders X:: Internal and external borders, under X. 72* Borders X:: Internal and external borders, under X.
68* Title X:: Specifying the initial frame's title. 73* Title X:: Specifying the initial frame's title.
69* Icons X:: Choosing what sort of icon to use, under X. 74* Icons X:: Choosing what sort of icon to use, under X.
75* Misc X:: Other display options.
70@end menu 76@end menu
71 77
72@node Action Arguments 78@node Action Arguments
@@ -76,10 +82,12 @@ the action arguments in the order they are written.
76 82
77@table @samp 83@table @samp
78@item @var{file} 84@item @var{file}
79@opindex --visit
80@itemx --visit=@var{file}
81@opindex --file 85@opindex --file
82@itemx --file=@var{file} 86@itemx --file=@var{file}
87@opindex --find-file
88@itemx --find-file=@var{file}
89@opindex --visit
90@itemx --visit=@var{file}
83@cindex visiting files, command-line argument 91@cindex visiting files, command-line argument
84@vindex inhibit-startup-buffer-menu 92@vindex inhibit-startup-buffer-menu
85Visit @var{file} using @code{find-file}. @xref{Visiting}. 93Visit @var{file} using @code{find-file}. @xref{Visiting}.
@@ -107,6 +115,12 @@ Load a Lisp library named @var{file} with the function @code{load}.
107directory, or in the Emacs library search path as specified 115directory, or in the Emacs library search path as specified
108with @env{EMACSLOADPATH} (@pxref{General Variables}). 116with @env{EMACSLOADPATH} (@pxref{General Variables}).
109 117
118@item -L @var{dir}
119@opindex -L
120@itemx --directory=@var{dir}
121@opindex --directory
122Add directory @var{dir} to the variable @code{load-path}.
123
110@item -f @var{function} 124@item -f @var{function}
111@opindex -f 125@opindex -f
112@itemx --funcall=@var{function} 126@itemx --funcall=@var{function}
@@ -133,13 +147,16 @@ what @kbd{M-x insert-file} does. @xref{Misc File Ops}.
133@item --kill 147@item --kill
134@opindex --kill 148@opindex --kill
135Exit from Emacs without asking for confirmation. 149Exit from Emacs without asking for confirmation.
136@end table
137 150
138@vindex command-line-args 151@item --help
139 The init file can access the values of the action arguments as the 152@opindex --help
140elements of a list in the variable @code{command-line-args}. The init 153Print a usage message listing all available options, then exit
141file can override the normal processing of the action arguments, or 154successfully.
142define new ones, by reading and setting this variable. 155
156@item --version
157@opindex --version
158Print Emacs version, then exit successfully.
159@end table
143 160
144@node Initial Options 161@node Initial Options
145@appendixsec Initial Options 162@appendixsec Initial Options
@@ -162,6 +179,7 @@ of these files or substitute other files for them.
162@opindex --terminal 179@opindex --terminal
163@cindex device for Emacs terminal I/O 180@cindex device for Emacs terminal I/O
164Use @var{device} as the device for terminal input and output. 181Use @var{device} as the device for terminal input and output.
182@samp{--terminal} implies @samp{--no-window-system}.
165 183
166@item -d @var{display} 184@item -d @var{display}
167@opindex -d 185@opindex -d
@@ -205,6 +223,7 @@ been explicitly requested.
205 223
206@item --script @var{file} 224@item --script @var{file}
207@opindex --script 225@opindex --script
226@cindex script mode
208Run Emacs in batch mode, like @samp{--batch}, and then read and 227Run Emacs in batch mode, like @samp{--batch}, and then read and
209execute the Lisp code in @var{file}. 228execute the Lisp code in @var{file}.
210 229
@@ -224,11 +243,12 @@ comment delimiter.
224@opindex -q 243@opindex -q
225@itemx --no-init-file 244@itemx --no-init-file
226@opindex --no-init-file 245@opindex --no-init-file
227@cindex bypassing init and site-start file 246@cindex bypassing init and @file{default.el} file
228@cindex init file, not loading 247@cindex init file, not loading
229@cindex @file{default.el} file, not loading 248@cindex @file{default.el} file, not loading
230Do not load your Emacs init file @file{~/.emacs}, or @file{default.el} 249Do not load your Emacs init file @file{~/.emacs}, or @file{default.el}
231either. When invoked like this, Emacs does not allow saving options 250either. Regardless of this switch, @file{site-start.el} is still loaded.
251When invoked like this, Emacs does not allow saving options
232changed with the @kbd{M-x customize} command and its variants. 252changed with the @kbd{M-x customize} command and its variants.
233@xref{Easy Customization}. 253@xref{Easy Customization}.
234 254
@@ -236,7 +256,7 @@ changed with the @kbd{M-x customize} command and its variants.
236@opindex --no-site-file 256@opindex --no-site-file
237@cindex @file{site-start.el} file, not loading 257@cindex @file{site-start.el} file, not loading
238Do not load @file{site-start.el}. The options @samp{-q}, @samp{-u} 258Do not load @file{site-start.el}. The options @samp{-q}, @samp{-u}
239and @samp{-batch} have no effect on the loading of this file---this is 259and @samp{--batch} have no effect on the loading of this file---this is
240the only option that blocks it. 260the only option that blocks it.
241 261
242@item --no-splash 262@item --no-splash
@@ -245,6 +265,10 @@ the only option that blocks it.
245Do not display a splash screen on startup; this is equivalent to 265Do not display a splash screen on startup; this is equivalent to
246setting the variable @code{inhibit-startup-message} to non-@code{nil}. 266setting the variable @code{inhibit-startup-message} to non-@code{nil}.
247 267
268@item --no-desktop
269@opindex --no-desktop
270Do not reload any saved desktop. @xref{Saving Emacs Sessions}.
271
248@item -u @var{user} 272@item -u @var{user}
249@opindex -u 273@opindex -u
250@itemx --user=@var{user} 274@itemx --user=@var{user}
@@ -260,6 +284,8 @@ Enable the Emacs Lisp debugger for errors in the init file.
260 284
261@item --unibyte 285@item --unibyte
262@opindex --unibyte 286@opindex --unibyte
287@itemx --no-multibyte
288@opindex --no-multibyte
263@cindex unibyte operation, command-line argument 289@cindex unibyte operation, command-line argument
264Do almost everything with single-byte buffers and strings. 290Do almost everything with single-byte buffers and strings.
265All buffers and strings are unibyte unless you (or a Lisp program) 291All buffers and strings are unibyte unless you (or a Lisp program)
@@ -270,6 +296,8 @@ variable @env{EMACS_UNIBYTE} has the same effect.
270 296
271@item --multibyte 297@item --multibyte
272@opindex --multibyte 298@opindex --multibyte
299@itemx --no-unibyte
300@opindex --no-unibyte
273Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs 301Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs
274uses multibyte characters by default, as usual. 302uses multibyte characters by default, as usual.
275@end table 303@end table
@@ -290,7 +318,7 @@ emacs -batch foo.c -l hack-c -f save-buffer >& log
290This says to visit @file{foo.c}, load @file{hack-c.el} (which makes 318This says to visit @file{foo.c}, load @file{hack-c.el} (which makes
291changes in the visited file), save @file{foo.c} (note that 319changes in the visited file), save @file{foo.c} (note that
292@code{save-buffer} is the function that @kbd{C-x C-s} is bound to), and 320@code{save-buffer} is the function that @kbd{C-x C-s} is bound to), and
293then exit back to the shell (because of @samp{-batch}). @samp{-batch} 321then exit back to the shell (because of @samp{--batch}). @samp{--batch}
294also guarantees there will be no problem redirecting output to 322also guarantees there will be no problem redirecting output to
295@file{log}, because Emacs will not assume that it has a display terminal 323@file{log}, because Emacs will not assume that it has a display terminal
296to work with. 324to work with.
@@ -944,14 +972,13 @@ position of the initial Emacs frame:
944@table @samp 972@table @samp
945@item -g @var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]} 973@item -g @var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]}
946@opindex -g 974@opindex -g
975@itemx --geometry=@var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]}
976@opindex --geometry
977@cindex geometry, command-line argument
947Specify the size @var{width} and @var{height} (measured in character 978Specify the size @var{width} and @var{height} (measured in character
948columns and lines), and positions @var{xoffset} and @var{yoffset} 979columns and lines), and positions @var{xoffset} and @var{yoffset}
949(measured in pixels). This applies to all frames. 980(measured in pixels). This applies to all frames.
950 981
951@item --geometry=@var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]}
952@opindex --geometry
953This is another way of writing the same thing.
954
955@item -fs 982@item -fs
956@opindex -fs 983@opindex -fs
957@itemx --fullscreen 984@itemx --fullscreen
@@ -1029,7 +1056,7 @@ specification assuming there is a tool bar, and then your
1029@file{~/.emacs} file disables the tool bar, you will end up with a 1056@file{~/.emacs} file disables the tool bar, you will end up with a
1030frame geometry different from what you asked for. To get the intended 1057frame geometry different from what you asked for. To get the intended
1031size with no tool bar, use an X resource to specify ``no tool bar'' 1058size with no tool bar, use an X resource to specify ``no tool bar''
1032(@pxref{Table of Resources});then Emacs will already know there's no 1059(@pxref{Table of Resources}); then Emacs will already know there's no
1033tool bar when it processes the specified geometry. 1060tool bar when it processes the specified geometry.
1034 1061
1035 When using one of @samp{--fullscreen}, @samp{--fullwidth} or 1062 When using one of @samp{--fullscreen}, @samp{--fullwidth} or
@@ -1057,13 +1084,15 @@ you can click on to move or iconify the window.
1057@opindex -ib 1084@opindex -ib
1058@itemx --internal-border=@var{width} 1085@itemx --internal-border=@var{width}
1059@opindex --internal-border 1086@opindex --internal-border
1060@cindex border width, command-line argument 1087@cindex internal border width, command-line argument
1061Specify @var{width} as the width of the internal border, in pixels. 1088Specify @var{width} as the width of the internal border (between the text
1089and the main border), in pixels.
1062 1090
1063@item -bw @var{width} 1091@item -bw @var{width}
1064@opindex -bw 1092@opindex -bw
1065@itemx --border-width=@var{width} 1093@itemx --border-width=@var{width}
1066@opindex --border-width 1094@opindex --border-width
1095@cindex main border width, command-line argument
1067Specify @var{width} as the width of the main border, in pixels. 1096Specify @var{width} as the width of the main border, in pixels.
1068@end table 1097@end table
1069 1098
@@ -1091,11 +1120,10 @@ there is more than one frame).
1091line option: 1120line option:
1092 1121
1093@table @samp 1122@table @samp
1094@item -title @var{title} 1123@item -T @var{title}
1095@opindex --title
1096@itemx --title=@var{title}
1097@itemx -T @var{title}
1098@opindex -T 1124@opindex -T
1125@itemx --title=@var{title}
1126@opindex --title
1099@cindex frame title, command-line argument 1127@cindex frame title, command-line argument
1100Specify @var{title} as the title for the initial Emacs frame. 1128Specify @var{title} as the title for the initial Emacs frame.
1101@end table 1129@end table
@@ -1138,6 +1166,35 @@ rather than showing a frame right away. In this situation, the icon
1138is the only indication that Emacs has started; the text frame doesn't 1166is the only indication that Emacs has started; the text frame doesn't
1139appear until you deiconify it. 1167appear until you deiconify it.
1140 1168
1169@node Misc X
1170@appendixsec Other Display Options
1171
1172@table @samp
1173@item -hb
1174@opindex -hb
1175@itemx --horizontal-scroll-bars
1176@opindex --horizontal-scroll-bars
1177@cindex horizontal scroll bars, command-line argument
1178Enable horizontal scroll bars.
1179
1180@item -vb
1181@opindex -vb
1182@itemx --vertical-scroll-bars
1183@opindex --vertical-scroll-bars
1184@cindex vertical scroll bars, command-line argument
1185Enable vertical scroll bars.
1186
1187@item -lsp @var{pixels}
1188@opindex -lsp
1189@itemx --line-spacing=@var{pixels}
1190@opindex --line-spacing
1191@cindex line spacing, command-line argument
1192Specify @var{pixels} as additional space to put between lines, in pixels.
1193@end table
1194
1195 The @samp{--xrm} option (@pxref{Resources}) specifies additional
1196X resource values.
1197
1141@ignore 1198@ignore
1142 arch-tag: fffecd9e-7329-4a51-a3cc-dd4a9889340e 1199 arch-tag: fffecd9e-7329-4a51-a3cc-dd4a9889340e
1143@end ignore 1200@end ignore