Mercurial > emacs
annotate man/cmdargs.texi @ 71871:dcd566ed4e9b
(Findirect_function): Optimize for no indirection.
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Thu, 13 Jul 2006 13:43:44 +0000 |
parents | 4d628cade603 |
children | e0c1e87a986f 138ce2701550 |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
64890
3723093a21fd
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64361
diff
changeset
|
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2001, 2002, |
68639
dc2d5a6655a3
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
68538
diff
changeset
|
3 @c 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
25829 | 4 @c See file emacs.texi for copying conditions. |
58789
c8e9116cff8b
Rename Command Line to Emacs Invocation.
Richard M. Stallman <rms@gnu.org>
parents:
58758
diff
changeset
|
5 @node Emacs Invocation, X Resources, GNU Free Documentation License, Top |
c8e9116cff8b
Rename Command Line to Emacs Invocation.
Richard M. Stallman <rms@gnu.org>
parents:
58758
diff
changeset
|
6 @appendix Command Line Arguments for Emacs Invocation |
25829 | 7 @cindex command line arguments |
8 @cindex arguments (command line) | |
9 @cindex options (command line) | |
10 @cindex switches (command line) | |
11 @cindex startup (command line arguments) | |
60400
616254f1bdb6
(Emacs Invocation): Add cindex "invocation (command line arguments)"
Juri Linkov <juri@jurta.org>
parents:
60229
diff
changeset
|
12 @cindex invocation (command line arguments) |
25829 | 13 |
14 GNU Emacs supports command line arguments to request various actions | |
15 when invoking Emacs. These are for compatibility with other editors and | |
16 for sophisticated activities. We don't recommend using them for | |
17 ordinary editing. | |
18 | |
59948
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
19 Arguments starting with @samp{-} are @dfn{options}, and so is |
59958
ae756c7d3081
(Emacs Invocation): Fix typo.
Lute Kamstra <lute@gnu.org>
parents:
59948
diff
changeset
|
20 @samp{+@var{linenum}}. All other arguments specify files to visit. |
59948
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
21 Emacs visits the specified files while it starts up. The last file |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
22 name on your command line becomes the current buffer; the other files |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
23 are also visited in other buffers. If there are two files, they are |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
24 both displayed; otherwise the last file is displayed along with a |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
25 buffer list that shows what other buffers there are. As with most |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
26 programs, the special argument @samp{--} says that all subsequent |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
27 arguments are file names, not options, even if they start with |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
28 @samp{-}. |
25829 | 29 |
30 Emacs command options can specify many things, such as the size and | |
31 position of the X window Emacs uses, its colors, and so on. A few | |
32 options support advanced usage, such as running Lisp functions on files | |
33 in batch mode. The sections of this chapter describe the available | |
34 options, arranged according to their purpose. | |
35 | |
36 There are two ways of writing options: the short forms that start with | |
37 a single @samp{-}, and the long forms that start with @samp{--}. For | |
38 example, @samp{-d} is a short form and @samp{--display} is the | |
39 corresponding long form. | |
40 | |
41 The long forms with @samp{--} are easier to remember, but longer to | |
42 type. However, you don't have to spell out the whole option name; any | |
43 unambiguous abbreviation is enough. When a long option takes an | |
44 argument, you can use either a space or an equal sign to separate the | |
45 option name and the argument. Thus, you can write either | |
46 @samp{--display sugar-bombs:0.0} or @samp{--display=sugar-bombs:0.0}. | |
47 We recommend an equal sign because it makes the relationship clearer, | |
48 and the tables below always show an equal sign. | |
49 | |
50 @cindex initial options (command line) | |
51 @cindex action options (command line) | |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
52 @vindex command-line-args |
25829 | 53 Most options specify how to initialize Emacs, or set parameters for |
54 the Emacs session. We call them @dfn{initial options}. A few options | |
55 specify things to do: for example, load libraries, call functions, or | |
38745 | 56 terminate Emacs. These are called @dfn{action options}. These and file |
25829 | 57 names together are called @dfn{action arguments}. Emacs processes all |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
58 the action arguments in the order they are written. The @file{.emacs} file |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
59 can access the values of the action arguments as the elements of a list in |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
60 the variable @code{command-line-args}. |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
61 |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
62 |
25829 | 63 |
64 @menu | |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
65 * Action Arguments:: Arguments to visit files, load libraries, |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
66 and call functions. |
25829 | 67 * Initial Options:: Arguments that take effect while starting Emacs. |
68 * Command Example:: Examples of using command line arguments. | |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
69 * Resume Arguments:: Specifying arguments when you resume a running Emacs. |
25829 | 70 * 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
|
71 * Display X:: Changing the default display and using remote login. |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
72 * Font X:: Choosing a font for text, under X. |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
73 * Colors:: Choosing display colors. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
74 * Window Size X:: Start-up window size, under X. |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
75 * Borders X:: Internal and external borders, under X. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
76 * 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
|
77 * Icons X:: Choosing what sort of icon to use, under X. |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
78 * Misc X:: Other display options. |
25829 | 79 @end menu |
80 | |
81 @node Action Arguments | |
82 @appendixsec Action Arguments | |
83 | |
84 Here is a table of the action arguments and options: | |
85 | |
86 @table @samp | |
87 @item @var{file} | |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
88 @opindex --file |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
89 @itemx --file=@var{file} |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
90 @opindex --find-file |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
91 @itemx --find-file=@var{file} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
92 @opindex --visit |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
93 @itemx --visit=@var{file} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
94 @cindex visiting files, command-line argument |
45875
a4199c98c1eb
Document inhibit-startup-buffer-menu.
Richard M. Stallman <rms@gnu.org>
parents:
45532
diff
changeset
|
95 @vindex inhibit-startup-buffer-menu |
25829 | 96 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
|
97 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
|
98 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
|
99 has visited. You can inhibit that by setting @code{inhibit-startup-buffer-menu} to @code{t}. |
25829 | 100 |
101 @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
|
102 @opindex +@var{linenum} |
25829 | 103 Visit @var{file} using @code{find-file}, then go to line number |
104 @var{linenum} in it. | |
105 | |
38466
7f9fe7268ee4
Add description of +LINE:COLUMN.
Gerd Moellmann <gerd@gnu.org>
parents:
37835
diff
changeset
|
106 @item +@var{linenum}:@var{columnnum} @var{file} |
7f9fe7268ee4
Add description of +LINE:COLUMN.
Gerd Moellmann <gerd@gnu.org>
parents:
37835
diff
changeset
|
107 Visit @var{file} using @code{find-file}, then go to line number |
38745 | 108 @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
|
109 |
25829 | 110 @need 3000 |
111 @item -l @var{file} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
112 @opindex -l |
25829 | 113 @itemx --load=@var{file} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
114 @opindex --load |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
115 @cindex loading Lisp libraries, command-line argument |
25829 | 116 Load a Lisp library named @var{file} with the function @code{load}. |
59948
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
117 @xref{Lisp Libraries}. If @var{file} is not an absolute file name, |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
118 the library can be found either in the current directory, or in the |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
119 Emacs library search path as specified with @env{EMACSLOADPATH} |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
120 (@pxref{General Variables}). |
25829 | 121 |
63068
01a320949e45
(Action Arguments): Clarify directory default for -l.
Richard M. Stallman <rms@gnu.org>
parents:
61467
diff
changeset
|
122 @strong{Warning:} If previous command-line arguments have visited |
01a320949e45
(Action Arguments): Clarify directory default for -l.
Richard M. Stallman <rms@gnu.org>
parents:
61467
diff
changeset
|
123 files, the current directory is the directory of the last file |
01a320949e45
(Action Arguments): Clarify directory default for -l.
Richard M. Stallman <rms@gnu.org>
parents:
61467
diff
changeset
|
124 visited. |
01a320949e45
(Action Arguments): Clarify directory default for -l.
Richard M. Stallman <rms@gnu.org>
parents:
61467
diff
changeset
|
125 |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
126 @item -L @var{dir} |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
127 @opindex -L |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
128 @itemx --directory=@var{dir} |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
129 @opindex --directory |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
130 Add directory @var{dir} to the variable @code{load-path}. |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
131 |
25829 | 132 @item -f @var{function} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
133 @opindex -f |
25829 | 134 @itemx --funcall=@var{function} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
135 @opindex --funcall |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
136 @cindex call Lisp functions, command-line argument |
52573
e219c98aa620
(Action Arguments): -f reads interactive args.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
137 Call Lisp function @var{function}. If it is an interactive function |
e219c98aa620
(Action Arguments): -f reads interactive args.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
138 (a command), it reads the arguments interactively just as if you had |
e219c98aa620
(Action Arguments): -f reads interactive args.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
139 called the same function with a key sequence. Otherwise, it calls the |
e219c98aa620
(Action Arguments): -f reads interactive args.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
140 function with no arguments. |
25829 | 141 |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
142 @item --eval=@var{expression} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
143 @opindex --eval |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
144 @itemx --execute=@var{expression} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
145 @opindex --execute |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
146 @cindex evaluate expression, command-line argument |
25829 | 147 Evaluate Lisp expression @var{expression}. |
148 | |
149 @item --insert=@var{file} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
150 @opindex --insert |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
151 @cindex insert file contents, command-line argument |
25829 | 152 Insert the contents of @var{file} into the current buffer. This is like |
153 what @kbd{M-x insert-file} does. @xref{Misc File Ops}. | |
154 | |
155 @item --kill | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
156 @opindex --kill |
25829 | 157 Exit from Emacs without asking for confirmation. |
158 | |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
159 @item --help |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
160 @opindex --help |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
161 Print a usage message listing all available options, then exit |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
162 successfully. |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
163 |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
164 @item --version |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
165 @opindex --version |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
166 Print Emacs version, then exit successfully. |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
167 @end table |
25829 | 168 |
169 @node Initial Options | |
170 @appendixsec Initial Options | |
171 | |
172 The initial options specify parameters for the Emacs session. This | |
173 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
|
174 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
|
175 sections. |
25829 | 176 |
177 Some initial options affect the loading of init files. The normal | |
178 actions of Emacs are to first load @file{site-start.el} if it exists, | |
179 then your own init file @file{~/.emacs} if it exists, and finally | |
59741
0e9b13ddeb6f
(Initial Options): Add a cross reference to `Init File'. Mention the
Lute Kamstra <lute@gnu.org>
parents:
58789
diff
changeset
|
180 @file{default.el} if it exists. @xref{Init File}. Certain options |
0e9b13ddeb6f
(Initial Options): Add a cross reference to `Init File'. Mention the
Lute Kamstra <lute@gnu.org>
parents:
58789
diff
changeset
|
181 prevent loading of some of these files or substitute other files for |
0e9b13ddeb6f
(Initial Options): Add a cross reference to `Init File'. Mention the
Lute Kamstra <lute@gnu.org>
parents:
58789
diff
changeset
|
182 them. |
25829 | 183 |
184 @table @samp | |
185 @item -t @var{device} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
186 @opindex -t |
25829 | 187 @itemx --terminal=@var{device} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
188 @opindex --terminal |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
189 @cindex device for Emacs terminal I/O |
25829 | 190 Use @var{device} as the device for terminal input and output. |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
191 @samp{--terminal} implies @samp{--no-window-system}. |
25829 | 192 |
193 @item -d @var{display} | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
194 @opindex -d |
25829 | 195 @itemx --display=@var{display} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
196 @opindex --display |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
197 @cindex display for Emacs frame |
25829 | 198 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
|
199 the initial Emacs frame. @xref{Display X}, for more details. |
25829 | 200 |
201 @item -nw | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
202 @opindex -nw |
40563
62cd2910ba80
(Initial Options): Document command line option --no-window-system instead
Pavel Janík <Pavel@Janik.cz>
parents:
40524
diff
changeset
|
203 @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
|
204 @opindex --no-window-system |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
205 @cindex disable window system |
33012
df207c5f631f
(Colors X): Document support for -fg, -bg, and -rv
Eli Zaretskii <eliz@gnu.org>
parents:
31169
diff
changeset
|
206 Don't communicate directly with the window system, disregarding the |
40652 | 207 @env{DISPLAY} environment variable even if it is set. This means that |
208 Emacs uses the terminal from which it was launched for all its display | |
209 and input. | |
25829 | 210 |
211 @need 3000 | |
212 @cindex batch mode | |
213 @item -batch | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
214 @opindex --batch |
25829 | 215 @itemx --batch |
58751
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
216 Run Emacs in @dfn{batch mode}. Batch mode is used for running |
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
217 programs written in Emacs Lisp from shell scripts, makefiles, and so |
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
218 on. You should also use the @samp{-l} option or @samp{-f} option, to |
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
219 invoke a Lisp program to do batch processing. |
25829 | 220 |
58751
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
221 In batch mode, Emacs does not display the text being edited, and the |
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
222 standard terminal interrupt characters such as @kbd{C-z} and @kbd{C-c} |
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
223 continue to have their normal effect. The functions @code{prin1}, |
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
224 @code{princ} and @code{print} output to @code{stdout} instead of the |
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
225 echo area, while @code{message} and error messages output to |
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
226 @code{stderr}. Functions that would normally read from the minibuffer |
0cb8dbb527b9
(Initial Options): Clarify batch mode i/o.
Richard M. Stallman <rms@gnu.org>
parents:
56813
diff
changeset
|
227 take their input from @code{stdin} instead. |
25829 | 228 |
59948
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
229 @samp{--batch} implies @samp{-q} (do not load an init file), but |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
230 @file{site-start.el} is loaded nonetheless. It also causes Emacs to |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
231 exit after processing all the command options. In addition, it |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
232 disables auto-saving except in buffers for which it has been |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
233 explicitly requested. |
25829 | 234 |
47323 | 235 @item --script @var{file} |
236 @opindex --script | |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
237 @cindex script mode |
47323 | 238 Run Emacs in batch mode, like @samp{--batch}, and then read and |
239 execute the Lisp code in @var{file}. | |
240 | |
241 The normal use of this option is in executable script files that run | |
242 Emacs. They can start with this text on the first line | |
243 | |
244 @example | |
245 #!/usr/bin/emacs --script | |
246 @end example | |
247 | |
248 @noindent | |
249 which will invoke Emacs with @samp{--script} and supply the name of | |
250 the script file as @var{file}. Emacs Lisp then treats @samp{#!} as a | |
251 comment delimiter. | |
252 | |
25829 | 253 @item -q |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
254 @opindex -q |
25829 | 255 @itemx --no-init-file |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
256 @opindex --no-init-file |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
257 @cindex bypassing init and @file{default.el} file |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
258 @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
|
259 @cindex @file{default.el} file, not loading |
25829 | 260 Do not load your Emacs init file @file{~/.emacs}, or @file{default.el} |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
261 either. Regardless of this switch, @file{site-start.el} is still loaded. |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
262 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
|
263 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
|
264 @xref{Easy Customization}. |
25829 | 265 |
266 @item --no-site-file | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
267 @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
|
268 @cindex @file{site-start.el} file, not loading |
25829 | 269 Do not load @file{site-start.el}. The options @samp{-q}, @samp{-u} |
59741
0e9b13ddeb6f
(Initial Options): Add a cross reference to `Init File'. Mention the
Lute Kamstra <lute@gnu.org>
parents:
58789
diff
changeset
|
270 and @samp{--batch} have no effect on the loading of this file---this |
0e9b13ddeb6f
(Initial Options): Add a cross reference to `Init File'. Mention the
Lute Kamstra <lute@gnu.org>
parents:
58789
diff
changeset
|
271 option and @samp{-Q} are the only options that block it. |
25829 | 272 |
54899 | 273 @item -Q |
274 @opindex -Q | |
61467
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
275 @itemx --quick |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
276 @opindex --quick |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
277 Start emacs with minimum customizations. This is like using @samp{-q} |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
278 and @samp{--no-site-file}, but also disables the startup screen. |
54899 | 279 |
45532 | 280 @item --no-splash |
281 @opindex --no-splash | |
45531
8873fff421e7
*** empty log message ***
Colin Walters <walters@gnu.org>
parents:
44326
diff
changeset
|
282 @vindex inhibit-startup-message |
45875
a4199c98c1eb
Document inhibit-startup-buffer-menu.
Richard M. Stallman <rms@gnu.org>
parents:
45532
diff
changeset
|
283 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
|
284 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
|
285 |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
286 @item --no-desktop |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
287 @opindex --no-desktop |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
288 Do not reload any saved desktop. @xref{Saving Emacs Sessions}. |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
289 |
25829 | 290 @item -u @var{user} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
291 @opindex -u |
25829 | 292 @itemx --user=@var{user} |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
293 @opindex --user |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
294 @cindex load init file of another user |
25829 | 295 Load @var{user}'s Emacs init file @file{~@var{user}/.emacs} instead of |
70392
410da5f62040
(Initial Options): Add a footnote about limited support of ~USER on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents:
70355
diff
changeset
|
296 your own@footnote{ |
410da5f62040
(Initial Options): Add a footnote about limited support of ~USER on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents:
70355
diff
changeset
|
297 This option has no effect on MS-Windows.}. |
25829 | 298 |
299 @item --debug-init | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
300 @opindex --debug-init |
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
301 @cindex errors in init file |
25829 | 302 Enable the Emacs Lisp debugger for errors in the init file. |
60229
dd4499d17ce0
(Initial Options): Add cross reference.
Lute Kamstra <lute@gnu.org>
parents:
59958
diff
changeset
|
303 @xref{Error Debugging,, Entering the Debugger on an Error, elisp, The |
dd4499d17ce0
(Initial Options): Add cross reference.
Lute Kamstra <lute@gnu.org>
parents:
59958
diff
changeset
|
304 GNU Emacs Lisp Reference Manual}. |
25829 | 305 |
306 @item --unibyte | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
307 @opindex --unibyte |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
308 @itemx --no-multibyte |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
309 @opindex --no-multibyte |
31142
7d0a8b91a6c0
Mention that Lisp files are normally read as multibyte.
Eli Zaretskii <eliz@gnu.org>
parents:
30967
diff
changeset
|
310 @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
|
311 Do almost everything with single-byte buffers and strings. |
25829 | 312 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
|
313 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
|
314 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
|
315 specified; see @ref{Enabling Multibyte}.) Setting the environment |
59948
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
316 variable @env{EMACS_UNIBYTE} has the same effect |
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
317 (@pxref{General Variables}). |
25829 | 318 |
319 @item --multibyte | |
37451
ff30b541575a
Add @opindex entries to index all command-line options.
Eli Zaretskii <eliz@gnu.org>
parents:
37425
diff
changeset
|
320 @opindex --multibyte |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
321 @itemx --no-unibyte |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
322 @opindex --no-unibyte |
29107 | 323 Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs |
25829 | 324 uses multibyte characters by default, as usual. |
325 @end table | |
326 | |
327 @node Command Example | |
328 @appendixsec Command Argument Example | |
329 | |
330 Here is an example of using Emacs with arguments and options. It | |
331 assumes you have a Lisp program file called @file{hack-c.el} which, when | |
332 loaded, performs some useful operation on the current buffer, expected | |
333 to be a C program. | |
334 | |
335 @example | |
59948
5f19af15e990
(Emacs Invocation): +LINENUM is also an option.
Richard M. Stallman <rms@gnu.org>
parents:
59928
diff
changeset
|
336 emacs --batch foo.c -l hack-c -f save-buffer >& log |
25829 | 337 @end example |
338 | |
339 @noindent | |
340 This says to visit @file{foo.c}, load @file{hack-c.el} (which makes | |
341 changes in the visited file), save @file{foo.c} (note that | |
342 @code{save-buffer} is the function that @kbd{C-x C-s} is bound to), and | |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
343 then exit back to the shell (because of @samp{--batch}). @samp{--batch} |
25829 | 344 also guarantees there will be no problem redirecting output to |
345 @file{log}, because Emacs will not assume that it has a display terminal | |
346 to work with. | |
347 | |
348 @node Resume Arguments | |
349 @appendixsec Resuming Emacs with Arguments | |
350 | |
351 You can specify action arguments for Emacs when you resume it after | |
352 a suspension. To prepare for this, put the following code in your | |
353 @file{.emacs} file (@pxref{Hooks}): | |
354 | |
37835
a4f04496cfb0
Update description of visiting multiple files with the command line.
Richard M. Stallman <rms@gnu.org>
parents:
37796
diff
changeset
|
355 @c `resume-suspend-hook' is correct. It is the name of a function. |
25829 | 356 @example |
357 (add-hook 'suspend-hook 'resume-suspend-hook) | |
358 (add-hook 'suspend-resume-hook 'resume-process-args) | |
359 @end example | |
360 | |
361 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
|
362 @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
|
363 (if you use bash as your shell). These scripts define an alias named |
25829 | 364 @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
|
365 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
|
366 @file{etc} subdirectory of the Emacs distribution. |
25829 | 367 |
368 Only action arguments work properly when you resume Emacs. Initial | |
369 arguments are not recognized---it's too late to execute them anyway. | |
370 | |
371 Note that resuming Emacs (with or without arguments) must be done from | |
372 within the shell that is the parent of the Emacs job. This is why | |
373 @code{edit} is an alias rather than a program or a shell script. It is | |
374 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
|
375 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
|
376 be made the value of @env{EDITOR}, for example. Therefore, this feature |
25829 | 377 does not take the place of the Emacs Server feature (@pxref{Emacs |
378 Server}). | |
379 | |
380 The aliases use the Emacs Server feature if you appear to have a | |
381 server Emacs running. However, they cannot determine this with complete | |
382 accuracy. They may think that a server is still running when in | |
383 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
|
384 @file{/tmp/esrv@dots{}} still exists. If this happens, find that |
25829 | 385 file and delete it. |
386 | |
387 @node Environment | |
388 @appendixsec Environment Variables | |
389 @cindex environment variables | |
390 | |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
391 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
|
392 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
|
393 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
|
394 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
|
395 letters only. The values are all text strings. |
25829 | 396 |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
397 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
|
398 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
|
399 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
|
400 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
|
401 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
|
402 software) inherit the environment from Emacs, too. |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
403 |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
404 @findex setenv |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
405 @findex getenv |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
406 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
|
407 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
|
408 environment. (Environment variable substitutions with @samp{$} work |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
409 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
|
410 |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
411 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
|
412 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
|
413 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
|
414 to @samp{not very much} using Bash: |
25829 | 415 |
416 @example | |
417 export ORGANIZATION="not very much" | |
418 @end example | |
419 | |
420 @noindent | |
421 and here's how to do it in csh or tcsh: | |
422 | |
423 @example | |
424 setenv ORGANIZATION "not very much" | |
425 @end example | |
426 | |
46202
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
427 When Emacs is using the X Window System, various environment |
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
428 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
|
429 documentation for more information. |
25829 | 430 |
431 @menu | |
432 * General Variables:: Environment variables that all versions of Emacs use. | |
433 * Misc Variables:: Certain system-specific variables. | |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
434 * MS-Windows Registry:: An alternative to the environment on MS-Windows. |
25829 | 435 @end menu |
436 | |
437 @node General Variables | |
438 @appendixsubsec General Variables | |
439 | |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
440 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
|
441 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
|
442 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
|
443 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
|
444 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
|
445 |
29107 | 446 @table @env |
36362
193e0fa6c140
(General Variables): Fix a typo in the CDPATH entry.
Eli Zaretskii <eliz@gnu.org>
parents:
36346
diff
changeset
|
447 @item CDPATH |
25829 | 448 Used by the @code{cd} command to search for the directory you specify, |
449 when you specify a relative directory name. | |
450 @item EMACS_UNIBYTE | |
31142
7d0a8b91a6c0
Mention that Lisp files are normally read as multibyte.
Eli Zaretskii <eliz@gnu.org>
parents:
30967
diff
changeset
|
451 @cindex unibyte operation, environment variable |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
452 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
|
453 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
|
454 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
|
455 invocation. @xref{Initial Options}. |
25829 | 456 @item EMACSDATA |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
457 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
|
458 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
|
459 @item EMACSDOC |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
460 Directory for the documentation string file, |
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
461 @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
|
462 variable @code{doc-directory}. |
25829 | 463 @item EMACSLOADPATH |
36364
fca71f0d9dc4
(General Variables): Add a footnote that all *PATH variables use
Eli Zaretskii <eliz@gnu.org>
parents:
36363
diff
changeset
|
464 A colon-separated list of directories@footnote{ |
60856
798f3b5ae20f
(General Variables): Put commas inside closequotes.
Richard M. Stallman <rms@gnu.org>
parents:
60400
diff
changeset
|
465 Here and below, whenever we say ``colon-separated list of directories,'' |
36364
fca71f0d9dc4
(General Variables): Add a footnote that all *PATH variables use
Eli Zaretskii <eliz@gnu.org>
parents:
36363
diff
changeset
|
466 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
|
467 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
|
468 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
|
469 to search for Emacs Lisp files---used to initialize @code{load-path}. |
25829 | 470 @item EMACSPATH |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
471 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
|
472 files---used to initialize @code{exec-path}. |
25829 | 473 @item ESHELL |
29107 | 474 Used for shell-mode to override the @env{SHELL} environment variable. |
25829 | 475 @item HISTFILE |
476 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
|
477 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
|
478 @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
|
479 otherwise. |
25829 | 480 @item HOME |
68687 | 481 The location of your files in the directory tree; used for |
64361
f6c51e5ebecd
(General Variables): Clarify the default location of $HOME on w32 systems.
Eli Zaretskii <eliz@gnu.org>
parents:
64352
diff
changeset
|
482 expansion of file names starting with a tilde (@file{~}). On MS-DOS, |
f6c51e5ebecd
(General Variables): Clarify the default location of $HOME on w32 systems.
Eli Zaretskii <eliz@gnu.org>
parents:
64352
diff
changeset
|
483 it defaults to the directory from which Emacs was started, with |
f6c51e5ebecd
(General Variables): Clarify the default location of $HOME on w32 systems.
Eli Zaretskii <eliz@gnu.org>
parents:
64352
diff
changeset
|
484 @samp{/bin} removed from the end if it was present. On Windows, the |
f6c51e5ebecd
(General Variables): Clarify the default location of $HOME on w32 systems.
Eli Zaretskii <eliz@gnu.org>
parents:
64352
diff
changeset
|
485 default value of @env{HOME} is the @file{Application Data} |
f6c51e5ebecd
(General Variables): Clarify the default location of $HOME on w32 systems.
Eli Zaretskii <eliz@gnu.org>
parents:
64352
diff
changeset
|
486 subdirectory of the user profile directory (normally, this is |
f6c51e5ebecd
(General Variables): Clarify the default location of $HOME on w32 systems.
Eli Zaretskii <eliz@gnu.org>
parents:
64352
diff
changeset
|
487 @file{C:/Documents and Settings/@var{username}/Application Data}, |
f6c51e5ebecd
(General Variables): Clarify the default location of $HOME on w32 systems.
Eli Zaretskii <eliz@gnu.org>
parents:
64352
diff
changeset
|
488 where @var{username} is your user name), though for backwards |
f6c51e5ebecd
(General Variables): Clarify the default location of $HOME on w32 systems.
Eli Zaretskii <eliz@gnu.org>
parents:
64352
diff
changeset
|
489 compatibility @file{C:/} will be used instead if a @file{.emacs} file |
f6c51e5ebecd
(General Variables): Clarify the default location of $HOME on w32 systems.
Eli Zaretskii <eliz@gnu.org>
parents:
64352
diff
changeset
|
490 is found there. |
25829 | 491 @item HOSTNAME |
492 The name of the machine that Emacs is running on. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47323
diff
changeset
|
493 @item INCPATH |
25829 | 494 A colon-separated list of directories. Used by the @code{complete} package |
495 to search for files. | |
496 @item INFOPATH | |
36295
1203ee52391f
(General Variables) <EMACSDOC>: It's used to
Gerd Moellmann <gerd@gnu.org>
parents:
36293
diff
changeset
|
497 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
|
498 @item LC_ALL |
37085
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
499 @itemx LC_COLLATE |
25829 | 500 @itemx LC_CTYPE |
37085
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
501 @itemx LC_MESSAGES |
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
502 @itemx LC_MONETARY |
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
503 @itemx LC_NUMERIC |
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
504 @itemx LC_TIME |
26140
068f7ad41d40
Describe new functions and variables for locales.
Paul Eggert <eggert@twinsun.com>
parents:
25829
diff
changeset
|
505 @itemx LANG |
37085
cce9b46e707b
(General Variables): Update the docs according to current behavior
Eli Zaretskii <eliz@gnu.org>
parents:
36875
diff
changeset
|
506 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
|
507 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
|
508 @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
|
509 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
|
510 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
|
511 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
|
512 @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
|
513 @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
|
514 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
|
515 |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
516 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
|
517 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
|
518 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
|
519 on some versions of MS-Windows. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
520 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
521 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
|
522 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
|
523 @code{locale-charset-language-names}, and |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
524 @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
|
525 environment and coding system. @xref{Language Environments}. |
25829 | 526 @item LOGNAME |
29107 | 527 The user's login name. See also @env{USER}. |
25829 | 528 @item MAIL |
68687 | 529 The name of your system mail inbox. |
25829 | 530 @item MH |
36146
885408f5ce84
New general discussion of the environment.
Richard M. Stallman <rms@gnu.org>
parents:
35490
diff
changeset
|
531 Name of setup file for the mh system. (The default is @file{~/.mh_profile}.) |
25829 | 532 @item NAME |
68687 | 533 Your real-world name. |
25829 | 534 @item NNTPSERVER |
36293
1bca8e306103
(General Variables): Remove description of
Gerd Moellmann <gerd@gnu.org>
parents:
36186
diff
changeset
|
535 The name of the news server. Used by the mh and Gnus packages. |
25829 | 536 @item ORGANIZATION |
537 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
|
538 `Organization:' header in your posts from the Gnus package. |
25829 | 539 @item PATH |
36364
fca71f0d9dc4
(General Variables): Add a footnote that all *PATH variables use
Eli Zaretskii <eliz@gnu.org>
parents:
36363
diff
changeset
|
540 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
|
541 is used to initialize the Emacs Lisp variable @code{exec-path}. |
25829 | 542 @item PWD |
543 If set, this should be the default directory when Emacs was started. | |
544 @item REPLYTO | |
545 If set, this specifies an initial value for the variable | |
546 @code{mail-default-reply-to}. @xref{Mail Headers}. | |
547 @item SAVEDIR | |
548 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
|
549 Used by the Gnus package. |
25829 | 550 @item SHELL |
551 The name of an interpreter used to parse and execute programs run from | |
552 inside Emacs. | |
49925
417d86de4023
Document SMTPSERVER environment variable.
Simon Josefsson <jas@extundo.com>
parents:
49600
diff
changeset
|
553 @item SMTPSERVER |
417d86de4023
Document SMTPSERVER environment variable.
Simon Josefsson <jas@extundo.com>
parents:
49600
diff
changeset
|
554 The name of the outgoing mail server. Used by the SMTP library |
71266
847ff9926f09
(General Variables): Fix smtpmail xref.
Eli Zaretskii <eliz@gnu.org>
parents:
70392
diff
changeset
|
555 (@pxref{Top,,,smtpmail,Sending mail via SMTP}). |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
556 @cindex background mode, on @command{xterm} |
25829 | 557 @item TERM |
38745 | 558 The type of the terminal that Emacs is using. This variable must be |
25829 | 559 set unless Emacs is run in batch mode. On MS-DOS, it defaults to |
560 @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
|
561 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
|
562 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
|
563 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
|
564 Emacs will choose colors that are appropriate for a light background. |
25829 | 565 @item TERMCAP |
566 The name of the termcap library file describing how to program the | |
29107 | 567 terminal specified by the @env{TERM} variable. This defaults to |
25829 | 568 @file{/etc/termcap}. |
569 @item TMPDIR | |
570 Used by the Emerge package as a prefix for temporary files. | |
571 @item TZ | |
36186
e391cbe3a2fe
Correction for TZ on Microsoft systems.
Richard M. Stallman <rms@gnu.org>
parents:
36146
diff
changeset
|
572 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
|
573 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
|
574 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
|
575 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
|
576 does not use @env{TZ} at all. |
25829 | 577 @item USER |
29107 | 578 The user's login name. See also @env{LOGNAME}. On MS-DOS, this |
25829 | 579 defaults to @samp{root}. |
580 @item VERSION_CONTROL | |
68538
2437cb336b92
(General Variables): Fix xref.
Richard M. Stallman <rms@gnu.org>
parents:
66053
diff
changeset
|
581 Used to initialize the @code{version-control} variable (@pxref{Numbered Backups}). |
25829 | 582 @end table |
583 | |
584 @node Misc Variables | |
585 @appendixsubsec Miscellaneous Variables | |
586 | |
587 These variables are used only on particular configurations: | |
588 | |
29107 | 589 @table @env |
25829 | 590 @item COMSPEC |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
591 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
|
592 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
|
593 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
|
594 variable. |
25829 | 595 |
596 @item NAME | |
29107 | 597 On MS-DOS, this variable defaults to the value of the @env{USER} |
25829 | 598 variable. |
599 | |
600 @item TEMP | |
601 @itemx TMP | |
36500
3dfa039c6a8c
Many typo-fixes and clarifications from Dr Francis J. Wright
Eli Zaretskii <eliz@gnu.org>
parents:
36364
diff
changeset
|
602 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
|
603 storing temporary files in. |
25829 | 604 |
605 @item EMACSTEST | |
606 On MS-DOS, this specifies a file to use to log the operation of the | |
607 internal terminal emulator. This feature is useful for submitting bug | |
608 reports. | |
609 | |
610 @item EMACSCOLORS | |
36502
3f0def4a4210
Minor cleanups. Rename `Motif Resources' node to `LessTif Resources'.
Richard M. Stallman <rms@gnu.org>
parents:
36500
diff
changeset
|
611 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
|
612 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
|
613 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
|
614 |
3f0def4a4210
Minor cleanups. Rename `Motif Resources' node to `LessTif Resources'.
Richard M. Stallman <rms@gnu.org>
parents:
36500
diff
changeset
|
615 The value of this variable should be the two-character encoding of the |
25829 | 616 foreground (the first character) and the background (the second |
617 character) colors of the default face. Each character should be the | |
618 hexadecimal code for the desired color on a standard PC text-mode | |
39267 | 619 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
|
620 specify @samp{EMACSCOLORS=17}, since 1 is the code of the blue color and |
39267 | 621 7 is the code of the light gray color. |
25829 | 622 |
623 The PC display usually supports only eight background colors. However, | |
624 Emacs switches the DOS display to a mode where all 16 colors can be used | |
625 for the background, so all four bits of the background color are | |
626 actually used. | |
627 | |
628 @item WINDOW_GFX | |
629 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
|
630 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
631 @item PRELOAD_WINSOCK |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
632 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
|
633 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
|
634 time it is required. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
635 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
636 @item emacs_dir |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
637 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
|
638 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
|
639 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
|
640 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
|
641 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
|
642 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
|
643 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
|
644 @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
|
645 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
|
646 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
|
647 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
|
648 changing any environment or registry settings. |
25829 | 649 @end table |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
650 |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
651 @node MS-Windows Registry |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
652 @appendixsubsec The MS-Windows System Registry |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
653 @pindex addpm, MS-Windows installation program |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
654 @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
|
655 |
71593 | 656 Under MS-Windows, the installation program @command{addpm.exe} adds |
657 values for @env{emacs_dir}, @env{EMACSLOADPATH}, @env{EMACSDATA}, | |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
658 @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
|
659 @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
|
660 @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
|
661 place to set environment variables across different versions of |
71593 | 662 Windows. Running @command{addpm.exe} is no longer strictly necessary |
663 in recent versions of Emacs, but if you are upgrading from an older | |
664 version, running @command{addpm.exe} ensures that you do not have | |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
665 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
|
666 compatible with the latest version of Emacs. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
667 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
668 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
|
669 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
|
670 and @env{PRELOAD_WINSOCK}. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
671 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
672 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
|
673 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
|
674 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
|
675 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
|
676 @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
|
677 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
|
678 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
|
679 |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
680 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
|
681 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
|
682 (@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
|
683 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
|
684 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
|
685 @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
|
686 override machine wide settings. |
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
687 |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
688 @node Display X |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47323
diff
changeset
|
689 @appendixsec Specifying the Display Name |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
690 @cindex display name (X Window System) |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
691 @cindex @env{DISPLAY} environment variable |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
692 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
693 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
|
694 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
|
695 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
|
696 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
|
697 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
|
698 remotely, displaying on your local screen. |
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 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
|
701 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
|
702 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
|
703 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
|
704 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
|
705 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
706 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
|
707 @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
|
708 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
|
709 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
|
710 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
|
711 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
|
712 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
|
713 included, @var{screen} is usually zero. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
714 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
715 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
|
716 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
|
717 @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
|
718 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
719 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
|
720 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
|
721 @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
|
722 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
723 @smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
724 emacs --display=glasperle:0 & |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
725 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
726 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
727 You can inhibit the direct use of the window system and GUI with the |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52702
diff
changeset
|
728 @samp{-nw} option. It tells Emacs to display using ordinary @acronym{ASCII} on |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
729 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
|
730 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
731 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
|
732 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
|
733 produces messages like this: |
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 @smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
736 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
|
737 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
738 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
739 @noindent |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
740 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
|
741 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
|
742 remote machine. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
743 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
744 @node Font X |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
745 @appendixsec Font Specification Options |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
746 @cindex font name (X Window System) |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
747 |
52613
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
748 By default, Emacs displays text in a twelve point Courier font (when |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
749 using X). You can specify a different font on your command line |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
750 through the option @samp{-fn @var{name}} (or @samp{--font}, which is |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
751 an alias for @samp{-fn}). |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
752 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
753 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
754 @item -fn @var{name} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
755 @opindex -fn |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
756 @itemx --font=@var{name} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
757 @opindex --font |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
758 @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
|
759 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
|
760 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
761 |
52613
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
762 Under X, each font has a long name which consists of fourteen words |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
763 or numbers, separated by dashes. Some fonts also have shorter |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
764 nicknames. For instance, @samp{9x15} is such a nickname. This font |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
765 makes each character nine pixels wide and fifteen pixels high. You |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
766 can use either kind of name. Case is insignificant in both kinds. |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
767 You can use wildcard patterns for the font name; then Emacs lets X |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
768 choose one of the fonts that match the pattern. The wildcard |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
769 character @samp{*} matches any sequence of characters (including none) |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
770 and @samp{?} matches any single character. However, matching is |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
771 implementation-dependent, and can be inaccurate when wildcards match |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
772 dashes in a long name. For reliable results, supply all 14 dashes and |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
773 use wildcards only within a field. Here is an example, which happens |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
774 to specify the font whose nickname is @samp{6x13}: |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
775 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
776 @smallexample |
44326 | 777 emacs -fn \ |
778 "-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
|
779 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
780 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
781 @noindent |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
782 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
|
783 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
784 @smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
785 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
|
786 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
787 |
52613
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
788 Note that if you use a wildcard pattern on the command line, you |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
789 need to enclose it in single or double quotes, to prevent the shell |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
790 from accidentally expanding it into a list of file names. On the |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
791 other hand, you should not quote the name in the @file{.Xdefaults} |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
792 file. |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
793 |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
794 The default font used by Emacs (under X) is: |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
795 |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
796 @smallexample |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
797 -adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1 |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
798 @end smallexample |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
799 |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
800 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
|
801 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
802 @smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
803 -@var{maker}-@var{family}-@var{weight}-@var{slant}-@var{widthtype}-@var{style}@dots{} |
52613
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
804 @dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{registry}-@var{encoding} |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
805 @end smallexample |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
806 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
807 @table @var |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
808 @item maker |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
809 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
|
810 @item family |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
811 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
|
812 @item weight |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
813 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
|
814 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
|
815 @item slant |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
816 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
|
817 @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
|
818 @item widthtype |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
819 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
|
820 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
|
821 @item style |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
822 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
|
823 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
|
824 @item pixels |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
825 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
|
826 @item height |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
827 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
|
828 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
|
829 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
|
830 @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
|
831 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
|
832 @item horiz |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
833 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
|
834 which the font is intended. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
835 @item vert |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
836 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
|
837 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
|
838 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
|
839 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
|
840 @item spacing |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
841 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
|
842 (character cell). |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
843 @item width |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
844 This is the average character width, in pixels, multiplied by ten. |
52613
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
845 @item registry |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
846 @itemx encoding |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
847 These together make up the X font character set that the font depicts. |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
848 (X font character sets are not the same as Emacs charsets, but they |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
849 are solutions for the same problem.) You can use the |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
850 @command{xfontsel} program to check which choices you have. However, |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
851 normally you should use @samp{iso8859} for @var{registry} and @samp{1} |
b9d9fbfea220
(Font X): Mention new default font. More fully describe long font
Luc Teirlinck <teirllm@auburn.edu>
parents:
52573
diff
changeset
|
852 for @var{encoding}. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
853 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
854 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
855 @cindex listing system fonts |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
856 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
|
857 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
|
858 @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
|
859 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
|
860 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
|
861 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
862 @example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
863 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
|
864 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*' |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
865 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*' |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
866 @end example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
867 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
868 @noindent |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
869 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
|
870 For example: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
871 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
872 @example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
873 xfd -fn 6x13 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
874 @end example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
875 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
876 @noindent |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
877 displays the entire font @samp{6x13}. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
878 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
879 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
|
880 (@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
|
881 (@pxref{Faces}). |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
882 |
42750
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
883 @node Colors |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
884 @appendixsec Window Color Options |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
885 @cindex color of window |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
886 @cindex text colors, from command line |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
887 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
888 @findex list-colors-display |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
889 @cindex available colors |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
890 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
|
891 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
|
892 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
|
893 @kbd{C-Mouse-2} and select @samp{Display Colors} from the pop-up menu. |
59928
99e841fd7de9
(Colors): Mention 16-, 88- and 256-color modes.
Eli Zaretskii <eliz@gnu.org>
parents:
59741
diff
changeset
|
894 (A particular window system might support many more colors, but the |
99e841fd7de9
(Colors): Mention 16-, 88- and 256-color modes.
Eli Zaretskii <eliz@gnu.org>
parents:
59741
diff
changeset
|
895 list displayed by @code{list-colors-display} shows their portable |
99e841fd7de9
(Colors): Mention 16-, 88- and 256-color modes.
Eli Zaretskii <eliz@gnu.org>
parents:
59741
diff
changeset
|
896 subset that can be safely used on any display supported by Emacs.) |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
897 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
|
898 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
|
899 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
|
900 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
|
901 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
|
902 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
903 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
|
904 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
905 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
906 @item -fg @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
907 @opindex -fg |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
908 @itemx --foreground-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
909 @opindex --foreground-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
910 @cindex foreground color, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
911 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
|
912 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
|
913 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
|
914 @item -bg @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
915 @opindex -bg |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
916 @itemx --background-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
917 @opindex --background-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
918 @cindex background color, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
919 Specify the background color. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
920 @item -bd @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
921 @opindex -bd |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
922 @itemx --border-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
923 @opindex --border-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
924 @cindex border color, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
925 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
|
926 @item -cr @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
927 @opindex -cr |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
928 @itemx --cursor-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
929 @opindex --cursor-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
930 @cindex cursor color, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
931 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
|
932 @item -ms @var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
933 @opindex -ms |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
934 @itemx --mouse-color=@var{color} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
935 @opindex --mouse-color |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
936 @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
|
937 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
|
938 @item -r |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
939 @opindex -r |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
940 @itemx -rv |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
941 @opindex -rv |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
942 @itemx --reverse-video |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
943 @opindex --reverse-video |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
944 @cindex reverse video, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
945 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
|
946 @item --color=@var{mode} |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
947 @opindex --color |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
948 @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
|
949 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
|
950 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
|
951 @table @samp |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
952 @item never |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
953 @itemx no |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
954 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
|
955 support. |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
956 @item default |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
957 @itemx auto |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
958 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
|
959 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
|
960 colored display. |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
961 @item always |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
962 @itemx yes |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
963 @itemx ansi8 |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
964 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
|
965 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
|
966 @item @var{num} |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
967 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
|
968 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
|
969 default color support for this terminal (equivalent to @samp{auto}); |
59928
99e841fd7de9
(Colors): Mention 16-, 88- and 256-color modes.
Eli Zaretskii <eliz@gnu.org>
parents:
59741
diff
changeset
|
970 otherwise use an appropriate standard mode for @var{num} colors. |
99e841fd7de9
(Colors): Mention 16-, 88- and 256-color modes.
Eli Zaretskii <eliz@gnu.org>
parents:
59741
diff
changeset
|
971 Depending on your terminal's capabilities, Emacs might be able to turn |
99e841fd7de9
(Colors): Mention 16-, 88- and 256-color modes.
Eli Zaretskii <eliz@gnu.org>
parents:
59741
diff
changeset
|
972 on a color mode for 8, 16, 88, or 256 as the value of @var{num}. If |
42750
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
973 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
|
974 @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
|
975 mode. |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
976 @end table |
671f1c59f989
(Colors): Rename from "Colors X". All cross-references changed.
Eli Zaretskii <eliz@gnu.org>
parents:
42712
diff
changeset
|
977 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
|
978 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
979 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
980 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
|
981 enter: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
982 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
983 @example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
984 emacs -ms coral -cr 'slate blue' & |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
985 @end example |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
986 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
987 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
|
988 @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
|
989 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
990 The @samp{-fg}, @samp{-bg}, and @samp{-rv} options function on |
68687 | 991 text-only terminals as well as on graphical displays. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
992 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
993 @node Window Size X |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
994 @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
|
995 @cindex geometry of Emacs window |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
996 @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
|
997 @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
|
998 @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
|
999 |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1000 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
|
1001 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
|
1002 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1003 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1004 @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
|
1005 @opindex -g |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1006 @itemx --geometry=@var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]} |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1007 @opindex --geometry |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1008 @cindex geometry, command-line argument |
46202
abfe123bd6ff
setenv allows $-substitution.
Richard M. Stallman <rms@gnu.org>
parents:
45933
diff
changeset
|
1009 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
|
1010 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
|
1011 (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
|
1012 |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1013 @item -fs |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1014 @opindex -fs |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1015 @itemx --fullscreen |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1016 @opindex --fullscreen |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1017 @cindex fullscreen, command-line argument |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1018 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
|
1019 |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1020 @item -fh |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1021 @opindex -fh |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1022 @itemx --fullheight |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1023 @opindex --fullheight |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1024 @cindex fullheight, command-line argument |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1025 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
|
1026 |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1027 @item -fw |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1028 @opindex -fw |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1029 @itemx --fullwidth |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1030 @opindex --fullwidth |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1031 @cindex fullwidth, command-line argument |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1032 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
|
1033 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1034 |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1035 |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1036 @noindent |
42712
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1037 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
|
1038 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
|
1039 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
|
1040 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
|
1041 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
|
1042 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
|
1043 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
|
1044 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
|
1045 |
45933
8f591d9d9080
Add MS-Windows specific docs for envvars
Jason Rumney <jasonr@gnu.org>
parents:
45875
diff
changeset
|
1046 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
|
1047 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
|
1048 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
|
1049 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
|
1050 @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
|
1051 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1052 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
|
1053 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
|
1054 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
|
1055 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
|
1056 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
|
1057 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
|
1058 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1059 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
|
1060 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
|
1061 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
|
1062 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
|
1063 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
|
1064 @samp{x45} specifies just the height. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1065 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1066 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
|
1067 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
|
1068 @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
|
1069 @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
|
1070 @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
|
1071 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1072 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
|
1073 @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
|
1074 @samp{--geometry} option. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1075 |
46717
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1076 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
|
1077 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
|
1078 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
|
1079 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
|
1080 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
|
1081 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
|
1082 |
46717
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1083 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
|
1084 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
|
1085 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
|
1086 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
|
1087 @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
|
1088 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
|
1089 size with no tool bar, use an X resource to specify ``no tool bar'' |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1090 (@pxref{Table of Resources}); then Emacs will already know there's no |
46717
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1091 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
|
1092 |
505956923015
Explain how enabling or disabling the tool bar affects specified geometry.
Richard M. Stallman <rms@gnu.org>
parents:
46202
diff
changeset
|
1093 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
|
1094 @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
|
1095 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
|
1096 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
|
1097 |
dced9cd23927
(Window Size X): Document the new full-screen options.
Eli Zaretskii <eliz@gnu.org>
parents:
41374
diff
changeset
|
1098 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
|
1099 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
|
1100 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
|
1101 |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1102 @node Borders X |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1103 @appendixsec Internal and External Borders |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1104 @cindex borders (X Window System) |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1105 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1106 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
|
1107 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
|
1108 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
|
1109 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
|
1110 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
|
1111 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
|
1112 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1113 @table @samp |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1114 @item -ib @var{width} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1115 @opindex -ib |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1116 @itemx --internal-border=@var{width} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1117 @opindex --internal-border |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1118 @cindex internal border width, command-line argument |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1119 Specify @var{width} as the width of the internal border (between the text |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1120 and the main border), in pixels. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1121 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1122 @item -bw @var{width} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1123 @opindex -bw |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1124 @itemx --border-width=@var{width} |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1125 @opindex --border-width |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1126 @cindex main border width, command-line argument |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1127 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
|
1128 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1129 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1130 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
|
1131 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
|
1132 external border. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1133 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1134 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
|
1135 @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
|
1136 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
|
1137 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
|
1138 external border is 2. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1139 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1140 @node Title X |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1141 @appendixsec Frame Titles |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1142 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1143 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
|
1144 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
|
1145 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
|
1146 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
|
1147 (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
|
1148 there is more than one frame). |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1149 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1150 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
|
1151 line option: |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1152 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1153 @table @samp |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1154 @item -T @var{title} |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1155 @opindex -T |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1156 @itemx --title=@var{title} |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1157 @opindex --title |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1158 @cindex frame title, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1159 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
|
1160 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1161 |
41374
608e18d9fb18
Fix cross-references to "Resources".
Eli Zaretskii <eliz@gnu.org>
parents:
41369
diff
changeset
|
1162 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
|
1163 for the initial Emacs frame. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1164 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1165 @node Icons X |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1166 @appendixsec Icons |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1167 @cindex icons (X Window System) |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1168 |
68687 | 1169 Most window managers allow you to ``iconify'' a frame, removing |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1170 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
|
1171 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
|
1172 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
|
1173 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
|
1174 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1175 @table @samp |
65979 | 1176 @item -nbi |
1177 @opindex -nbi | |
65939
ba4c1a7f880b
* cmdargs.texi (Icons X): Removed options -i, -itype, --icon-type,
Jan Djärv <jan.h.d@swipnet.se>
parents:
64890
diff
changeset
|
1178 @itemx --no-bitmap-icon |
ba4c1a7f880b
* cmdargs.texi (Icons X): Removed options -i, -itype, --icon-type,
Jan Djärv <jan.h.d@swipnet.se>
parents:
64890
diff
changeset
|
1179 @opindex --no-bitmap-icon |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1180 @cindex Emacs icon, a gnu |
65939
ba4c1a7f880b
* cmdargs.texi (Icons X): Removed options -i, -itype, --icon-type,
Jan Djärv <jan.h.d@swipnet.se>
parents:
64890
diff
changeset
|
1181 Do not use a picture of a gnu as the Emacs icon. |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1182 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1183 @item -iconic |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1184 @opindex --iconic |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1185 @itemx --iconic |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1186 @cindex start iconified, command-line argument |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1187 Start Emacs in iconified state. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1188 @end table |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1189 |
65939
ba4c1a7f880b
* cmdargs.texi (Icons X): Removed options -i, -itype, --icon-type,
Jan Djärv <jan.h.d@swipnet.se>
parents:
64890
diff
changeset
|
1190 By default Emacs uses an icon window containing a picture of the GNU gnu. |
66053
824d0114e769
* cmdargs.texi (Icons X): Fix typo.
Jan Djärv <jan.h.d@swipnet.se>
parents:
65979
diff
changeset
|
1191 The @samp{-nbi} or @samp{--no-bitmap-icon} option tells Emacs to let the |
41369
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1192 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
|
1193 rectangle containing the frame's title. |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1194 |
72709f10af2b
Some nodes moved back from xresources.texi.
Richard M. Stallman <rms@gnu.org>
parents:
40652
diff
changeset
|
1195 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
|
1196 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
|
1197 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
|
1198 appear until you deiconify it. |
52401 | 1199 |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1200 @node Misc X |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1201 @appendixsec Other Display Options |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1202 |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1203 @table @samp |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1204 @item -hb |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1205 @opindex -hb |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1206 @itemx --horizontal-scroll-bars |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1207 @opindex --horizontal-scroll-bars |
61220
969c63f59860
(Misc X): Explain horizontal scroll bars don't exist.
Richard M. Stallman <rms@gnu.org>
parents:
60856
diff
changeset
|
1208 @c @cindex horizontal scroll bars, command-line argument |
969c63f59860
(Misc X): Explain horizontal scroll bars don't exist.
Richard M. Stallman <rms@gnu.org>
parents:
60856
diff
changeset
|
1209 Enable horizontal scroll bars. Since horizontal scroll bars |
969c63f59860
(Misc X): Explain horizontal scroll bars don't exist.
Richard M. Stallman <rms@gnu.org>
parents:
60856
diff
changeset
|
1210 are not yet implemented, this actually does nothing. |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1211 |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1212 @item -vb |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1213 @opindex -vb |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1214 @itemx --vertical-scroll-bars |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1215 @opindex --vertical-scroll-bars |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1216 @cindex vertical scroll bars, command-line argument |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1217 Enable vertical scroll bars. |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1218 |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1219 @item -lsp @var{pixels} |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1220 @opindex -lsp |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1221 @itemx --line-spacing=@var{pixels} |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1222 @opindex --line-spacing |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1223 @cindex line spacing, command-line argument |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1224 Specify @var{pixels} as additional space to put between lines, in pixels. |
60400
616254f1bdb6
(Emacs Invocation): Add cindex "invocation (command line arguments)"
Juri Linkov <juri@jurta.org>
parents:
60229
diff
changeset
|
1225 |
616254f1bdb6
(Emacs Invocation): Add cindex "invocation (command line arguments)"
Juri Linkov <juri@jurta.org>
parents:
60229
diff
changeset
|
1226 @item -nbc |
616254f1bdb6
(Emacs Invocation): Add cindex "invocation (command line arguments)"
Juri Linkov <juri@jurta.org>
parents:
60229
diff
changeset
|
1227 @opindex -nbc |
616254f1bdb6
(Emacs Invocation): Add cindex "invocation (command line arguments)"
Juri Linkov <juri@jurta.org>
parents:
60229
diff
changeset
|
1228 @itemx --no-blinking-cursor |
616254f1bdb6
(Emacs Invocation): Add cindex "invocation (command line arguments)"
Juri Linkov <juri@jurta.org>
parents:
60229
diff
changeset
|
1229 @opindex --no-blinking-cursor |
616254f1bdb6
(Emacs Invocation): Add cindex "invocation (command line arguments)"
Juri Linkov <juri@jurta.org>
parents:
60229
diff
changeset
|
1230 @cindex blinking cursor disable, command-line argument |
70355
3bc0f01a04e8
(Misc X): Say "graphical displays".
Richard M. Stallman <rms@gnu.org>
parents:
69945
diff
changeset
|
1231 Disable the blinking cursor on graphical displays. |
61467
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
1232 |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
1233 @item -D |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
1234 @opindex -D |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
1235 @itemx --basic-display |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
1236 @opindex --basic-display |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
1237 Disable the menu-bar, the tool-bar, the scroll-bars, and tool tips, |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
1238 and turn off the blinking cursor. This can be useful for making a |
a3e6e523bd06
(Initial Options): -Q is now --quick, and does less.
Richard M. Stallman <rms@gnu.org>
parents:
61348
diff
changeset
|
1239 test case that simplifies debugging of display problems. |
54096
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1240 @end table |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1241 |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1242 The @samp{--xrm} option (@pxref{Resources}) specifies additional |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1243 X resource values. |
721c4c4b537b
(Action Arguments): Add alias --find-file. Add
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52979
diff
changeset
|
1244 |
52401 | 1245 @ignore |
1246 arch-tag: fffecd9e-7329-4a51-a3cc-dd4a9889340e | |
1247 @end ignore |