Mercurial > emacs
annotate man/cmdargs.texi @ 52188:3c4ff8bbdc85
(Character Type): Define anchor "modifier bits".
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 13 Aug 2003 17:24:09 +0000 |
parents | b65aa1d740eb |
children | 695cf19ef79e |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
49925
417d86de4023
Document SMTPSERVER environment variable.
Simon Josefsson <jas@extundo.com>
parents:
49600
diff
changeset
|
2 @c Copyright (C) 1985,86,87,93,94,95,1997,2001, 2003 Free Software Foundation, Inc. |
25829 | 3 @c See file emacs.texi for copying conditions. |
40524
5c00f23a93ec
Everything about X resources moved to xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
39287
diff
changeset
|
4 @node Command Arguments, X Resources, Service, Top |
25829 | 5 @appendix Command Line Arguments |
6 @cindex command line arguments | |
7 @cindex arguments (command line) | |
8 @cindex options (command line) | |
9 @cindex switches (command line) | |
10 @cindex startup (command line arguments) | |
11 | |
12 GNU Emacs supports command line arguments to request various actions | |
13 when invoking Emacs. These are for compatibility with other editors and | |
14 for sophisticated activities. We don't recommend using them for | |
15 ordinary editing. | |
16 | |
17 Arguments starting with @samp{-} are @dfn{options}. Other arguments | |
18 specify files to visit. Emacs visits the specified files while it | |
37835
a4f04496cfb0
Update description of visiting multiple files with the command line.
Richard M. Stallman <rms@gnu.org>
parents:
37796
diff
changeset
|
19 starts up. The last file name on your command line becomes the |
a4f04496cfb0
Update description of visiting multiple files with the command line.
Richard M. Stallman <rms@gnu.org>
parents:
37796
diff
changeset
|
20 current buffer; the other files are also visited in other buffers. If |
a4f04496cfb0
Update description of visiting multiple files with the command line.
Richard M. Stallman <rms@gnu.org>
parents:
37796
diff
changeset
|
21 there are two files, they are both displayed; otherwise the last file |
a4f04496cfb0
Update description of visiting multiple files with the command line.
Richard M. Stallman <rms@gnu.org>
parents:
37796
diff
changeset
|
22 is displayed along with a buffer list that shows what other buffers |
a4f04496cfb0
Update description of visiting multiple files with the command line.
Richard M. Stallman <rms@gnu.org>
parents:
37796
diff
changeset
|
23 there are. As with most programs, the special argument @samp{--} says |
a4f04496cfb0
Update description of visiting multiple files with the command line.
Richard M. Stallman <rms@gnu.org>
parents:
37796
diff
changeset
|
24 that all subsequent arguments are file names, not options, even if |
a4f04496cfb0
Update description of visiting multiple files with the command line.
Richard M. Stallman <rms@gnu.org>
parents:
37796
diff
changeset
|
25 they start with @samp{-}. |
25829 | 26 |
27 Emacs command options can specify many things, such as the size and | |
28 position of the X window Emacs uses, its colors, and so on. A few | |
29 options support advanced usage, such as running Lisp functions on files | |
30 in batch mode. The sections of this chapter describe the available | |
31 options, arranged according to their purpose. | |
32 | |
33 There are two ways of writing options: the short forms that start with | |
34 a single @samp{-}, and the long forms that start with @samp{--}. For | |
35 example, @samp{-d} is a short form and @samp{--display} is the | |
36 corresponding long form. | |
37 | |
38 The long forms with @samp{--} are easier to remember, but longer to | |
39 type. However, you don't have to spell out the whole option name; any | |
40 unambiguous abbreviation is enough. When a long option takes an | |
41 argument, you can use either a space or an equal sign to separate the | |
42 option name and the argument. Thus, you can write either | |
43 @samp{--display sugar-bombs:0.0} or @samp{--display=sugar-bombs:0.0}. | |
44 We recommend an equal sign because it makes the relationship clearer, | |
45 and the tables below always show an equal sign. | |
46 | |
47 @cindex initial options (command line) | |
48 @cindex action options (command line) | |
49 Most options specify how to initialize Emacs, or set parameters for | |
50 the Emacs session. We call them @dfn{initial options}. A few options | |
51 specify things to do: for example, load libraries, call functions, or | |
38745 | 52 terminate Emacs. These are called @dfn{action options}. These and file |
25829 | 53 names together are called @dfn{action arguments}. Emacs processes all |
54 the action arguments in the order they are written. | |
55 | |
56 @menu | |
57 * Action Arguments:: Arguments to visit files, load libraries, | |
58 and call functions. | |
59 * Initial Options:: Arguments that take effect while starting Emacs. | |
60 * Command Example:: Examples of using command line arguments. | |
61 * Resume Arguments:: Specifying arguments when you resume a running Emacs. | |
62 * Environment:: Environment variables that Emacs uses. | |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
63 * Display X:: Changing the default display and using remote login. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
64 * Font X:: Choosing a font for text, under X. |
42750
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
65 * Colors:: Choosing display colors. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
66 * Window Size X:: Start-up window size, under X. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
67 * Borders X:: Internal and external borders, under X. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
68 * Title X:: Specifying the initial frame's title. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
69 * Icons X:: Choosing what sort of icon to use, under X. |
25829 | 70 @end menu |
71 | |
72 @node Action Arguments | |
73 @appendixsec Action Arguments | |
74 | |
75 Here is a table of the action arguments and options: | |
76 | |
77 @table @samp | |
78 @item @var{file} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
79 @opindex --visit |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
80 @itemx --visit=@var{file} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
81 @opindex --file |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
82 @itemx --file=@var{file} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
83 @cindex visiting files, command-line argument |
45875
a4199c98c1eb
Document inhibit-startup-buffer-menu.
Richard M. Stallman <rms@gnu.org>
parents:
45532
diff
changeset
|
84 @vindex inhibit-startup-buffer-menu |
25829 | 85 Visit @var{file} using @code{find-file}. @xref{Visiting}. |
45875
a4199c98c1eb
Document inhibit-startup-buffer-menu.
Richard M. Stallman <rms@gnu.org>
parents:
45532
diff
changeset
|
86 If you visit several files at startup in this way, Emacs |
a4199c98c1eb
Document inhibit-startup-buffer-menu.
Richard M. Stallman <rms@gnu.org>
parents:
45532
diff
changeset
|
87 also displays a Buffer Menu buffer to show you what files it |
a4199c98c1eb
Document inhibit-startup-buffer-menu.
Richard M. Stallman <rms@gnu.org>
parents:
45532
diff
changeset
|
88 has visited. You can inhibit that by setting @code{inhibit-startup-buffer-menu} to @code{t}. |
25829 | 89 |
90 @item +@var{linenum} @var{file} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
91 @opindex +@var{linenum} |
25829 | 92 Visit @var{file} using @code{find-file}, then go to line number |
93 @var{linenum} in it. | |
94 | |
38466
7f9fe7268ee4
Add description of +LINE:COLUMN.
Gerd Moellmann <gerd@gnu.org>
parents:
37835
diff
changeset
|
95 @item +@var{linenum}:@var{columnnum} @var{file} |
7f9fe7268ee4
Add description of +LINE:COLUMN.
Gerd Moellmann <gerd@gnu.org>
parents:
37835
diff
changeset
|
96 Visit @var{file} using @code{find-file}, then go to line number |
38745 | 97 @var{linenum} and put point at column number @var{columnnum}. |
38466
7f9fe7268ee4
Add description of +LINE:COLUMN.
Gerd Moellmann <gerd@gnu.org>
parents:
37835
diff
changeset
|
98 |
25829 | 99 @need 3000 |
100 @item -l @var{file} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
101 @opindex -l |
25829 | 102 @itemx --load=@var{file} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
103 @opindex --load |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
104 @cindex loading Lisp libraries, command-line argument |
25829 | 105 Load a Lisp library named @var{file} with the function @code{load}. |
106 @xref{Lisp Libraries}. The library can be found either in the current | |
107 directory, or in the Emacs library search path as specified | |
29107 | 108 with @env{EMACSLOADPATH} (@pxref{General Variables}). |
25829 | 109 |
110 @item -f @var{function} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
111 @opindex -f |
25829 | 112 @itemx --funcall=@var{function} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
113 @opindex --funcall |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
114 @cindex call Lisp functions, command-line argument |
25829 | 115 Call Lisp function @var{function} with no arguments. |
116 | |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
117 @item --eval=@var{expression} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
118 @opindex --eval |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
119 @itemx --execute=@var{expression} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
120 @opindex --execute |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
121 @cindex evaluate expression, command-line argument |
25829 | 122 Evaluate Lisp expression @var{expression}. |
123 | |
124 @item --insert=@var{file} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
125 @opindex --insert |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
126 @cindex insert file contents, command-line argument |
25829 | 127 Insert the contents of @var{file} into the current buffer. This is like |
128 what @kbd{M-x insert-file} does. @xref{Misc File Ops}. | |
129 | |
130 @item --kill | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
131 @opindex --kill |
25829 | 132 Exit from Emacs without asking for confirmation. |
133 @end table | |
134 | |
135 @vindex command-line-args | |
136 The init file can access the values of the action arguments as the | |
137 elements of a list in the variable @code{command-line-args}. The init | |
138 file can override the normal processing of the action arguments, or | |
139 define new ones, by reading and setting this variable. | |
140 | |
141 @node Initial Options | |
142 @appendixsec Initial Options | |
143 | |
144 The initial options specify parameters for the Emacs session. This | |
145 section describes the more general initial options; some other options | |
35188
94d46968a93f
Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
34221
diff
changeset
|
146 specifically related to the X Window System appear in the following |
94d46968a93f
Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
34221
diff
changeset
|
147 sections. |
25829 | 148 |
149 Some initial options affect the loading of init files. The normal | |
150 actions of Emacs are to first load @file{site-start.el} if it exists, | |
151 then your own init file @file{~/.emacs} if it exists, and finally | |
152 @file{default.el} if it exists; certain options prevent loading of some | |
153 of these files or substitute other files for them. | |
154 | |
155 @table @samp | |
156 @item -t @var{device} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
157 @opindex -t |
25829 | 158 @itemx --terminal=@var{device} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
159 @opindex --terminal |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
160 @cindex device for Emacs terminal I/O |
25829 | 161 Use @var{device} as the device for terminal input and output. |
162 | |
163 @item -d @var{display} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
164 @opindex -d |
25829 | 165 @itemx --display=@var{display} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
166 @opindex --display |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
167 @cindex display for Emacs frame |
25829 | 168 Use the X Window System and use the display named @var{display} to open |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
169 the initial Emacs frame. @xref{Display X}, for more details. |
25829 | 170 |
171 @item -nw | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
172 @opindex -nw |
40563
62cd2910ba80
(Initial Options): Document command line option --no-window-system instead
Pavel Janík <Pavel@Janik.cz>
parents:
40524
diff
changeset
|
173 @itemx --no-window-system |
62cd2910ba80
(Initial Options): Document command line option --no-window-system instead
Pavel Janík <Pavel@Janik.cz>
parents:
40524
diff
changeset
|
174 @opindex --no-window-system |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
175 @cindex disable window system |
33012
df207c5f631f
(Colors X): Document support for -fg, -bg, and -rv
Eli Zaretskii <eliz@gnu.org>
parents:
31169
diff
changeset
|
176 Don't communicate directly with the window system, disregarding the |
40652 | 177 @env{DISPLAY} environment variable even if it is set. This means that |
178 Emacs uses the terminal from which it was launched for all its display | |
179 and input. | |
25829 | 180 |
181 @need 3000 | |
182 @cindex batch mode | |
183 @item -batch | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
184 @opindex --batch |
25829 | 185 @itemx --batch |
186 Run Emacs in @dfn{batch mode}, which means that the text being edited is | |
187 not displayed and the standard terminal interrupt characters such as | |
188 @kbd{C-z} and @kbd{C-c} continue to have their normal effect. Emacs in | |
38870
d44abb4e68b2
Don't use "print" for displaying a message.
Richard M. Stallman <rms@gnu.org>
parents:
38773
diff
changeset
|
189 batch mode outputs to @code{stderr} only what would normally be displayed |
36875 | 190 in the echo area under program control, and functions which would |
191 normally read from the minibuffer take their input from @code{stdin}. | |
25829 | 192 |
193 Batch mode is used for running programs written in Emacs Lisp from | |
194 shell scripts, makefiles, and so on. Normally the @samp{-l} option | |
195 or @samp{-f} option will be used as well, to invoke a Lisp program | |
196 to do the batch processing. | |
197 | |
47323 | 198 @samp{--batch} implies @samp{-q} (do not load an init file). It also |
38745 | 199 causes Emacs to exit after processing all the command options. In |
200 addition, it disables auto-saving except in buffers for which it has | |
201 been explicitly requested. | |
25829 | 202 |
47323 | 203 @item --script @var{file} |
204 @opindex --script | |
205 Run Emacs in batch mode, like @samp{--batch}, and then read and | |
206 execute the Lisp code in @var{file}. | |
207 | |
208 The normal use of this option is in executable script files that run | |
209 Emacs. They can start with this text on the first line | |
210 | |
211 @example | |
212 #!/usr/bin/emacs --script | |
213 @end example | |
214 | |
215 @noindent | |
216 which will invoke Emacs with @samp{--script} and supply the name of | |
217 the script file as @var{file}. Emacs Lisp then treats @samp{#!} as a | |
218 comment delimiter. | |
219 | |
25829 | 220 @item -q |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
221 @opindex -q |
25829 | 222 @itemx --no-init-file |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
223 @opindex --no-init-file |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
224 @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
|
225 @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
|
226 @cindex @file{default.el} file, not loading |
25829 | 227 Do not load your Emacs init file @file{~/.emacs}, or @file{default.el} |
38659 | 228 either. When invoked like this, Emacs does not allow saving options |
37619
3b026479775e
(Initial Options): Document that -q disables customizations saving.
Eli Zaretskii <eliz@gnu.org>
parents:
37595
diff
changeset
|
229 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
|
230 @xref{Easy Customization}. |
25829 | 231 |
232 @item --no-site-file | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
233 @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
|
234 @cindex @file{site-start.el} file, not loading |
25829 | 235 Do not load @file{site-start.el}. The options @samp{-q}, @samp{-u} |
236 and @samp{-batch} have no effect on the loading of this file---this is | |
237 the only option that blocks it. | |
238 | |
45532 | 239 @item --no-splash |
240 @opindex --no-splash | |
45531
8873fff421e7
*** empty log message ***
Colin Walters <walters@gnu.org>
parents:
44326
diff
changeset
|
241 @vindex inhibit-startup-message |
45875
a4199c98c1eb
Document inhibit-startup-buffer-menu.
Richard M. Stallman <rms@gnu.org>
parents:
45532
diff
changeset
|
242 Do not display a splash screen on startup; this is equivalent to |
a4199c98c1eb
Document inhibit-startup-buffer-menu.
Richard M. Stallman <rms@gnu.org>
parents:
45532
diff
changeset
|
243 setting the variable @code{inhibit-startup-message} to non-@code{nil}. |
45531
8873fff421e7
*** empty log message ***
Colin Walters <walters@gnu.org>
parents:
44326
diff
changeset
|
244 |
25829 | 245 @item -u @var{user} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
246 @opindex -u |
25829 | 247 @itemx --user=@var{user} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
248 @opindex --user |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
249 @cindex load init file of another user |
25829 | 250 Load @var{user}'s Emacs init file @file{~@var{user}/.emacs} instead of |
251 your own. | |
252 | |
253 @item --debug-init | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
254 @opindex --debug-init |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
255 @cindex errors in init file |
25829 | 256 Enable the Emacs Lisp debugger for errors in the init file. |
257 | |
258 @item --unibyte | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
259 @opindex --unibyte |
31142
7d0a8b91a6c0
Mention that Lisp files are normally read as multibyte.
Eli Zaretskii <eliz@gnu.org>
parents:
30967
diff
changeset
|
260 @cindex unibyte operation, command-line argument |
38648
66e920bfc687
Fix typos; from Eric Hanchrow <offby1@blarg.net>.
Eli Zaretskii <eliz@gnu.org>
parents:
38466
diff
changeset
|
261 Do almost everything with single-byte buffers and strings. |
25829 | 262 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
|
263 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
|
264 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
|
265 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
|
266 variable @env{EMACS_UNIBYTE} has the same effect. |
25829 | 267 |
268 @item --multibyte | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
269 @opindex --multibyte |
29107 | 270 Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs |
25829 | 271 uses multibyte characters by default, as usual. |
272 @end table | |
273 | |
274 @node Command Example | |
275 @appendixsec Command Argument Example | |
276 | |
277 Here is an example of using Emacs with arguments and options. It | |
278 assumes you have a Lisp program file called @file{hack-c.el} which, when | |
279 loaded, performs some useful operation on the current buffer, expected | |
280 to be a C program. | |
281 | |
282 @example | |
283 emacs -batch foo.c -l hack-c -f save-buffer >& log | |
284 @end example | |
285 | |
286 @noindent | |
287 This says to visit @file{foo.c}, load @file{hack-c.el} (which makes | |
288 changes in the visited file), save @file{foo.c} (note that | |
289 @code{save-buffer} is the function that @kbd{C-x C-s} is bound to), and | |
290 then exit back to the shell (because of @samp{-batch}). @samp{-batch} | |
291 also guarantees there will be no problem redirecting output to | |
292 @file{log}, because Emacs will not assume that it has a display terminal | |
293 to work with. | |
294 | |
295 @node Resume Arguments | |
296 @appendixsec Resuming Emacs with Arguments | |
297 | |
298 You can specify action arguments for Emacs when you resume it after | |
299 a suspension. To prepare for this, put the following code in your | |
300 @file{.emacs} file (@pxref{Hooks}): | |
301 | |
37835
a4f04496cfb0
Update description of visiting multiple files with the command line.
Richard M. Stallman <rms@gnu.org>
parents:
37796
diff
changeset
|
302 @c `resume-suspend-hook' is correct. It is the name of a function. |
25829 | 303 @example |
304 (add-hook 'suspend-hook 'resume-suspend-hook) | |
305 (add-hook 'suspend-resume-hook 'resume-process-args) | |
306 @end example | |
307 | |
308 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
|
309 @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
|
310 (if you use bash as your shell). These scripts define an alias named |
25829 | 311 @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
|
312 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
|
313 @file{etc} subdirectory of the Emacs distribution. |
25829 | 314 |
315 Only action arguments work properly when you resume Emacs. Initial | |
316 arguments are not recognized---it's too late to execute them anyway. | |
317 | |
318 Note that resuming Emacs (with or without arguments) must be done from | |
319 within the shell that is the parent of the Emacs job. This is why | |
320 @code{edit} is an alias rather than a program or a shell script. It is | |
321 not possible to implement a resumption command that could be run from | |
38648
66e920bfc687
Fix typos; from Eric Hanchrow <offby1@blarg.net>.
Eli Zaretskii <eliz@gnu.org>
parents:
38466
diff
changeset
|
322 other subjobs of the shell; there is no way to define a command that could |
66e920bfc687
Fix typos; from Eric Hanchrow <offby1@blarg.net>.
Eli Zaretskii <eliz@gnu.org>
parents:
38466
diff
changeset
|
323 be made the value of @env{EDITOR}, for example. Therefore, this feature |
25829 | 324 does not take the place of the Emacs Server feature (@pxref{Emacs |
325 Server}). | |
326 | |
327 The aliases use the Emacs Server feature if you appear to have a | |
328 server Emacs running. However, they cannot determine this with complete | |
329 accuracy. They may think that a server is still running when in | |
330 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
|
331 @file{/tmp/esrv@dots{}} still exists. If this happens, find that |
25829 | 332 file and delete it. |
333 | |
334 @node Environment | |
335 @appendixsec Environment Variables | |
336 @cindex environment variables | |
337 | |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
338 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
|
339 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
|
340 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
|
341 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
|
342 letters only. The values are all text strings. |
25829 | 343 |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
344 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
|
345 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
|
346 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
|
347 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
|
348 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
|
349 software) inherit the environment from Emacs, too. |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
350 |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
351 @findex setenv |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
352 @findex getenv |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
353 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
|
354 environment variable. @kbd{M-x setenv} sets a variable in the Emacs |
46202
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
355 environment. (Environment variable substitutions with @samp{$} work |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
356 in the value just as in file names; see @ref{File Names with $}.) |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
357 |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
358 The way to set environment variables outside of Emacs depends on the |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
359 operating system, and especially the shell that you are using. For |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
360 example, here's how to set the environment variable @env{ORGANIZATION} |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
361 to @samp{not very much} using Bash: |
25829 | 362 |
363 @example | |
364 export ORGANIZATION="not very much" | |
365 @end example | |
366 | |
367 @noindent | |
368 and here's how to do it in csh or tcsh: | |
369 | |
370 @example | |
371 setenv ORGANIZATION "not very much" | |
372 @end example | |
373 | |
46202
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
374 When Emacs is using the X Window System, various environment |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
375 variables that control X work for Emacs as well. See the X |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
376 documentation for more information. |
25829 | 377 |
378 @menu | |
379 * General Variables:: Environment variables that all versions of Emacs use. | |
380 * Misc Variables:: Certain system-specific variables. | |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
381 * MS-Windows Registry:: An alternative to the environment on MS-Windows. |
25829 | 382 @end menu |
383 | |
384 @node General Variables | |
385 @appendixsubsec General Variables | |
386 | |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
387 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
|
388 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
|
389 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
|
390 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
|
391 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
|
392 |
29107 | 393 @table @env |
36362
193e0fa6c140
(General Variables): Fix a typo in the CDPATH entry.
Eli Zaretskii <eliz@gnu.org>
parents:
36346
diff
changeset
|
394 @item CDPATH |
25829 | 395 Used by the @code{cd} command to search for the directory you specify, |
396 when you specify a relative directory name. | |
397 @item EMACS_UNIBYTE | |
31142
7d0a8b91a6c0
Mention that Lisp files are normally read as multibyte.
Eli Zaretskii <eliz@gnu.org>
parents:
30967
diff
changeset
|
398 @cindex unibyte operation, environment variable |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
399 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
|
400 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
|
401 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
|
402 invocation. @xref{Initial Options}. |
25829 | 403 @item EMACSDATA |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
404 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
|
405 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
|
406 @item EMACSDOC |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
407 Directory for the documentation string file, |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
408 @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
|
409 variable @code{doc-directory}. |
25829 | 410 @item EMACSLOADPATH |
36364
fca71f0d9dc4
(General Variables): Add a footnote that all *PATH variables use
Eli Zaretskii <eliz@gnu.org>
parents:
36363
diff
changeset
|
411 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
|
412 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
|
413 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
|
414 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
|
415 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
|
416 to search for Emacs Lisp files---used to initialize @code{load-path}. |
25829 | 417 @item EMACSPATH |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
418 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
|
419 files---used to initialize @code{exec-path}. |
25829 | 420 @item ESHELL |
29107 | 421 Used for shell-mode to override the @env{SHELL} environment variable. |
25829 | 422 @item HISTFILE |
423 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
|
424 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
|
425 @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
|
426 otherwise. |
25829 | 427 @item HOME |
428 The location of the user's files in the directory tree; used for | |
429 expansion of file names starting with a tilde (@file{~}). On MS-DOS, it | |
430 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
|
431 removed from the end if it was present. On Windows, the default value |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
432 of @env{HOME} is @file{C:/}, the root directory of drive @file{C:}. |
25829 | 433 @item HOSTNAME |
434 The name of the machine that Emacs is running on. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47323
diff
changeset
|
435 @item INCPATH |
25829 | 436 A colon-separated list of directories. Used by the @code{complete} package |
437 to search for files. | |
438 @item INFOPATH | |
36295
1203ee52391f
(General Variables) <EMACSDOC>: It's used to
Gerd Moellmann <gerd@gnu.org>
parents:
36293
diff
changeset
|
439 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
|
440 @item LC_ALL |
37085
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
441 @itemx LC_COLLATE |
25829 | 442 @itemx LC_CTYPE |
37085
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
443 @itemx LC_MESSAGES |
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
444 @itemx LC_MONETARY |
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
445 @itemx LC_NUMERIC |
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
446 @itemx LC_TIME |
26140
068f7ad41d40
Describe new functions and variables for locales.
Paul Eggert <eggert@twinsun.com>
parents:
25829
diff
changeset
|
447 @itemx LANG |
37085
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
448 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
|
449 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
|
450 @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
|
451 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
|
452 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
|
453 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
|
454 @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
|
455 @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
|
456 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
|
457 |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
458 On MS-Windows, if @env{LANG} is not already set in the environment |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
459 when Emacs starts, Emacs sets it based on the system-wide default |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
460 language, which you can set in the @samp{Regional Settings} Control Panel |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
461 on some versions of MS-Windows. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
462 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
463 The value of the @env{LC_CTYPE} category is |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
464 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
|
465 @code{locale-charset-language-names}, and |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
466 @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
|
467 environment and coding system. @xref{Language Environments}. |
25829 | 468 @item LOGNAME |
29107 | 469 The user's login name. See also @env{USER}. |
25829 | 470 @item MAIL |
471 The name of the user's system mail inbox. | |
472 @item MAILRC | |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
473 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
|
474 @file{~/.mailrc}.) |
25829 | 475 @item MH |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
476 Name of setup file for the mh system. (The default is @file{~/.mh_profile}.) |
25829 | 477 @item NAME |
478 The real-world name of the user. | |
479 @item NNTPSERVER | |
36293
1bca8e306103
(General Variables): Remove description of
Gerd Moellmann <gerd@gnu.org>
parents:
36186
diff
changeset
|
480 The name of the news server. Used by the mh and Gnus packages. |
25829 | 481 @item ORGANIZATION |
482 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
|
483 `Organization:' header in your posts from the Gnus package. |
25829 | 484 @item PATH |
36364
fca71f0d9dc4
(General Variables): Add a footnote that all *PATH variables use
Eli Zaretskii <eliz@gnu.org>
parents:
36363
diff
changeset
|
485 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
|
486 is used to initialize the Emacs Lisp variable @code{exec-path}. |
25829 | 487 @item PWD |
488 If set, this should be the default directory when Emacs was started. | |
489 @item REPLYTO | |
490 If set, this specifies an initial value for the variable | |
491 @code{mail-default-reply-to}. @xref{Mail Headers}. | |
492 @item SAVEDIR | |
493 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
|
494 Used by the Gnus package. |
25829 | 495 @item SHELL |
496 The name of an interpreter used to parse and execute programs run from | |
497 inside Emacs. | |
49925
417d86de4023
Document SMTPSERVER environment variable.
Simon Josefsson <jas@extundo.com>
parents:
49600
diff
changeset
|
498 @item SMTPSERVER |
417d86de4023
Document SMTPSERVER environment variable.
Simon Josefsson <jas@extundo.com>
parents:
49600
diff
changeset
|
499 The name of the outgoing mail server. Used by the SMTP library |
50475
b65aa1d740eb
Fix cross references.
Juanma Barranquero <lekktu@gmail.com>
parents:
49925
diff
changeset
|
500 (@pxref{Top,,Sending mail via SMTP,smtpmail}). |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
501 @cindex background mode, on @command{xterm} |
25829 | 502 @item TERM |
38745 | 503 The type of the terminal that Emacs is using. This variable must be |
25829 | 504 set unless Emacs is run in batch mode. On MS-DOS, it defaults to |
505 @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
|
506 handles the machine's own display. If the value of @env{TERM} indicates |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
507 that Emacs runs in non-windowed mode from @command{xterm} or a similar |
33017
4c7241b226fc
Document that if $TERM says we are on xterm, the default background
Eli Zaretskii <eliz@gnu.org>
parents:
33012
diff
changeset
|
508 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
|
509 Emacs will choose colors that are appropriate for a light background. |
25829 | 510 @item TERMCAP |
511 The name of the termcap library file describing how to program the | |
29107 | 512 terminal specified by the @env{TERM} variable. This defaults to |
25829 | 513 @file{/etc/termcap}. |
514 @item TMPDIR | |
515 Used by the Emerge package as a prefix for temporary files. | |
516 @item TZ | |
36186
e391cbe3a2fe
Correction for TZ on Microsoft systems.
Richard M. Stallman <rms@gnu.org>
parents:
36146
diff
changeset
|
517 This specifies the current time zone and possibly also daylight |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
518 saving time information. On MS-DOS, if @env{TZ} is not set in the |
36186
e391cbe3a2fe
Correction for TZ on Microsoft systems.
Richard M. Stallman <rms@gnu.org>
parents:
36146
diff
changeset
|
519 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
|
520 appropriate for the country code returned by DOS. On MS-Windows, Emacs |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
521 does not use @env{TZ} at all. |
25829 | 522 @item USER |
29107 | 523 The user's login name. See also @env{LOGNAME}. On MS-DOS, this |
25829 | 524 defaults to @samp{root}. |
525 @item VERSION_CONTROL | |
526 Used to initialize the @code{version-control} variable (@pxref{Backup | |
527 Names}). | |
528 @end table | |
529 | |
530 @node Misc Variables | |
531 @appendixsubsec Miscellaneous Variables | |
532 | |
533 These variables are used only on particular configurations: | |
534 | |
29107 | 535 @table @env |
25829 | 536 @item COMSPEC |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
537 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
|
538 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
|
539 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
|
540 variable. |
25829 | 541 |
542 @item NAME | |
29107 | 543 On MS-DOS, this variable defaults to the value of the @env{USER} |
25829 | 544 variable. |
545 | |
546 @item TEMP | |
547 @itemx TMP | |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
548 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
|
549 storing temporary files in. |
25829 | 550 |
551 @item EMACSTEST | |
552 On MS-DOS, this specifies a file to use to log the operation of the | |
553 internal terminal emulator. This feature is useful for submitting bug | |
554 reports. | |
555 | |
556 @item EMACSCOLORS | |
36502
3f0def4a4210
Minor cleanups. Rename `Motif Resources' node to `LessTif Resources'.
Richard M. Stallman <rms@gnu.org>
parents:
36500
diff
changeset
|
557 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
|
558 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
|
559 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
|
560 |
3f0def4a4210
Minor cleanups. Rename `Motif Resources' node to `LessTif Resources'.
Richard M. Stallman <rms@gnu.org>
parents:
36500
diff
changeset
|
561 The value of this variable should be the two-character encoding of the |
25829 | 562 foreground (the first character) and the background (the second |
563 character) colors of the default face. Each character should be the | |
564 hexadecimal code for the desired color on a standard PC text-mode | |
39267 | 565 display. For example, to get blue text on a light gray background, |
36505
a7400c1ee57f
(Misc Variables): Add example for setting EMACSCOLORS on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents:
36502
diff
changeset
|
566 specify @samp{EMACSCOLORS=17}, since 1 is the code of the blue color and |
39267 | 567 7 is the code of the light gray color. |
25829 | 568 |
569 The PC display usually supports only eight background colors. However, | |
570 Emacs switches the DOS display to a mode where all 16 colors can be used | |
571 for the background, so all four bits of the background color are | |
572 actually used. | |
573 | |
574 @item WINDOW_GFX | |
575 Used when initializing the Sun windows system. | |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
576 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
577 @item PRELOAD_WINSOCK |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
578 On MS-Windows, if you set this variable, Emacs will load and initialize |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
579 the network library at startup, instead of waiting until the first |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
580 time it is required. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
581 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
582 @item emacs_dir |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
583 On MS-Windows, @env{emacs_dir} is a special environment variable, which |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
584 indicates the full path of the directory in which Emacs is installed. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
585 If Emacs is installed in the standard directory structure, it |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
586 calculates this value automatically. It is not much use setting this |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
587 variable yourself unless your installation is non-standard, since |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
588 unlike other environment variables, it will be overridden by Emacs at |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
589 startup. When setting other environment variables, such as |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
590 @env{EMACSLOADPATH}, you may find it useful to use @env{emacs_dir} |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
591 rather than hard-coding an absolute path. This allows multiple |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
592 versions of Emacs to share the same environment variable settings, and |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
593 it allows you to move the Emacs installation directory, without |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
594 changing any environment or registry settings. |
25829 | 595 @end table |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
596 |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
597 @node MS-Windows Registry |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
598 @appendixsubsec The MS-Windows System Registry |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
599 @pindex addpm, MS-Windows installation program |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
600 @cindex registry, setting environment variables and resources on MS-Windows |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
601 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
602 On MS-Windows, the installation program @command{addpm.exe} adds values |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
603 for @env{emacs_dir}, @env{EMACSLOADPATH}, @env{EMACSDATA}, |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
604 @env{EMACSPATH}, @env{EMACSDOC}, @env{SHELL} and @env{TERM} to the |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
605 @file{HKEY_LOCAL_MACHINE} section of the system registry, under |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
606 @file{/Software/GNU/Emacs}. It does this because there is no standard |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
607 place to set environment variables across different versions of |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
608 Windows. Running @command{addpm.exe} is no longer strictly |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
609 necessary in recent versions of Emacs, but if you are upgrading from |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
610 an older version, running @command{addpm.exe} ensures that you do not have |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
611 older registry entries from a previous installation, which may not be |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
612 compatible with the latest version of Emacs. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
613 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
614 When Emacs starts, as well as checking the environment, it also checks |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
615 the System Registry for those variables and for @env{HOME}, @env{LANG} |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
616 and @env{PRELOAD_WINSOCK}. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
617 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
618 To determine the value of those variables, Emacs goes through the |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
619 following procedure. First, the environment is checked. If the |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
620 variable is not found there, Emacs looks for registry keys by that |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
621 name under @file{/Software/GNU/Emacs}; first in the |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
622 @file{HKEY_CURRENT_USER} section of the registry, and if not found |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
623 there, in the @file{HKEY_LOCAL_MACHINE} section. Finally, if Emacs |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
624 still cannot determine the values, compiled-in defaults are used. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
625 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
626 In addition to the environment variables above, you can also add many |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
627 of the settings which on X belong in the @file{.Xdefaults} file |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
628 (@pxref{X Resources}) to the @file{/Software/GNU/Emacs} registry key. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
629 Settings you add to the @file{HKEY_LOCAL_MACHINE} section will affect |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
630 all users of the machine. Settings you add to the |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
631 @file{HKEY_CURRENT_USER} section will only affect you, and will |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
632 override machine wide settings. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
633 |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
634 @node Display X |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47323
diff
changeset
|
635 @appendixsec Specifying the Display Name |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
636 @cindex display name (X Window System) |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
637 @cindex @env{DISPLAY} environment variable |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
638 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
639 The environment variable @env{DISPLAY} tells all X clients, including |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
640 Emacs, where to display their windows. Its value is set by default |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
641 in ordinary circumstances, when you start an X server and run jobs |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
642 locally. Occasionally you may need to specify the display yourself; for |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
643 example, if you do a remote login and want to run a client program |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
644 remotely, displaying on your local screen. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
645 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
646 With Emacs, the main reason people change the default display is to |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
647 let them log into another system, run Emacs on that system, but have the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
648 window displayed at their local terminal. You might need to log in |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
649 to another system because the files you want to edit are there, or |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
650 because the Emacs executable file you want to run is there. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
651 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
652 The syntax of the @env{DISPLAY} environment variable is |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
653 @samp{@var{host}:@var{display}.@var{screen}}, where @var{host} is the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
654 host name of the X Window System server machine, @var{display} is an |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
655 arbitrarily-assigned number that distinguishes your server (X terminal) |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
656 from other servers on the same machine, and @var{screen} is a |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
657 rarely-used field that allows an X server to control multiple terminal |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
658 screens. The period and the @var{screen} field are optional. If |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
659 included, @var{screen} is usually zero. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
660 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
661 For example, if your host is named @samp{glasperle} and your server is |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
662 the first (or perhaps the only) server listed in the configuration, your |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
663 @env{DISPLAY} is @samp{glasperle:0.0}. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
664 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
665 You can specify the display name explicitly when you run Emacs, either |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
666 by changing the @env{DISPLAY} variable, or with the option @samp{-d |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
667 @var{display}} or @samp{--display=@var{display}}. Here is an example: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
668 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
669 @smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
670 emacs --display=glasperle:0 & |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
671 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
672 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
673 You can inhibit the direct use of the window system and GUI with the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
674 @samp{-nw} option. It tells Emacs to display using ordinary ASCII on |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
675 its controlling terminal. This is also an initial option. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
676 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
677 Sometimes, security arrangements prevent a program on a remote system |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
678 from displaying on your local system. In this case, trying to run Emacs |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
679 produces messages like this: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
680 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
681 @smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
682 Xlib: connection to "glasperle:0.0" refused by server |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
683 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
684 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
685 @noindent |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
686 You might be able to overcome this problem by using the @command{xhost} |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
687 command on the local system to give permission for access from your |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
688 remote machine. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
689 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
690 @node Font X |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
691 @appendixsec Font Specification Options |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
692 @cindex font name (X Window System) |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
693 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
694 By default, Emacs displays text in the font named @samp{9x15}, which |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
695 makes each character nine pixels wide and fifteen pixels high. You can |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
696 specify a different font on your command line through the option |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
697 @samp{-fn @var{name}} (or @samp{--font}, which is an alias for |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
698 @samp{-fn}). |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
699 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
700 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
701 @item -fn @var{name} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
702 @opindex -fn |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
703 @itemx --font=@var{name} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
704 @opindex --font |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
705 @cindex specify default font from the command line |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
706 Use font @var{name} as the default font. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
707 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
708 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
709 Under X, each font has a long name which consists of eleven words or |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
710 numbers, separated by dashes. Some fonts also have shorter |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
711 nicknames---@samp{9x15} is such a nickname. You can use either kind of |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
712 name. You can use wildcard patterns for the font name; then Emacs lets |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
713 X choose one of the fonts that match the pattern. Here is an example, |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
714 which happens to specify the font whose nickname is @samp{6x13}: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
715 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
716 @smallexample |
44326 | 717 emacs -fn \ |
718 "-misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1" & | |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
719 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
720 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
721 @noindent |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
722 You can also specify the font in your @file{.Xdefaults} file: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
723 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
724 @smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
725 emacs.font: -misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
726 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
727 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
728 A long font name has the following form: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
729 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
730 @smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
731 -@var{maker}-@var{family}-@var{weight}-@var{slant}-@var{widthtype}-@var{style}@dots{} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
732 @dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{charset} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
733 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
734 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
735 @table @var |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
736 @item maker |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
737 This is the name of the font manufacturer. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
738 @item family |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
739 This is the name of the font family---for example, @samp{courier}. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
740 @item weight |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
741 This is normally @samp{bold}, @samp{medium} or @samp{light}. Other |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
742 words may appear here in some font names. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
743 @item slant |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
744 This is @samp{r} (roman), @samp{i} (italic), @samp{o} (oblique), |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
745 @samp{ri} (reverse italic), or @samp{ot} (other). |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
746 @item widthtype |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
747 This is normally @samp{condensed}, @samp{extended}, @samp{semicondensed} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
748 or @samp{normal}. Other words may appear here in some font names. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
749 @item style |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
750 This is an optional additional style name. Usually it is empty---most |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
751 long font names have two hyphens in a row at this point. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
752 @item pixels |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
753 This is the font height, in pixels. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
754 @item height |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
755 This is the font height on the screen, measured in tenths of a printer's |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
756 point---approximately 1/720 of an inch. In other words, it is the point |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
757 size of the font, times ten. For a given vertical resolution, |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
758 @var{height} and @var{pixels} are proportional; therefore, it is common |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
759 to specify just one of them and use @samp{*} for the other. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
760 @item horiz |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
761 This is the horizontal resolution, in pixels per inch, of the screen for |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
762 which the font is intended. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
763 @item vert |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
764 This is the vertical resolution, in pixels per inch, of the screen for |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
765 which the font is intended. Normally the resolution of the fonts on |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
766 your system is the right value for your screen; therefore, you normally |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
767 specify @samp{*} for this and @var{horiz}. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
768 @item spacing |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
769 This is @samp{m} (monospace), @samp{p} (proportional) or @samp{c} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
770 (character cell). |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
771 @item width |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
772 This is the average character width, in pixels, multiplied by ten. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
773 @item charset |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
774 This is the character set that the font depicts. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
775 Normally you should use @samp{iso8859-1}. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
776 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
777 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
778 @cindex listing system fonts |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
779 You will probably want to use a fixed-width default font---that is, |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
780 a font in which all characters have the same width. Any font with |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
781 @samp{m} or @samp{c} in the @var{spacing} field of the long name is a |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
782 fixed-width font. Here's how to use the @command{xlsfonts} program to |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
783 list all the fixed-width fonts available on your system: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
784 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
785 @example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
786 xlsfonts -fn '*x*' | egrep "^[0-9]+x[0-9]+" |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
787 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*' |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
788 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*' |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
789 @end example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
790 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
791 @noindent |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
792 To see what a particular font looks like, use the @command{xfd} command. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
793 For example: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
794 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
795 @example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
796 xfd -fn 6x13 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
797 @end example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
798 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
799 @noindent |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
800 displays the entire font @samp{6x13}. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
801 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
802 While running Emacs, you can set the font of the current frame |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
803 (@pxref{Frame Parameters}) or for a specific kind of text |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
804 (@pxref{Faces}). |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
805 |
42750
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
806 @node Colors |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
807 @appendixsec Window Color Options |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
808 @cindex color of window |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
809 @cindex text colors, from command line |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
810 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
811 @findex list-colors-display |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
812 @cindex available colors |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
813 On a color display, you can specify which color to use for various |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
814 parts of the Emacs display. To find out what colors are available on |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
815 your system, type @kbd{M-x list-colors-display}, or press |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
816 @kbd{C-Mouse-2} and select @samp{Display Colors} from the pop-up menu. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
817 If you do not specify colors, on windowed displays the default for the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
818 background is white and the default for all other colors is black. On a |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
819 monochrome display, the foreground is black, the background is white, |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
820 and the border is gray if the display supports that. On terminals, the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
821 background is usually black and the foreground is white. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
822 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
823 Here is a list of the command-line options for specifying colors: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
824 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
825 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
826 @item -fg @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
827 @opindex -fg |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
828 @itemx --foreground-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
829 @opindex --foreground-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
830 @cindex foreground color, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
831 Specify the foreground color. @var{color} should be a standard color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
832 name, or a numeric specification of the color's red, green, and blue |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
833 components as in @samp{#4682B4} or @samp{RGB:46/82/B4}. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
834 @item -bg @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
835 @opindex -bg |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
836 @itemx --background-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
837 @opindex --background-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
838 @cindex background color, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
839 Specify the background color. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
840 @item -bd @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
841 @opindex -bd |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
842 @itemx --border-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
843 @opindex --border-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
844 @cindex border color, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
845 Specify the color of the border of the X window. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
846 @item -cr @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
847 @opindex -cr |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
848 @itemx --cursor-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
849 @opindex --cursor-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
850 @cindex cursor color, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
851 Specify the color of the Emacs cursor which indicates where point is. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
852 @item -ms @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
853 @opindex -ms |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
854 @itemx --mouse-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
855 @opindex --mouse-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
856 @cindex mouse pointer color, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
857 Specify the color for the mouse cursor when the mouse is in the Emacs window. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
858 @item -r |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
859 @opindex -r |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
860 @itemx -rv |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
861 @opindex -rv |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
862 @itemx --reverse-video |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
863 @opindex --reverse-video |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
864 @cindex reverse video, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
865 Reverse video---swap the foreground and background colors. |
42750
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
866 @item --color=@var{mode} |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
867 @opindex --color |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
868 @cindex standard colors on a character terminal |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
869 For a character terminal only, specify the mode of color support. The |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
870 parameter @var{mode} can be one of the following: |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
871 @table @samp |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
872 @item never |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
873 @itemx no |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
874 Don't use colors even if the terminal's capabilities specify color |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
875 support. |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
876 @item default |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
877 @itemx auto |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
878 Same as when @option{--color} is not used at all: Emacs detects at |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
879 startup whether the terminal supports colors, and if it does, turns on |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
880 colored display. |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
881 @item always |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
882 @itemx yes |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
883 @itemx ansi8 |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
884 Turn on the color support unconditionally, and use color commands |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
885 specified by the ANSI escape sequences for the 8 standard colors. |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
886 @item @var{num} |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
887 Use color mode for @var{num} colors. If @var{num} is -1, turn off |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
888 color support (equivalent to @samp{never}); if it is 0, use the |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
889 default color support for this terminal (equivalent to @samp{auto}); |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
890 otherwise use an appropriate standard mode for @var{num} colors. If |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
891 there is no mode that supports @var{num} colors, Emacs acts as if |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
892 @var{num} were 0, i.e.@: it uses the terminal's default color support |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
893 mode. |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
894 @end table |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
895 If @var{mode} is omitted, it defaults to @var{ansi8}. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
896 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
897 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
898 For example, to use a coral mouse cursor and a slate blue text cursor, |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
899 enter: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
900 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
901 @example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
902 emacs -ms coral -cr 'slate blue' & |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
903 @end example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
904 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
905 You can reverse the foreground and background colors through the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
906 @samp{-rv} option or with the X resource @samp{reverseVideo}. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
907 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
908 The @samp{-fg}, @samp{-bg}, and @samp{-rv} options function on |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
909 text-only terminals as well as on window systems. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
910 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
911 @node Window Size X |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
912 @appendixsec Options for Window Size and Position |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
913 @cindex geometry of Emacs window |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
914 @cindex position and size of Emacs frame |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
915 @cindex width and height of Emacs frame |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
916 @cindex specifying fullscreen for Emacs frame |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
917 |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
918 Here is a list of the command-line options for specifying size and |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47323
diff
changeset
|
919 position of the initial Emacs frame: |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
920 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
921 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
922 @item -g @var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
923 @opindex -g |
46202
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
924 Specify the size @var{width} and @var{height} (measured in character |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
925 columns and lines), and positions @var{xoffset} and @var{yoffset} |
46202
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
926 (measured in pixels). This applies to all frames. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
927 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
928 @item --geometry=@var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
929 @opindex --geometry |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
930 This is another way of writing the same thing. |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
931 |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
932 @item -fs |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
933 @opindex -fs |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
934 @itemx --fullscreen |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
935 @opindex --fullscreen |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
936 @cindex fullscreen, command-line argument |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
937 Specify that width and height shall be the size of the screen. |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
938 |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
939 @item -fh |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
940 @opindex -fh |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
941 @itemx --fullheight |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
942 @opindex --fullheight |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
943 @cindex fullheight, command-line argument |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
944 Specify that the height shall be the height of the screen. |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
945 |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
946 @item -fw |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
947 @opindex -fw |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
948 @itemx --fullwidth |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
949 @opindex --fullwidth |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
950 @cindex fullwidth, command-line argument |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
951 Specify that the width shall be the width of the screen. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
952 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
953 |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
954 |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
955 @noindent |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
956 In the @samp{--geometry} option, @code{@r{@{}+-@r{@}}} means either a plus |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
957 sign or a minus sign. A plus |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
958 sign before @var{xoffset} means it is the distance from the left side of |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
959 the screen; a minus sign means it counts from the right side. A plus |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
960 sign before @var{yoffset} means it is the distance from the top of the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
961 screen, and a minus sign there indicates the distance from the bottom. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
962 The values @var{xoffset} and @var{yoffset} may themselves be positive or |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
963 negative, but that doesn't change their meaning, only their direction. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
964 |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
965 Emacs uses the same units as @command{xterm} does to interpret the geometry. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
966 The @var{width} and @var{height} are measured in characters, so a large font |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
967 creates a larger frame than a small font. (If you specify a proportional |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
968 font, Emacs uses its maximum bounds width as the width unit.) The |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
969 @var{xoffset} and @var{yoffset} are measured in pixels. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
970 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
971 You do not have to specify all of the fields in the geometry |
46717
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
972 specification. If you omit both @var{xoffset} and @var{yoffset}, the |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
973 window manager decides where to put the Emacs frame, possibly by |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
974 letting you place it with the mouse. For example, @samp{164x55} |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
975 specifies a window 164 columns wide, enough for two ordinary width |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
976 windows side by side, and 55 lines tall. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
977 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
978 The default width for Emacs is 80 characters and the default height is |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
979 40 lines. You can omit either the width or the height or both. If |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
980 you start the geometry with an integer, Emacs interprets it as the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
981 width. If you start with an @samp{x} followed by an integer, Emacs |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
982 interprets it as the height. Thus, @samp{81} specifies just the width; |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
983 @samp{x45} specifies just the height. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
984 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
985 If you start with @samp{+} or @samp{-}, that introduces an offset, |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
986 which means both sizes are omitted. Thus, @samp{-3} specifies the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
987 @var{xoffset} only. (If you give just one offset, it is always |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
988 @var{xoffset}.) @samp{+3-3} specifies both the @var{xoffset} and the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
989 @var{yoffset}, placing the frame near the bottom left of the screen. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
990 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
991 You can specify a default for any or all of the fields in |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
992 @file{.Xdefaults} file, and then override selected fields with a |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
993 @samp{--geometry} option. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
994 |
46717
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
995 Since the mode line and the echo area occupy the last 2 lines of the |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
996 frame, the height of the initial text window is 2 less than the height |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
997 specified in your geometry. In non-X-toolkit versions of Emacs, the |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
998 menu bar also takes one line of the specified number. But in the X |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
999 toolkit version, the menu bar is additional and does not count against |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1000 the specified height. The tool bar, if present, is also additional. |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1001 |
46717
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1002 Enabling or disabling the menu bar or tool bar alters the amount of |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1003 space available for ordinary text. Therefore, if Emacs starts up with |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1004 a tool bar (which is the default), and handles the geometry |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1005 specification assuming there is a tool bar, and then your |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1006 @file{~/.emacs} file disables the tool bar, you will end up with a |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1007 frame geometry different from what you asked for. To get the intended |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1008 size with no tool bar, use an X resource to specify ``no tool bar'' |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1009 (@pxref{Table of Resources});then Emacs will already know there's no |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1010 tool bar when it processes the specified geometry. |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1011 |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1012 When using one of @samp{--fullscreen}, @samp{--fullwidth} or |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1013 @samp{--fullheight} there may be some space around the frame |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1014 anyway. That is because Emacs rounds the sizes so they are an |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1015 even number of character heights and widths. |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1016 |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1017 Some window managers have options that can make them ignore both |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1018 program-specified and user-specified positions (sawfish is one). |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1019 If these are set, Emacs fails to position the window correctly. |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1020 |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1021 @node Borders X |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1022 @appendixsec Internal and External Borders |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1023 @cindex borders (X Window System) |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1024 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1025 An Emacs frame has an internal border and an external border. The |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1026 internal border is an extra strip of the background color around the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1027 text portion of the frame. Emacs itself draws the internal border. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1028 The external border is added by the window manager outside the frame; |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1029 depending on the window manager you use, it may contain various boxes |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1030 you can click on to move or iconify the window. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1031 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1032 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1033 @item -ib @var{width} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1034 @opindex -ib |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1035 @itemx --internal-border=@var{width} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1036 @opindex --internal-border |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1037 @cindex border width, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1038 Specify @var{width} as the width of the internal border, in pixels. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1039 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1040 @item -bw @var{width} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1041 @opindex -bw |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1042 @itemx --border-width=@var{width} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1043 @opindex --border-width |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1044 Specify @var{width} as the width of the main border, in pixels. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1045 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1046 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1047 When you specify the size of the frame, that does not count the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1048 borders. The frame's position is measured from the outside edge of the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1049 external border. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1050 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1051 Use the @samp{-ib @var{n}} option to specify an internal border |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1052 @var{n} pixels wide. The default is 1. Use @samp{-bw @var{n}} to |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1053 specify the width of the external border (though the window manager may |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1054 not pay attention to what you specify). The default width of the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1055 external border is 2. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1056 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1057 @node Title X |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1058 @appendixsec Frame Titles |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1059 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1060 An Emacs frame may or may not have a specified title. The frame |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1061 title, if specified, appears in window decorations and icons as the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1062 name of the frame. If an Emacs frame has no specified title, the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1063 default title has the form @samp{@var{invocation-name}@@@var{machine}} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1064 (if there is only one frame) or the selected window's buffer name (if |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1065 there is more than one frame). |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1066 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1067 You can specify a title for the initial Emacs frame with a command |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1068 line option: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1069 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1070 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1071 @item -title @var{title} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1072 @opindex --title |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1073 @itemx --title=@var{title} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1074 @itemx -T @var{title} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1075 @opindex -T |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1076 @cindex frame title, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1077 Specify @var{title} as the title for the initial Emacs frame. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1078 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1079 |
41374
608e18d9fb18
Fix cross-references to "Resources".
Eli Zaretskii <eliz@gnu.org>
parents:
41369
diff
changeset
|
1080 The @samp{--name} option (@pxref{Resources}) also specifies the title |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1081 for the initial Emacs frame. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1082 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1083 @node Icons X |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1084 @appendixsec Icons |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1085 @cindex icons (X Window System) |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1086 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1087 Most window managers allow the user to ``iconify'' a frame, removing |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1088 it from sight, and leaving a small, distinctive ``icon'' window in its |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1089 place. Clicking on the icon window makes the frame itself appear again. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1090 If you have many clients running at once, you can avoid cluttering up |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1091 the screen by iconifying most of the clients. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1092 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1093 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1094 @item -i |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1095 @opindex -i |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1096 @itemx --icon-type |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1097 @opindex --icon-type |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1098 @cindex Emacs icon, a gnu |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1099 Use a picture of a gnu as the Emacs icon. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1100 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1101 @item -iconic |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1102 @opindex --iconic |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1103 @itemx --iconic |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1104 @cindex start iconified, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1105 Start Emacs in iconified state. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1106 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1107 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1108 The @samp{-i} or @samp{--icon-type} option tells Emacs to use an icon |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1109 window containing a picture of the GNU gnu. If omitted, Emacs lets the |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1110 window manager choose what sort of icon to use---usually just a small |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1111 rectangle containing the frame's title. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1112 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1113 The @samp{-iconic} option tells Emacs to begin running as an icon, |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1114 rather than showing a frame right away. In this situation, the icon |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1115 is the only indication that Emacs has started; the text frame doesn't |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1116 appear until you deiconify it. |