Commit | Line | Data |
---|---|---|
6bf7aab6 | 1 | @c This is part of the Emacs manual. |
48a36003 LK |
2 | @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, |
3 | @c 2001, 03, 04, 2005 Free Software Foundation, Inc. | |
6bf7aab6 | 4 | @c See file emacs.texi for copying conditions. |
b4e112e7 RS |
5 | @node Emacs Invocation, X Resources, GNU Free Documentation License, Top |
6 | @appendix Command Line Arguments for Emacs Invocation | |
6bf7aab6 DL |
7 | @cindex command line arguments |
8 | @cindex arguments (command line) | |
9 | @cindex options (command line) | |
10 | @cindex switches (command line) | |
11 | @cindex startup (command line arguments) | |
2b4938c7 | 12 | @cindex invocation (command line arguments) |
6bf7aab6 DL |
13 | |
14 | GNU Emacs supports command line arguments to request various actions | |
15 | when invoking Emacs. These are for compatibility with other editors and | |
16 | for sophisticated activities. We don't recommend using them for | |
17 | ordinary editing. | |
18 | ||
e93b7ca6 | 19 | Arguments starting with @samp{-} are @dfn{options}, and so is |
d399c309 | 20 | @samp{+@var{linenum}}. All other arguments specify files to visit. |
e93b7ca6 RS |
21 | Emacs visits the specified files while it starts up. The last file |
22 | name on your command line becomes the current buffer; the other files | |
23 | are also visited in other buffers. If there are two files, they are | |
24 | both displayed; otherwise the last file is displayed along with a | |
25 | buffer list that shows what other buffers there are. As with most | |
26 | programs, the special argument @samp{--} says that all subsequent | |
27 | arguments are file names, not options, even if they start with | |
28 | @samp{-}. | |
6bf7aab6 DL |
29 | |
30 | Emacs command options can specify many things, such as the size and | |
31 | position of the X window Emacs uses, its colors, and so on. A few | |
32 | options support advanced usage, such as running Lisp functions on files | |
33 | in batch mode. The sections of this chapter describe the available | |
34 | options, arranged according to their purpose. | |
35 | ||
36 | There are two ways of writing options: the short forms that start with | |
37 | a single @samp{-}, and the long forms that start with @samp{--}. For | |
38 | example, @samp{-d} is a short form and @samp{--display} is the | |
39 | corresponding long form. | |
40 | ||
41 | The long forms with @samp{--} are easier to remember, but longer to | |
42 | type. However, you don't have to spell out the whole option name; any | |
43 | unambiguous abbreviation is enough. When a long option takes an | |
44 | argument, you can use either a space or an equal sign to separate the | |
45 | option name and the argument. Thus, you can write either | |
46 | @samp{--display sugar-bombs:0.0} or @samp{--display=sugar-bombs:0.0}. | |
47 | We recommend an equal sign because it makes the relationship clearer, | |
48 | and the tables below always show an equal sign. | |
49 | ||
50 | @cindex initial options (command line) | |
51 | @cindex action options (command line) | |
b77b6b5c | 52 | @vindex command-line-args |
6bf7aab6 DL |
53 | Most options specify how to initialize Emacs, or set parameters for |
54 | the Emacs session. We call them @dfn{initial options}. A few options | |
55 | specify things to do: for example, load libraries, call functions, or | |
0ec1f115 | 56 | terminate Emacs. These are called @dfn{action options}. These and file |
6bf7aab6 | 57 | names together are called @dfn{action arguments}. Emacs processes all |
b77b6b5c EZ |
58 | the action arguments in the order they are written. The @file{.emacs} file |
59 | can access the values of the action arguments as the elements of a list in | |
60 | the variable @code{command-line-args}. | |
61 | ||
62 | ||
6bf7aab6 DL |
63 | |
64 | @menu | |
b77b6b5c EZ |
65 | * Action Arguments:: Arguments to visit files, load libraries, |
66 | and call functions. | |
6bf7aab6 DL |
67 | * Initial Options:: Arguments that take effect while starting Emacs. |
68 | * Command Example:: Examples of using command line arguments. | |
b77b6b5c | 69 | * Resume Arguments:: Specifying arguments when you resume a running Emacs. |
6bf7aab6 | 70 | * Environment:: Environment variables that Emacs uses. |
e428626a | 71 | * Display X:: Changing the default display and using remote login. |
b77b6b5c EZ |
72 | * Font X:: Choosing a font for text, under X. |
73 | * Colors:: Choosing display colors. | |
e428626a | 74 | * Window Size X:: Start-up window size, under X. |
b77b6b5c | 75 | * Borders X:: Internal and external borders, under X. |
e428626a RS |
76 | * Title X:: Specifying the initial frame's title. |
77 | * Icons X:: Choosing what sort of icon to use, under X. | |
b77b6b5c | 78 | * Misc X:: Other display options. |
6bf7aab6 DL |
79 | @end menu |
80 | ||
81 | @node Action Arguments | |
82 | @appendixsec Action Arguments | |
83 | ||
84 | Here is a table of the action arguments and options: | |
85 | ||
86 | @table @samp | |
87 | @item @var{file} | |
a8575fe5 | 88 | @opindex --file |
ec22060b | 89 | @itemx --file=@var{file} |
b77b6b5c EZ |
90 | @opindex --find-file |
91 | @itemx --find-file=@var{file} | |
92 | @opindex --visit | |
93 | @itemx --visit=@var{file} | |
a8575fe5 | 94 | @cindex visiting files, command-line argument |
6da55907 | 95 | @vindex inhibit-startup-buffer-menu |
6bf7aab6 | 96 | Visit @var{file} using @code{find-file}. @xref{Visiting}. |
6da55907 RS |
97 | If you visit several files at startup in this way, Emacs |
98 | also displays a Buffer Menu buffer to show you what files it | |
99 | has visited. You can inhibit that by setting @code{inhibit-startup-buffer-menu} to @code{t}. | |
6bf7aab6 DL |
100 | |
101 | @item +@var{linenum} @var{file} | |
a8575fe5 | 102 | @opindex +@var{linenum} |
6bf7aab6 DL |
103 | Visit @var{file} using @code{find-file}, then go to line number |
104 | @var{linenum} in it. | |
105 | ||
660872b6 | 106 | @item +@var{linenum}:@var{columnnum} @var{file} |
660872b6 | 107 | Visit @var{file} using @code{find-file}, then go to line number |
0ec1f115 | 108 | @var{linenum} and put point at column number @var{columnnum}. |
660872b6 | 109 | |
6bf7aab6 DL |
110 | @need 3000 |
111 | @item -l @var{file} | |
a8575fe5 | 112 | @opindex -l |
6bf7aab6 | 113 | @itemx --load=@var{file} |
a8575fe5 EZ |
114 | @opindex --load |
115 | @cindex loading Lisp libraries, command-line argument | |
6bf7aab6 | 116 | Load a Lisp library named @var{file} with the function @code{load}. |
e93b7ca6 RS |
117 | @xref{Lisp Libraries}. If @var{file} is not an absolute file name, |
118 | the library can be found either in the current directory, or in the | |
119 | Emacs library search path as specified with @env{EMACSLOADPATH} | |
120 | (@pxref{General Variables}). | |
6bf7aab6 | 121 | |
227c36fb RS |
122 | @strong{Warning:} If previous command-line arguments have visited |
123 | files, the current directory is the directory of the last file | |
124 | visited. | |
125 | ||
b77b6b5c EZ |
126 | @item -L @var{dir} |
127 | @opindex -L | |
128 | @itemx --directory=@var{dir} | |
129 | @opindex --directory | |
130 | Add directory @var{dir} to the variable @code{load-path}. | |
131 | ||
6bf7aab6 | 132 | @item -f @var{function} |
a8575fe5 | 133 | @opindex -f |
6bf7aab6 | 134 | @itemx --funcall=@var{function} |
a8575fe5 EZ |
135 | @opindex --funcall |
136 | @cindex call Lisp functions, command-line argument | |
e2f140c8 RS |
137 | Call Lisp function @var{function}. If it is an interactive function |
138 | (a command), it reads the arguments interactively just as if you had | |
139 | called the same function with a key sequence. Otherwise, it calls the | |
140 | function with no arguments. | |
6bf7aab6 | 141 | |
ec22060b | 142 | @item --eval=@var{expression} |
a8575fe5 | 143 | @opindex --eval |
ec22060b | 144 | @itemx --execute=@var{expression} |
a8575fe5 EZ |
145 | @opindex --execute |
146 | @cindex evaluate expression, command-line argument | |
6bf7aab6 DL |
147 | Evaluate Lisp expression @var{expression}. |
148 | ||
149 | @item --insert=@var{file} | |
a8575fe5 EZ |
150 | @opindex --insert |
151 | @cindex insert file contents, command-line argument | |
6bf7aab6 DL |
152 | Insert the contents of @var{file} into the current buffer. This is like |
153 | what @kbd{M-x insert-file} does. @xref{Misc File Ops}. | |
154 | ||
155 | @item --kill | |
a8575fe5 | 156 | @opindex --kill |
6bf7aab6 | 157 | Exit from Emacs without asking for confirmation. |
6bf7aab6 | 158 | |
b77b6b5c EZ |
159 | @item --help |
160 | @opindex --help | |
161 | Print a usage message listing all available options, then exit | |
162 | successfully. | |
163 | ||
164 | @item --version | |
165 | @opindex --version | |
166 | Print Emacs version, then exit successfully. | |
167 | @end table | |
6bf7aab6 DL |
168 | |
169 | @node Initial Options | |
170 | @appendixsec Initial Options | |
171 | ||
172 | The initial options specify parameters for the Emacs session. This | |
173 | section describes the more general initial options; some other options | |
97878c08 EZ |
174 | specifically related to the X Window System appear in the following |
175 | sections. | |
6bf7aab6 DL |
176 | |
177 | Some initial options affect the loading of init files. The normal | |
178 | actions of Emacs are to first load @file{site-start.el} if it exists, | |
179 | then your own init file @file{~/.emacs} if it exists, and finally | |
56366094 LK |
180 | @file{default.el} if it exists. @xref{Init File}. Certain options |
181 | prevent loading of some of these files or substitute other files for | |
182 | them. | |
6bf7aab6 DL |
183 | |
184 | @table @samp | |
185 | @item -t @var{device} | |
a8575fe5 | 186 | @opindex -t |
6bf7aab6 | 187 | @itemx --terminal=@var{device} |
a8575fe5 EZ |
188 | @opindex --terminal |
189 | @cindex device for Emacs terminal I/O | |
6bf7aab6 | 190 | Use @var{device} as the device for terminal input and output. |
b77b6b5c | 191 | @samp{--terminal} implies @samp{--no-window-system}. |
6bf7aab6 DL |
192 | |
193 | @item -d @var{display} | |
a8575fe5 | 194 | @opindex -d |
6bf7aab6 | 195 | @itemx --display=@var{display} |
a8575fe5 EZ |
196 | @opindex --display |
197 | @cindex display for Emacs frame | |
6bf7aab6 | 198 | Use the X Window System and use the display named @var{display} to open |
a8575fe5 | 199 | the initial Emacs frame. @xref{Display X}, for more details. |
6bf7aab6 DL |
200 | |
201 | @item -nw | |
a8575fe5 | 202 | @opindex -nw |
011185fb PJ |
203 | @itemx --no-window-system |
204 | @opindex --no-window-system | |
a8575fe5 | 205 | @cindex disable window system |
54e33bb3 | 206 | Don't communicate directly with the window system, disregarding the |
17e9a80b RS |
207 | @env{DISPLAY} environment variable even if it is set. This means that |
208 | Emacs uses the terminal from which it was launched for all its display | |
209 | and input. | |
6bf7aab6 DL |
210 | |
211 | @need 3000 | |
212 | @cindex batch mode | |
213 | @item -batch | |
a8575fe5 | 214 | @opindex --batch |
6bf7aab6 | 215 | @itemx --batch |
4e4b7d76 RS |
216 | Run Emacs in @dfn{batch mode}. Batch mode is used for running |
217 | programs written in Emacs Lisp from shell scripts, makefiles, and so | |
218 | on. You should also use the @samp{-l} option or @samp{-f} option, to | |
219 | invoke a Lisp program to do batch processing. | |
220 | ||
221 | In batch mode, Emacs does not display the text being edited, and the | |
222 | standard terminal interrupt characters such as @kbd{C-z} and @kbd{C-c} | |
223 | continue to have their normal effect. The functions @code{prin1}, | |
224 | @code{princ} and @code{print} output to @code{stdout} instead of the | |
225 | echo area, while @code{message} and error messages output to | |
226 | @code{stderr}. Functions that would normally read from the minibuffer | |
227 | take their input from @code{stdin} instead. | |
6bf7aab6 | 228 | |
e93b7ca6 RS |
229 | @samp{--batch} implies @samp{-q} (do not load an init file), but |
230 | @file{site-start.el} is loaded nonetheless. It also causes Emacs to | |
231 | exit after processing all the command options. In addition, it | |
232 | disables auto-saving except in buffers for which it has been | |
233 | explicitly requested. | |
6bf7aab6 | 234 | |
0a41ca77 RS |
235 | @item --script @var{file} |
236 | @opindex --script | |
b77b6b5c | 237 | @cindex script mode |
0a41ca77 RS |
238 | Run Emacs in batch mode, like @samp{--batch}, and then read and |
239 | execute the Lisp code in @var{file}. | |
240 | ||
241 | The normal use of this option is in executable script files that run | |
242 | Emacs. They can start with this text on the first line | |
243 | ||
244 | @example | |
245 | #!/usr/bin/emacs --script | |
246 | @end example | |
247 | ||
248 | @noindent | |
249 | which will invoke Emacs with @samp{--script} and supply the name of | |
250 | the script file as @var{file}. Emacs Lisp then treats @samp{#!} as a | |
251 | comment delimiter. | |
252 | ||
6bf7aab6 | 253 | @item -q |
a8575fe5 | 254 | @opindex -q |
6bf7aab6 | 255 | @itemx --no-init-file |
a8575fe5 | 256 | @opindex --no-init-file |
b77b6b5c | 257 | @cindex bypassing init and @file{default.el} file |
a8575fe5 | 258 | @cindex init file, not loading |
3b703ce9 | 259 | @cindex @file{default.el} file, not loading |
6bf7aab6 | 260 | Do not load your Emacs init file @file{~/.emacs}, or @file{default.el} |
b77b6b5c EZ |
261 | either. Regardless of this switch, @file{site-start.el} is still loaded. |
262 | When invoked like this, Emacs does not allow saving options | |
00e50428 EZ |
263 | changed with the @kbd{M-x customize} command and its variants. |
264 | @xref{Easy Customization}. | |
6bf7aab6 DL |
265 | |
266 | @item --no-site-file | |
a8575fe5 | 267 | @opindex --no-site-file |
3b703ce9 | 268 | @cindex @file{site-start.el} file, not loading |
6bf7aab6 | 269 | Do not load @file{site-start.el}. The options @samp{-q}, @samp{-u} |
56366094 LK |
270 | and @samp{--batch} have no effect on the loading of this file---this |
271 | option and @samp{-Q} are the only options that block it. | |
6bf7aab6 | 272 | |
c6064be8 KS |
273 | @item -Q |
274 | @opindex -Q | |
5b99c91c RS |
275 | @itemx --quick |
276 | @opindex --quick | |
277 | Start emacs with minimum customizations. This is like using @samp{-q} | |
278 | and @samp{--no-site-file}, but also disables the startup screen. | |
c6064be8 | 279 | |
f6a9d2d8 CW |
280 | @item --no-splash |
281 | @opindex --no-splash | |
908abdfd | 282 | @vindex inhibit-startup-message |
6da55907 RS |
283 | Do not display a splash screen on startup; this is equivalent to |
284 | setting the variable @code{inhibit-startup-message} to non-@code{nil}. | |
908abdfd | 285 | |
b77b6b5c EZ |
286 | @item --no-desktop |
287 | @opindex --no-desktop | |
288 | Do not reload any saved desktop. @xref{Saving Emacs Sessions}. | |
289 | ||
6bf7aab6 | 290 | @item -u @var{user} |
a8575fe5 | 291 | @opindex -u |
6bf7aab6 | 292 | @itemx --user=@var{user} |
a8575fe5 EZ |
293 | @opindex --user |
294 | @cindex load init file of another user | |
6bf7aab6 DL |
295 | Load @var{user}'s Emacs init file @file{~@var{user}/.emacs} instead of |
296 | your own. | |
297 | ||
298 | @item --debug-init | |
a8575fe5 EZ |
299 | @opindex --debug-init |
300 | @cindex errors in init file | |
6bf7aab6 | 301 | Enable the Emacs Lisp debugger for errors in the init file. |
48a36003 LK |
302 | @xref{Error Debugging,, Entering the Debugger on an Error, elisp, The |
303 | GNU Emacs Lisp Reference Manual}. | |
6bf7aab6 DL |
304 | |
305 | @item --unibyte | |
a8575fe5 | 306 | @opindex --unibyte |
b77b6b5c EZ |
307 | @itemx --no-multibyte |
308 | @opindex --no-multibyte | |
56bfaffd | 309 | @cindex unibyte operation, command-line argument |
1a1b17bc | 310 | Do almost everything with single-byte buffers and strings. |
6bf7aab6 | 311 | All buffers and strings are unibyte unless you (or a Lisp program) |
4b1ad19a RS |
312 | explicitly ask for a multibyte buffer or string. (Note that Emacs |
313 | always loads Lisp files in multibyte mode, even if @samp{--unibyte} is | |
314 | specified; see @ref{Enabling Multibyte}.) Setting the environment | |
e93b7ca6 RS |
315 | variable @env{EMACS_UNIBYTE} has the same effect |
316 | (@pxref{General Variables}). | |
6bf7aab6 DL |
317 | |
318 | @item --multibyte | |
a8575fe5 | 319 | @opindex --multibyte |
b77b6b5c EZ |
320 | @itemx --no-unibyte |
321 | @opindex --no-unibyte | |
60a96371 | 322 | Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs |
6bf7aab6 DL |
323 | uses multibyte characters by default, as usual. |
324 | @end table | |
325 | ||
326 | @node Command Example | |
327 | @appendixsec Command Argument Example | |
328 | ||
329 | Here is an example of using Emacs with arguments and options. It | |
330 | assumes you have a Lisp program file called @file{hack-c.el} which, when | |
331 | loaded, performs some useful operation on the current buffer, expected | |
332 | to be a C program. | |
333 | ||
334 | @example | |
e93b7ca6 | 335 | emacs --batch foo.c -l hack-c -f save-buffer >& log |
6bf7aab6 DL |
336 | @end example |
337 | ||
338 | @noindent | |
339 | This says to visit @file{foo.c}, load @file{hack-c.el} (which makes | |
340 | changes in the visited file), save @file{foo.c} (note that | |
341 | @code{save-buffer} is the function that @kbd{C-x C-s} is bound to), and | |
b77b6b5c | 342 | then exit back to the shell (because of @samp{--batch}). @samp{--batch} |
6bf7aab6 DL |
343 | also guarantees there will be no problem redirecting output to |
344 | @file{log}, because Emacs will not assume that it has a display terminal | |
345 | to work with. | |
346 | ||
347 | @node Resume Arguments | |
348 | @appendixsec Resuming Emacs with Arguments | |
349 | ||
350 | You can specify action arguments for Emacs when you resume it after | |
351 | a suspension. To prepare for this, put the following code in your | |
352 | @file{.emacs} file (@pxref{Hooks}): | |
353 | ||
515d3b4b | 354 | @c `resume-suspend-hook' is correct. It is the name of a function. |
6bf7aab6 DL |
355 | @example |
356 | (add-hook 'suspend-hook 'resume-suspend-hook) | |
357 | (add-hook 'suspend-resume-hook 'resume-process-args) | |
358 | @end example | |
359 | ||
360 | As further preparation, you must execute the shell script | |
515d3b4b RS |
361 | @file{emacs.csh} (if you use csh as your shell) or @file{emacs.bash} |
362 | (if you use bash as your shell). These scripts define an alias named | |
6bf7aab6 | 363 | @code{edit}, which will resume Emacs giving it new command line |
515d3b4b RS |
364 | arguments such as files to visit. The scripts are found in the |
365 | @file{etc} subdirectory of the Emacs distribution. | |
6bf7aab6 DL |
366 | |
367 | Only action arguments work properly when you resume Emacs. Initial | |
368 | arguments are not recognized---it's too late to execute them anyway. | |
369 | ||
370 | Note that resuming Emacs (with or without arguments) must be done from | |
371 | within the shell that is the parent of the Emacs job. This is why | |
372 | @code{edit} is an alias rather than a program or a shell script. It is | |
373 | not possible to implement a resumption command that could be run from | |
1a1b17bc EZ |
374 | other subjobs of the shell; there is no way to define a command that could |
375 | be made the value of @env{EDITOR}, for example. Therefore, this feature | |
6bf7aab6 DL |
376 | does not take the place of the Emacs Server feature (@pxref{Emacs |
377 | Server}). | |
378 | ||
379 | The aliases use the Emacs Server feature if you appear to have a | |
380 | server Emacs running. However, they cannot determine this with complete | |
381 | accuracy. They may think that a server is still running when in | |
382 | actuality you have killed that Emacs, because the file | |
515d3b4b | 383 | @file{/tmp/esrv@dots{}} still exists. If this happens, find that |
6bf7aab6 DL |
384 | file and delete it. |
385 | ||
386 | @node Environment | |
387 | @appendixsec Environment Variables | |
388 | @cindex environment variables | |
389 | ||
4b1ad19a RS |
390 | The @dfn{environment} is a feature of the operating system; it |
391 | consists of a collection of variables with names and values. Each | |
392 | variable is called an @dfn{environment variable}; environment variable | |
393 | names are case-sensitive, and it is conventional to use upper case | |
394 | letters only. The values are all text strings. | |
6bf7aab6 | 395 | |
4b1ad19a RS |
396 | What makes the environment useful is that subprocesses inherit the |
397 | environment automatically from their parent process. This means you | |
398 | can set up an environment variable in your login shell, and all the | |
399 | programs you run (including Emacs) will automatically see it. | |
400 | Subprocesses of Emacs (such as shells, compilers, and version-control | |
401 | software) inherit the environment from Emacs, too. | |
402 | ||
403 | @findex setenv | |
404 | @findex getenv | |
405 | Inside Emacs, the command @kbd{M-x getenv} gets the value of an | |
406 | environment variable. @kbd{M-x setenv} sets a variable in the Emacs | |
26f17e6a RS |
407 | environment. (Environment variable substitutions with @samp{$} work |
408 | in the value just as in file names; see @ref{File Names with $}.) | |
409 | ||
410 | The way to set environment variables outside of Emacs depends on the | |
411 | operating system, and especially the shell that you are using. For | |
412 | example, here's how to set the environment variable @env{ORGANIZATION} | |
413 | to @samp{not very much} using Bash: | |
6bf7aab6 DL |
414 | |
415 | @example | |
416 | export ORGANIZATION="not very much" | |
417 | @end example | |
418 | ||
419 | @noindent | |
420 | and here's how to do it in csh or tcsh: | |
421 | ||
422 | @example | |
423 | setenv ORGANIZATION "not very much" | |
424 | @end example | |
425 | ||
26f17e6a RS |
426 | When Emacs is using the X Window System, various environment |
427 | variables that control X work for Emacs as well. See the X | |
428 | documentation for more information. | |
6bf7aab6 DL |
429 | |
430 | @menu | |
431 | * General Variables:: Environment variables that all versions of Emacs use. | |
432 | * Misc Variables:: Certain system-specific variables. | |
afcca90b | 433 | * MS-Windows Registry:: An alternative to the environment on MS-Windows. |
6bf7aab6 DL |
434 | @end menu |
435 | ||
436 | @node General Variables | |
437 | @appendixsubsec General Variables | |
438 | ||
4b1ad19a RS |
439 | Here is an alphabetical list of specific environment variables that |
440 | have special meanings in Emacs, giving the name of each variable and | |
441 | its meaning. Most of these variables are also used by some other | |
442 | programs. Emacs does not require any of these environment variables | |
443 | to be set, but it uses their values if they are set. | |
444 | ||
60a96371 | 445 | @table @env |
f51e949c | 446 | @item CDPATH |
6bf7aab6 DL |
447 | Used by the @code{cd} command to search for the directory you specify, |
448 | when you specify a relative directory name. | |
6bf7aab6 | 449 | @item EMACS_UNIBYTE |
56bfaffd | 450 | @cindex unibyte operation, environment variable |
4b1ad19a RS |
451 | Defining this environment variable with a nonempty value directs Emacs |
452 | to do almost everything with single-byte buffers and strings. It is | |
453 | equivalent to using the @samp{--unibyte} command-line option on each | |
454 | invocation. @xref{Initial Options}. | |
6bf7aab6 | 455 | @item EMACSDATA |
4b1ad19a RS |
456 | Directory for the architecture-independent files that come with Emacs. |
457 | This is used to initialize the Lisp variable @code{data-directory}. | |
18a349f5 | 458 | @item EMACSDOC |
4b1ad19a RS |
459 | Directory for the documentation string file, |
460 | @file{DOC-@var{emacsversion}}. This is used to initialize the Lisp | |
b389557a | 461 | variable @code{doc-directory}. |
6bf7aab6 | 462 | @item EMACSLOADPATH |
5d9b65e0 | 463 | A colon-separated list of directories@footnote{ |
54102d63 | 464 | Here and below, whenever we say ``colon-separated list of directories,'' |
5d9b65e0 EZ |
465 | it pertains to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, |
466 | the directories are separated by semi-colons instead, since DOS/Windows | |
467 | file names might include a colon after a drive letter.} | |
468 | to search for Emacs Lisp files---used to initialize @code{load-path}. | |
6bf7aab6 | 469 | @item EMACSPATH |
4b1ad19a RS |
470 | A colon-separated list of directories to search for executable |
471 | files---used to initialize @code{exec-path}. | |
6bf7aab6 | 472 | @item ESHELL |
60a96371 | 473 | Used for shell-mode to override the @env{SHELL} environment variable. |
6bf7aab6 DL |
474 | @item HISTFILE |
475 | The name of the file that shell commands are saved in between logins. | |
ec22060b EZ |
476 | This variable defaults to @file{~/.bash_history} if you use Bash, to |
477 | @file{~/.sh_history} if you use ksh, and to @file{~/.history} | |
478 | otherwise. | |
6bf7aab6 DL |
479 | @item HOME |
480 | The location of the user's files in the directory tree; used for | |
481 | expansion of file names starting with a tilde (@file{~}). On MS-DOS, it | |
482 | defaults to the directory from which Emacs was started, with @samp{/bin} | |
71d0aa0c | 483 | removed from the end if it was present. On Windows, the default value |
f95a841c JR |
484 | of @env{HOME} is the @file{Application Data} subdirectory of the user |
485 | profile directory, though for backwards compatibility @file{C:/} will | |
486 | be used instead if a @file{.emacs} file is found there. | |
6bf7aab6 DL |
487 | @item HOSTNAME |
488 | The name of the machine that Emacs is running on. | |
177c0ea7 | 489 | @item INCPATH |
6bf7aab6 DL |
490 | A colon-separated list of directories. Used by the @code{complete} package |
491 | to search for files. | |
492 | @item INFOPATH | |
b389557a | 493 | A colon-separated list of directories in which to search for Info files. |
fbc164de | 494 | @item LC_ALL |
9c6251b6 | 495 | @itemx LC_COLLATE |
6bf7aab6 | 496 | @itemx LC_CTYPE |
9c6251b6 EZ |
497 | @itemx LC_MESSAGES |
498 | @itemx LC_MONETARY | |
499 | @itemx LC_NUMERIC | |
500 | @itemx LC_TIME | |
fbc164de | 501 | @itemx LANG |
9c6251b6 EZ |
502 | The user's preferred locale. The locale has six categories, specified |
503 | by the environment variables @env{LC_COLLATE} for sorting, | |
504 | @env{LC_CTYPE} for character encoding, @env{LC_MESSAGES} for system | |
505 | messages, @env{LC_MONETARY} for monetary formats, @env{LC_NUMERIC} for | |
506 | numbers, and @env{LC_TIME} for dates and times. If one of these | |
507 | variables is not set, the category defaults to the value of the | |
508 | @env{LANG} environment variable, or to the default @samp{C} locale if | |
509 | @env{LANG} is not set. But if @env{LC_ALL} is specified, it overrides | |
510 | the settings of all the other locale environment variables. | |
511 | ||
afcca90b JR |
512 | On MS-Windows, if @env{LANG} is not already set in the environment |
513 | when Emacs starts, Emacs sets it based on the system-wide default | |
514 | language, which you can set in the @samp{Regional Settings} Control Panel | |
515 | on some versions of MS-Windows. | |
516 | ||
517 | The value of the @env{LC_CTYPE} category is | |
4b1ad19a | 518 | matched against entries in @code{locale-language-names}, |
fbc164de | 519 | @code{locale-charset-language-names}, and |
4b1ad19a RS |
520 | @code{locale-preferred-coding-systems}, to select a default language |
521 | environment and coding system. @xref{Language Environments}. | |
6bf7aab6 | 522 | @item LOGNAME |
60a96371 | 523 | The user's login name. See also @env{USER}. |
6bf7aab6 DL |
524 | @item MAIL |
525 | The name of the user's system mail inbox. | |
6bf7aab6 | 526 | @item MH |
4b1ad19a | 527 | Name of setup file for the mh system. (The default is @file{~/.mh_profile}.) |
6bf7aab6 DL |
528 | @item NAME |
529 | The real-world name of the user. | |
530 | @item NNTPSERVER | |
5937ea41 | 531 | The name of the news server. Used by the mh and Gnus packages. |
6bf7aab6 DL |
532 | @item ORGANIZATION |
533 | The name of the organization to which you belong. Used for setting the | |
5937ea41 | 534 | `Organization:' header in your posts from the Gnus package. |
6bf7aab6 | 535 | @item PATH |
5d9b65e0 EZ |
536 | A colon-separated list of directories in which executables reside. This |
537 | is used to initialize the Emacs Lisp variable @code{exec-path}. | |
6bf7aab6 DL |
538 | @item PWD |
539 | If set, this should be the default directory when Emacs was started. | |
540 | @item REPLYTO | |
541 | If set, this specifies an initial value for the variable | |
542 | @code{mail-default-reply-to}. @xref{Mail Headers}. | |
543 | @item SAVEDIR | |
544 | The name of a directory in which news articles are saved by default. | |
5937ea41 | 545 | Used by the Gnus package. |
6bf7aab6 DL |
546 | @item SHELL |
547 | The name of an interpreter used to parse and execute programs run from | |
548 | inside Emacs. | |
46af94d9 SJ |
549 | @item SMTPSERVER |
550 | The name of the outgoing mail server. Used by the SMTP library | |
333c5fc5 | 551 | (@pxref{Top,,Sending mail via SMTP,smtpmail}). |
afcca90b | 552 | @cindex background mode, on @command{xterm} |
6bf7aab6 | 553 | @item TERM |
0ec1f115 | 554 | The type of the terminal that Emacs is using. This variable must be |
6bf7aab6 DL |
555 | set unless Emacs is run in batch mode. On MS-DOS, it defaults to |
556 | @samp{internal}, which specifies a built-in terminal emulation that | |
b370b3b0 | 557 | handles the machine's own display. If the value of @env{TERM} indicates |
afcca90b | 558 | that Emacs runs in non-windowed mode from @command{xterm} or a similar |
b370b3b0 EZ |
559 | terminal emulator, the background mode defaults to @samp{light}, and |
560 | Emacs will choose colors that are appropriate for a light background. | |
6bf7aab6 DL |
561 | @item TERMCAP |
562 | The name of the termcap library file describing how to program the | |
60a96371 | 563 | terminal specified by the @env{TERM} variable. This defaults to |
6bf7aab6 DL |
564 | @file{/etc/termcap}. |
565 | @item TMPDIR | |
566 | Used by the Emerge package as a prefix for temporary files. | |
567 | @item TZ | |
94c3309f | 568 | This specifies the current time zone and possibly also daylight |
afcca90b | 569 | saving time information. On MS-DOS, if @env{TZ} is not set in the |
94c3309f | 570 | environment when Emacs starts, Emacs defines a default value as |
9c3aede4 | 571 | appropriate for the country code returned by DOS. On MS-Windows, Emacs |
afcca90b | 572 | does not use @env{TZ} at all. |
6bf7aab6 | 573 | @item USER |
60a96371 | 574 | The user's login name. See also @env{LOGNAME}. On MS-DOS, this |
6bf7aab6 DL |
575 | defaults to @samp{root}. |
576 | @item VERSION_CONTROL | |
577 | Used to initialize the @code{version-control} variable (@pxref{Backup | |
578 | Names}). | |
579 | @end table | |
580 | ||
581 | @node Misc Variables | |
582 | @appendixsubsec Miscellaneous Variables | |
583 | ||
584 | These variables are used only on particular configurations: | |
585 | ||
60a96371 | 586 | @table @env |
6bf7aab6 | 587 | @item COMSPEC |
ec22060b EZ |
588 | On MS-DOS and MS-Windows, the name of the command interpreter to use |
589 | when invoking batch files and commands internal to the shell. On MS-DOS | |
590 | this is also used to make a default value for the @env{SHELL} environment | |
591 | variable. | |
6bf7aab6 DL |
592 | |
593 | @item NAME | |
60a96371 | 594 | On MS-DOS, this variable defaults to the value of the @env{USER} |
6bf7aab6 DL |
595 | variable. |
596 | ||
597 | @item TEMP | |
598 | @itemx TMP | |
ec22060b EZ |
599 | On MS-DOS and MS-Windows, these specify the name of the directory for |
600 | storing temporary files in. | |
6bf7aab6 DL |
601 | |
602 | @item EMACSTEST | |
603 | On MS-DOS, this specifies a file to use to log the operation of the | |
604 | internal terminal emulator. This feature is useful for submitting bug | |
605 | reports. | |
606 | ||
607 | @item EMACSCOLORS | |
9c3aede4 RS |
608 | On MS-DOS, this specifies the screen colors. It is useful to set them |
609 | this way, since otherwise Emacs would display the default colors | |
610 | momentarily when it starts up. | |
611 | ||
612 | The value of this variable should be the two-character encoding of the | |
6bf7aab6 DL |
613 | foreground (the first character) and the background (the second |
614 | character) colors of the default face. Each character should be the | |
615 | hexadecimal code for the desired color on a standard PC text-mode | |
47d7776c | 616 | display. For example, to get blue text on a light gray background, |
ed50f966 | 617 | specify @samp{EMACSCOLORS=17}, since 1 is the code of the blue color and |
47d7776c | 618 | 7 is the code of the light gray color. |
6bf7aab6 DL |
619 | |
620 | The PC display usually supports only eight background colors. However, | |
621 | Emacs switches the DOS display to a mode where all 16 colors can be used | |
622 | for the background, so all four bits of the background color are | |
623 | actually used. | |
624 | ||
625 | @item WINDOW_GFX | |
626 | Used when initializing the Sun windows system. | |
afcca90b JR |
627 | |
628 | @item PRELOAD_WINSOCK | |
629 | On MS-Windows, if you set this variable, Emacs will load and initialize | |
630 | the network library at startup, instead of waiting until the first | |
631 | time it is required. | |
632 | ||
633 | @item emacs_dir | |
634 | On MS-Windows, @env{emacs_dir} is a special environment variable, which | |
635 | indicates the full path of the directory in which Emacs is installed. | |
636 | If Emacs is installed in the standard directory structure, it | |
637 | calculates this value automatically. It is not much use setting this | |
638 | variable yourself unless your installation is non-standard, since | |
639 | unlike other environment variables, it will be overridden by Emacs at | |
640 | startup. When setting other environment variables, such as | |
641 | @env{EMACSLOADPATH}, you may find it useful to use @env{emacs_dir} | |
642 | rather than hard-coding an absolute path. This allows multiple | |
643 | versions of Emacs to share the same environment variable settings, and | |
644 | it allows you to move the Emacs installation directory, without | |
645 | changing any environment or registry settings. | |
6bf7aab6 | 646 | @end table |
e428626a | 647 | |
afcca90b JR |
648 | @node MS-Windows Registry |
649 | @appendixsubsec The MS-Windows System Registry | |
650 | @pindex addpm, MS-Windows installation program | |
651 | @cindex registry, setting environment variables and resources on MS-Windows | |
652 | ||
653 | On MS-Windows, the installation program @command{addpm.exe} adds values | |
654 | for @env{emacs_dir}, @env{EMACSLOADPATH}, @env{EMACSDATA}, | |
655 | @env{EMACSPATH}, @env{EMACSDOC}, @env{SHELL} and @env{TERM} to the | |
656 | @file{HKEY_LOCAL_MACHINE} section of the system registry, under | |
657 | @file{/Software/GNU/Emacs}. It does this because there is no standard | |
658 | place to set environment variables across different versions of | |
659 | Windows. Running @command{addpm.exe} is no longer strictly | |
660 | necessary in recent versions of Emacs, but if you are upgrading from | |
661 | an older version, running @command{addpm.exe} ensures that you do not have | |
662 | older registry entries from a previous installation, which may not be | |
663 | compatible with the latest version of Emacs. | |
664 | ||
665 | When Emacs starts, as well as checking the environment, it also checks | |
666 | the System Registry for those variables and for @env{HOME}, @env{LANG} | |
667 | and @env{PRELOAD_WINSOCK}. | |
668 | ||
669 | To determine the value of those variables, Emacs goes through the | |
670 | following procedure. First, the environment is checked. If the | |
671 | variable is not found there, Emacs looks for registry keys by that | |
672 | name under @file{/Software/GNU/Emacs}; first in the | |
673 | @file{HKEY_CURRENT_USER} section of the registry, and if not found | |
674 | there, in the @file{HKEY_LOCAL_MACHINE} section. Finally, if Emacs | |
675 | still cannot determine the values, compiled-in defaults are used. | |
676 | ||
677 | In addition to the environment variables above, you can also add many | |
678 | of the settings which on X belong in the @file{.Xdefaults} file | |
679 | (@pxref{X Resources}) to the @file{/Software/GNU/Emacs} registry key. | |
680 | Settings you add to the @file{HKEY_LOCAL_MACHINE} section will affect | |
681 | all users of the machine. Settings you add to the | |
682 | @file{HKEY_CURRENT_USER} section will only affect you, and will | |
683 | override machine wide settings. | |
684 | ||
e428626a | 685 | @node Display X |
177c0ea7 | 686 | @appendixsec Specifying the Display Name |
e428626a RS |
687 | @cindex display name (X Window System) |
688 | @cindex @env{DISPLAY} environment variable | |
689 | ||
690 | The environment variable @env{DISPLAY} tells all X clients, including | |
691 | Emacs, where to display their windows. Its value is set by default | |
692 | in ordinary circumstances, when you start an X server and run jobs | |
693 | locally. Occasionally you may need to specify the display yourself; for | |
694 | example, if you do a remote login and want to run a client program | |
695 | remotely, displaying on your local screen. | |
696 | ||
697 | With Emacs, the main reason people change the default display is to | |
698 | let them log into another system, run Emacs on that system, but have the | |
699 | window displayed at their local terminal. You might need to log in | |
700 | to another system because the files you want to edit are there, or | |
701 | because the Emacs executable file you want to run is there. | |
702 | ||
703 | The syntax of the @env{DISPLAY} environment variable is | |
704 | @samp{@var{host}:@var{display}.@var{screen}}, where @var{host} is the | |
705 | host name of the X Window System server machine, @var{display} is an | |
706 | arbitrarily-assigned number that distinguishes your server (X terminal) | |
707 | from other servers on the same machine, and @var{screen} is a | |
708 | rarely-used field that allows an X server to control multiple terminal | |
709 | screens. The period and the @var{screen} field are optional. If | |
710 | included, @var{screen} is usually zero. | |
711 | ||
712 | For example, if your host is named @samp{glasperle} and your server is | |
713 | the first (or perhaps the only) server listed in the configuration, your | |
714 | @env{DISPLAY} is @samp{glasperle:0.0}. | |
715 | ||
716 | You can specify the display name explicitly when you run Emacs, either | |
717 | by changing the @env{DISPLAY} variable, or with the option @samp{-d | |
718 | @var{display}} or @samp{--display=@var{display}}. Here is an example: | |
719 | ||
720 | @smallexample | |
721 | emacs --display=glasperle:0 & | |
722 | @end smallexample | |
723 | ||
724 | You can inhibit the direct use of the window system and GUI with the | |
76dd3692 | 725 | @samp{-nw} option. It tells Emacs to display using ordinary @acronym{ASCII} on |
e428626a RS |
726 | its controlling terminal. This is also an initial option. |
727 | ||
728 | Sometimes, security arrangements prevent a program on a remote system | |
729 | from displaying on your local system. In this case, trying to run Emacs | |
730 | produces messages like this: | |
731 | ||
732 | @smallexample | |
733 | Xlib: connection to "glasperle:0.0" refused by server | |
734 | @end smallexample | |
735 | ||
736 | @noindent | |
afcca90b | 737 | You might be able to overcome this problem by using the @command{xhost} |
e428626a RS |
738 | command on the local system to give permission for access from your |
739 | remote machine. | |
740 | ||
741 | @node Font X | |
742 | @appendixsec Font Specification Options | |
743 | @cindex font name (X Window System) | |
744 | ||
31572e29 LT |
745 | By default, Emacs displays text in a twelve point Courier font (when |
746 | using X). You can specify a different font on your command line | |
747 | through the option @samp{-fn @var{name}} (or @samp{--font}, which is | |
748 | an alias for @samp{-fn}). | |
e428626a RS |
749 | |
750 | @table @samp | |
751 | @item -fn @var{name} | |
752 | @opindex -fn | |
753 | @itemx --font=@var{name} | |
754 | @opindex --font | |
755 | @cindex specify default font from the command line | |
756 | Use font @var{name} as the default font. | |
757 | @end table | |
758 | ||
31572e29 LT |
759 | Under X, each font has a long name which consists of fourteen words |
760 | or numbers, separated by dashes. Some fonts also have shorter | |
761 | nicknames. For instance, @samp{9x15} is such a nickname. This font | |
762 | makes each character nine pixels wide and fifteen pixels high. You | |
763 | can use either kind of name. Case is insignificant in both kinds. | |
764 | You can use wildcard patterns for the font name; then Emacs lets X | |
765 | choose one of the fonts that match the pattern. The wildcard | |
766 | character @samp{*} matches any sequence of characters (including none) | |
767 | and @samp{?} matches any single character. However, matching is | |
768 | implementation-dependent, and can be inaccurate when wildcards match | |
769 | dashes in a long name. For reliable results, supply all 14 dashes and | |
770 | use wildcards only within a field. Here is an example, which happens | |
771 | to specify the font whose nickname is @samp{6x13}: | |
e428626a RS |
772 | |
773 | @smallexample | |
eca274b1 RS |
774 | emacs -fn \ |
775 | "-misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1" & | |
e428626a RS |
776 | @end smallexample |
777 | ||
778 | @noindent | |
779 | You can also specify the font in your @file{.Xdefaults} file: | |
780 | ||
781 | @smallexample | |
782 | emacs.font: -misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1 | |
31572e29 LT |
783 | @end smallexample |
784 | ||
785 | Note that if you use a wildcard pattern on the command line, you | |
786 | need to enclose it in single or double quotes, to prevent the shell | |
787 | from accidentally expanding it into a list of file names. On the | |
788 | other hand, you should not quote the name in the @file{.Xdefaults} | |
789 | file. | |
790 | ||
791 | The default font used by Emacs (under X) is: | |
792 | ||
793 | @smallexample | |
794 | -adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1 | |
e428626a RS |
795 | @end smallexample |
796 | ||
797 | A long font name has the following form: | |
798 | ||
799 | @smallexample | |
800 | -@var{maker}-@var{family}-@var{weight}-@var{slant}-@var{widthtype}-@var{style}@dots{} | |
31572e29 | 801 | @dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{registry}-@var{encoding} |
e428626a RS |
802 | @end smallexample |
803 | ||
804 | @table @var | |
805 | @item maker | |
806 | This is the name of the font manufacturer. | |
807 | @item family | |
808 | This is the name of the font family---for example, @samp{courier}. | |
809 | @item weight | |
810 | This is normally @samp{bold}, @samp{medium} or @samp{light}. Other | |
811 | words may appear here in some font names. | |
812 | @item slant | |
813 | This is @samp{r} (roman), @samp{i} (italic), @samp{o} (oblique), | |
814 | @samp{ri} (reverse italic), or @samp{ot} (other). | |
815 | @item widthtype | |
816 | This is normally @samp{condensed}, @samp{extended}, @samp{semicondensed} | |
817 | or @samp{normal}. Other words may appear here in some font names. | |
818 | @item style | |
819 | This is an optional additional style name. Usually it is empty---most | |
820 | long font names have two hyphens in a row at this point. | |
821 | @item pixels | |
822 | This is the font height, in pixels. | |
823 | @item height | |
824 | This is the font height on the screen, measured in tenths of a printer's | |
825 | point---approximately 1/720 of an inch. In other words, it is the point | |
826 | size of the font, times ten. For a given vertical resolution, | |
827 | @var{height} and @var{pixels} are proportional; therefore, it is common | |
828 | to specify just one of them and use @samp{*} for the other. | |
829 | @item horiz | |
830 | This is the horizontal resolution, in pixels per inch, of the screen for | |
831 | which the font is intended. | |
832 | @item vert | |
833 | This is the vertical resolution, in pixels per inch, of the screen for | |
834 | which the font is intended. Normally the resolution of the fonts on | |
835 | your system is the right value for your screen; therefore, you normally | |
836 | specify @samp{*} for this and @var{horiz}. | |
837 | @item spacing | |
838 | This is @samp{m} (monospace), @samp{p} (proportional) or @samp{c} | |
839 | (character cell). | |
840 | @item width | |
841 | This is the average character width, in pixels, multiplied by ten. | |
31572e29 LT |
842 | @item registry |
843 | @itemx encoding | |
844 | These together make up the X font character set that the font depicts. | |
845 | (X font character sets are not the same as Emacs charsets, but they | |
846 | are solutions for the same problem.) You can use the | |
847 | @command{xfontsel} program to check which choices you have. However, | |
848 | normally you should use @samp{iso8859} for @var{registry} and @samp{1} | |
849 | for @var{encoding}. | |
e428626a RS |
850 | @end table |
851 | ||
852 | @cindex listing system fonts | |
853 | You will probably want to use a fixed-width default font---that is, | |
854 | a font in which all characters have the same width. Any font with | |
855 | @samp{m} or @samp{c} in the @var{spacing} field of the long name is a | |
afcca90b | 856 | fixed-width font. Here's how to use the @command{xlsfonts} program to |
e428626a RS |
857 | list all the fixed-width fonts available on your system: |
858 | ||
859 | @example | |
860 | xlsfonts -fn '*x*' | egrep "^[0-9]+x[0-9]+" | |
861 | xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*' | |
862 | xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*' | |
863 | @end example | |
864 | ||
865 | @noindent | |
afcca90b | 866 | To see what a particular font looks like, use the @command{xfd} command. |
e428626a RS |
867 | For example: |
868 | ||
869 | @example | |
870 | xfd -fn 6x13 | |
871 | @end example | |
872 | ||
873 | @noindent | |
874 | displays the entire font @samp{6x13}. | |
875 | ||
876 | While running Emacs, you can set the font of the current frame | |
877 | (@pxref{Frame Parameters}) or for a specific kind of text | |
878 | (@pxref{Faces}). | |
879 | ||
e15044ea | 880 | @node Colors |
e428626a RS |
881 | @appendixsec Window Color Options |
882 | @cindex color of window | |
883 | @cindex text colors, from command line | |
884 | ||
885 | @findex list-colors-display | |
886 | @cindex available colors | |
887 | On a color display, you can specify which color to use for various | |
888 | parts of the Emacs display. To find out what colors are available on | |
889 | your system, type @kbd{M-x list-colors-display}, or press | |
890 | @kbd{C-Mouse-2} and select @samp{Display Colors} from the pop-up menu. | |
75f97d20 EZ |
891 | (A particular window system might support many more colors, but the |
892 | list displayed by @code{list-colors-display} shows their portable | |
893 | subset that can be safely used on any display supported by Emacs.) | |
e428626a RS |
894 | If you do not specify colors, on windowed displays the default for the |
895 | background is white and the default for all other colors is black. On a | |
896 | monochrome display, the foreground is black, the background is white, | |
897 | and the border is gray if the display supports that. On terminals, the | |
898 | background is usually black and the foreground is white. | |
899 | ||
900 | Here is a list of the command-line options for specifying colors: | |
901 | ||
902 | @table @samp | |
903 | @item -fg @var{color} | |
904 | @opindex -fg | |
905 | @itemx --foreground-color=@var{color} | |
906 | @opindex --foreground-color | |
907 | @cindex foreground color, command-line argument | |
908 | Specify the foreground color. @var{color} should be a standard color | |
909 | name, or a numeric specification of the color's red, green, and blue | |
910 | components as in @samp{#4682B4} or @samp{RGB:46/82/B4}. | |
911 | @item -bg @var{color} | |
912 | @opindex -bg | |
913 | @itemx --background-color=@var{color} | |
914 | @opindex --background-color | |
915 | @cindex background color, command-line argument | |
916 | Specify the background color. | |
917 | @item -bd @var{color} | |
918 | @opindex -bd | |
919 | @itemx --border-color=@var{color} | |
920 | @opindex --border-color | |
921 | @cindex border color, command-line argument | |
922 | Specify the color of the border of the X window. | |
923 | @item -cr @var{color} | |
924 | @opindex -cr | |
925 | @itemx --cursor-color=@var{color} | |
926 | @opindex --cursor-color | |
927 | @cindex cursor color, command-line argument | |
928 | Specify the color of the Emacs cursor which indicates where point is. | |
929 | @item -ms @var{color} | |
930 | @opindex -ms | |
931 | @itemx --mouse-color=@var{color} | |
932 | @opindex --mouse-color | |
933 | @cindex mouse pointer color, command-line argument | |
934 | Specify the color for the mouse cursor when the mouse is in the Emacs window. | |
935 | @item -r | |
936 | @opindex -r | |
937 | @itemx -rv | |
938 | @opindex -rv | |
939 | @itemx --reverse-video | |
940 | @opindex --reverse-video | |
941 | @cindex reverse video, command-line argument | |
942 | Reverse video---swap the foreground and background colors. | |
e15044ea EZ |
943 | @item --color=@var{mode} |
944 | @opindex --color | |
945 | @cindex standard colors on a character terminal | |
946 | For a character terminal only, specify the mode of color support. The | |
947 | parameter @var{mode} can be one of the following: | |
948 | @table @samp | |
949 | @item never | |
950 | @itemx no | |
951 | Don't use colors even if the terminal's capabilities specify color | |
952 | support. | |
953 | @item default | |
954 | @itemx auto | |
955 | Same as when @option{--color} is not used at all: Emacs detects at | |
956 | startup whether the terminal supports colors, and if it does, turns on | |
957 | colored display. | |
958 | @item always | |
959 | @itemx yes | |
960 | @itemx ansi8 | |
961 | Turn on the color support unconditionally, and use color commands | |
962 | specified by the ANSI escape sequences for the 8 standard colors. | |
963 | @item @var{num} | |
964 | Use color mode for @var{num} colors. If @var{num} is -1, turn off | |
965 | color support (equivalent to @samp{never}); if it is 0, use the | |
966 | default color support for this terminal (equivalent to @samp{auto}); | |
75f97d20 EZ |
967 | otherwise use an appropriate standard mode for @var{num} colors. |
968 | Depending on your terminal's capabilities, Emacs might be able to turn | |
969 | on a color mode for 8, 16, 88, or 256 as the value of @var{num}. If | |
e15044ea EZ |
970 | there is no mode that supports @var{num} colors, Emacs acts as if |
971 | @var{num} were 0, i.e.@: it uses the terminal's default color support | |
972 | mode. | |
973 | @end table | |
974 | If @var{mode} is omitted, it defaults to @var{ansi8}. | |
e428626a RS |
975 | @end table |
976 | ||
977 | For example, to use a coral mouse cursor and a slate blue text cursor, | |
978 | enter: | |
979 | ||
980 | @example | |
981 | emacs -ms coral -cr 'slate blue' & | |
982 | @end example | |
983 | ||
984 | You can reverse the foreground and background colors through the | |
985 | @samp{-rv} option or with the X resource @samp{reverseVideo}. | |
986 | ||
987 | The @samp{-fg}, @samp{-bg}, and @samp{-rv} options function on | |
988 | text-only terminals as well as on window systems. | |
989 | ||
990 | @node Window Size X | |
d7beb4c9 | 991 | @appendixsec Options for Window Size and Position |
e428626a RS |
992 | @cindex geometry of Emacs window |
993 | @cindex position and size of Emacs frame | |
994 | @cindex width and height of Emacs frame | |
d7beb4c9 | 995 | @cindex specifying fullscreen for Emacs frame |
e428626a | 996 | |
d7beb4c9 | 997 | Here is a list of the command-line options for specifying size and |
177c0ea7 | 998 | position of the initial Emacs frame: |
e428626a RS |
999 | |
1000 | @table @samp | |
1001 | @item -g @var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]} | |
1002 | @opindex -g | |
b77b6b5c EZ |
1003 | @itemx --geometry=@var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]} |
1004 | @opindex --geometry | |
1005 | @cindex geometry, command-line argument | |
26f17e6a | 1006 | Specify the size @var{width} and @var{height} (measured in character |
e428626a | 1007 | columns and lines), and positions @var{xoffset} and @var{yoffset} |
26f17e6a | 1008 | (measured in pixels). This applies to all frames. |
e428626a | 1009 | |
d7beb4c9 EZ |
1010 | @item -fs |
1011 | @opindex -fs | |
1012 | @itemx --fullscreen | |
1013 | @opindex --fullscreen | |
1014 | @cindex fullscreen, command-line argument | |
1015 | Specify that width and height shall be the size of the screen. | |
1016 | ||
1017 | @item -fh | |
1018 | @opindex -fh | |
1019 | @itemx --fullheight | |
1020 | @opindex --fullheight | |
1021 | @cindex fullheight, command-line argument | |
1022 | Specify that the height shall be the height of the screen. | |
1023 | ||
1024 | @item -fw | |
1025 | @opindex -fw | |
1026 | @itemx --fullwidth | |
1027 | @opindex --fullwidth | |
1028 | @cindex fullwidth, command-line argument | |
1029 | Specify that the width shall be the width of the screen. | |
e428626a RS |
1030 | @end table |
1031 | ||
d7beb4c9 | 1032 | |
e428626a | 1033 | @noindent |
d7beb4c9 EZ |
1034 | In the @samp{--geometry} option, @code{@r{@{}+-@r{@}}} means either a plus |
1035 | sign or a minus sign. A plus | |
e428626a RS |
1036 | sign before @var{xoffset} means it is the distance from the left side of |
1037 | the screen; a minus sign means it counts from the right side. A plus | |
1038 | sign before @var{yoffset} means it is the distance from the top of the | |
1039 | screen, and a minus sign there indicates the distance from the bottom. | |
1040 | The values @var{xoffset} and @var{yoffset} may themselves be positive or | |
1041 | negative, but that doesn't change their meaning, only their direction. | |
1042 | ||
afcca90b | 1043 | Emacs uses the same units as @command{xterm} does to interpret the geometry. |
e428626a RS |
1044 | The @var{width} and @var{height} are measured in characters, so a large font |
1045 | creates a larger frame than a small font. (If you specify a proportional | |
1046 | font, Emacs uses its maximum bounds width as the width unit.) The | |
1047 | @var{xoffset} and @var{yoffset} are measured in pixels. | |
1048 | ||
e428626a | 1049 | You do not have to specify all of the fields in the geometry |
5e24bf12 RS |
1050 | specification. If you omit both @var{xoffset} and @var{yoffset}, the |
1051 | window manager decides where to put the Emacs frame, possibly by | |
1052 | letting you place it with the mouse. For example, @samp{164x55} | |
1053 | specifies a window 164 columns wide, enough for two ordinary width | |
1054 | windows side by side, and 55 lines tall. | |
e428626a RS |
1055 | |
1056 | The default width for Emacs is 80 characters and the default height is | |
1057 | 40 lines. You can omit either the width or the height or both. If | |
1058 | you start the geometry with an integer, Emacs interprets it as the | |
1059 | width. If you start with an @samp{x} followed by an integer, Emacs | |
1060 | interprets it as the height. Thus, @samp{81} specifies just the width; | |
1061 | @samp{x45} specifies just the height. | |
1062 | ||
1063 | If you start with @samp{+} or @samp{-}, that introduces an offset, | |
1064 | which means both sizes are omitted. Thus, @samp{-3} specifies the | |
1065 | @var{xoffset} only. (If you give just one offset, it is always | |
1066 | @var{xoffset}.) @samp{+3-3} specifies both the @var{xoffset} and the | |
1067 | @var{yoffset}, placing the frame near the bottom left of the screen. | |
1068 | ||
1069 | You can specify a default for any or all of the fields in | |
1070 | @file{.Xdefaults} file, and then override selected fields with a | |
1071 | @samp{--geometry} option. | |
1072 | ||
5e24bf12 RS |
1073 | Since the mode line and the echo area occupy the last 2 lines of the |
1074 | frame, the height of the initial text window is 2 less than the height | |
1075 | specified in your geometry. In non-X-toolkit versions of Emacs, the | |
1076 | menu bar also takes one line of the specified number. But in the X | |
1077 | toolkit version, the menu bar is additional and does not count against | |
1078 | the specified height. The tool bar, if present, is also additional. | |
d7beb4c9 | 1079 | |
5e24bf12 RS |
1080 | Enabling or disabling the menu bar or tool bar alters the amount of |
1081 | space available for ordinary text. Therefore, if Emacs starts up with | |
1082 | a tool bar (which is the default), and handles the geometry | |
1083 | specification assuming there is a tool bar, and then your | |
1084 | @file{~/.emacs} file disables the tool bar, you will end up with a | |
1085 | frame geometry different from what you asked for. To get the intended | |
1086 | size with no tool bar, use an X resource to specify ``no tool bar'' | |
b77b6b5c | 1087 | (@pxref{Table of Resources}); then Emacs will already know there's no |
5e24bf12 RS |
1088 | tool bar when it processes the specified geometry. |
1089 | ||
1090 | When using one of @samp{--fullscreen}, @samp{--fullwidth} or | |
d7beb4c9 EZ |
1091 | @samp{--fullheight} there may be some space around the frame |
1092 | anyway. That is because Emacs rounds the sizes so they are an | |
1093 | even number of character heights and widths. | |
1094 | ||
1095 | Some window managers have options that can make them ignore both | |
1096 | program-specified and user-specified positions (sawfish is one). | |
1097 | If these are set, Emacs fails to position the window correctly. | |
1098 | ||
e428626a RS |
1099 | @node Borders X |
1100 | @appendixsec Internal and External Borders | |
1101 | @cindex borders (X Window System) | |
1102 | ||
1103 | An Emacs frame has an internal border and an external border. The | |
1104 | internal border is an extra strip of the background color around the | |
1105 | text portion of the frame. Emacs itself draws the internal border. | |
1106 | The external border is added by the window manager outside the frame; | |
1107 | depending on the window manager you use, it may contain various boxes | |
1108 | you can click on to move or iconify the window. | |
1109 | ||
1110 | @table @samp | |
1111 | @item -ib @var{width} | |
1112 | @opindex -ib | |
1113 | @itemx --internal-border=@var{width} | |
1114 | @opindex --internal-border | |
b77b6b5c EZ |
1115 | @cindex internal border width, command-line argument |
1116 | Specify @var{width} as the width of the internal border (between the text | |
1117 | and the main border), in pixels. | |
e428626a RS |
1118 | |
1119 | @item -bw @var{width} | |
1120 | @opindex -bw | |
1121 | @itemx --border-width=@var{width} | |
1122 | @opindex --border-width | |
b77b6b5c | 1123 | @cindex main border width, command-line argument |
e428626a RS |
1124 | Specify @var{width} as the width of the main border, in pixels. |
1125 | @end table | |
1126 | ||
1127 | When you specify the size of the frame, that does not count the | |
1128 | borders. The frame's position is measured from the outside edge of the | |
1129 | external border. | |
1130 | ||
1131 | Use the @samp{-ib @var{n}} option to specify an internal border | |
1132 | @var{n} pixels wide. The default is 1. Use @samp{-bw @var{n}} to | |
1133 | specify the width of the external border (though the window manager may | |
1134 | not pay attention to what you specify). The default width of the | |
1135 | external border is 2. | |
1136 | ||
1137 | @node Title X | |
1138 | @appendixsec Frame Titles | |
1139 | ||
1140 | An Emacs frame may or may not have a specified title. The frame | |
1141 | title, if specified, appears in window decorations and icons as the | |
1142 | name of the frame. If an Emacs frame has no specified title, the | |
1143 | default title has the form @samp{@var{invocation-name}@@@var{machine}} | |
1144 | (if there is only one frame) or the selected window's buffer name (if | |
1145 | there is more than one frame). | |
1146 | ||
1147 | You can specify a title for the initial Emacs frame with a command | |
1148 | line option: | |
1149 | ||
1150 | @table @samp | |
b77b6b5c | 1151 | @item -T @var{title} |
e428626a | 1152 | @opindex -T |
b77b6b5c EZ |
1153 | @itemx --title=@var{title} |
1154 | @opindex --title | |
e428626a RS |
1155 | @cindex frame title, command-line argument |
1156 | Specify @var{title} as the title for the initial Emacs frame. | |
1157 | @end table | |
1158 | ||
186e9bcc | 1159 | The @samp{--name} option (@pxref{Resources}) also specifies the title |
e428626a RS |
1160 | for the initial Emacs frame. |
1161 | ||
1162 | @node Icons X | |
1163 | @appendixsec Icons | |
1164 | @cindex icons (X Window System) | |
1165 | ||
1166 | Most window managers allow the user to ``iconify'' a frame, removing | |
1167 | it from sight, and leaving a small, distinctive ``icon'' window in its | |
1168 | place. Clicking on the icon window makes the frame itself appear again. | |
1169 | If you have many clients running at once, you can avoid cluttering up | |
1170 | the screen by iconifying most of the clients. | |
1171 | ||
1172 | @table @samp | |
1173 | @item -i | |
1174 | @opindex -i | |
1175 | @itemx --icon-type | |
1176 | @opindex --icon-type | |
1177 | @cindex Emacs icon, a gnu | |
1178 | Use a picture of a gnu as the Emacs icon. | |
1179 | ||
1180 | @item -iconic | |
1181 | @opindex --iconic | |
1182 | @itemx --iconic | |
1183 | @cindex start iconified, command-line argument | |
1184 | Start Emacs in iconified state. | |
1185 | @end table | |
1186 | ||
1187 | The @samp{-i} or @samp{--icon-type} option tells Emacs to use an icon | |
1188 | window containing a picture of the GNU gnu. If omitted, Emacs lets the | |
1189 | window manager choose what sort of icon to use---usually just a small | |
1190 | rectangle containing the frame's title. | |
1191 | ||
1192 | The @samp{-iconic} option tells Emacs to begin running as an icon, | |
1193 | rather than showing a frame right away. In this situation, the icon | |
1194 | is the only indication that Emacs has started; the text frame doesn't | |
1195 | appear until you deiconify it. | |
ab5796a9 | 1196 | |
b77b6b5c EZ |
1197 | @node Misc X |
1198 | @appendixsec Other Display Options | |
1199 | ||
1200 | @table @samp | |
1201 | @item -hb | |
1202 | @opindex -hb | |
1203 | @itemx --horizontal-scroll-bars | |
1204 | @opindex --horizontal-scroll-bars | |
7c195b93 RS |
1205 | @c @cindex horizontal scroll bars, command-line argument |
1206 | Enable horizontal scroll bars. Since horizontal scroll bars | |
1207 | are not yet implemented, this actually does nothing. | |
b77b6b5c EZ |
1208 | |
1209 | @item -vb | |
1210 | @opindex -vb | |
1211 | @itemx --vertical-scroll-bars | |
1212 | @opindex --vertical-scroll-bars | |
1213 | @cindex vertical scroll bars, command-line argument | |
1214 | Enable vertical scroll bars. | |
1215 | ||
1216 | @item -lsp @var{pixels} | |
1217 | @opindex -lsp | |
1218 | @itemx --line-spacing=@var{pixels} | |
1219 | @opindex --line-spacing | |
1220 | @cindex line spacing, command-line argument | |
1221 | Specify @var{pixels} as additional space to put between lines, in pixels. | |
2b4938c7 JL |
1222 | |
1223 | @item -nbc | |
1224 | @opindex -nbc | |
1225 | @itemx --no-blinking-cursor | |
1226 | @opindex --no-blinking-cursor | |
1227 | @cindex blinking cursor disable, command-line argument | |
1228 | Disable the blinking cursor on graphical terminals. | |
5b99c91c RS |
1229 | |
1230 | @item -D | |
1231 | @opindex -D | |
1232 | @itemx --basic-display | |
1233 | @opindex --basic-display | |
1234 | Disable the menu-bar, the tool-bar, the scroll-bars, and tool tips, | |
1235 | and turn off the blinking cursor. This can be useful for making a | |
1236 | test case that simplifies debugging of display problems. | |
b77b6b5c EZ |
1237 | @end table |
1238 | ||
1239 | The @samp{--xrm} option (@pxref{Resources}) specifies additional | |
1240 | X resource values. | |
1241 | ||
ab5796a9 MB |
1242 | @ignore |
1243 | arch-tag: fffecd9e-7329-4a51-a3cc-dd4a9889340e | |
1244 | @end ignore |