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