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