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