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