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