Rename `autoselect-window' to `mouse-autoselect-window'.
[emacs.git] / man / cmdargs.texi
blob5d5497499c0b1cdd0f961bdaa320a714361b4638
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985,86,87,93,94,95,1997,2001 Free Software Foundation, Inc.
3 @c See file emacs.texi for copying conditions.
4 @node Command Arguments, X Resources, Service, Top
5 @appendix Command Line Arguments
6 @cindex command line arguments
7 @cindex arguments (command line)
8 @cindex options (command line)
9 @cindex switches (command line)
10 @cindex startup (command line arguments)
12   GNU Emacs supports command line arguments to request various actions
13 when invoking Emacs.  These are for compatibility with other editors and
14 for sophisticated activities.  We don't recommend using them for
15 ordinary editing.
17   Arguments starting with @samp{-} are @dfn{options}.  Other arguments
18 specify files to visit.  Emacs visits the specified files while it
19 starts up.  The last file name on your command line becomes the
20 current buffer; the other files are also visited in other buffers.  If
21 there are two files, they are both displayed; otherwise the last file
22 is displayed along with a buffer list that shows what other buffers
23 there are.  As with most programs, the special argument @samp{--} says
24 that all subsequent arguments are file names, not options, even if
25 they start with @samp{-}.
27   Emacs command options can specify many things, such as the size and
28 position of the X window Emacs uses, its colors, and so on.  A few
29 options support advanced usage, such as running Lisp functions on files
30 in batch mode.  The sections of this chapter describe the available
31 options, arranged according to their purpose.
33   There are two ways of writing options: the short forms that start with
34 a single @samp{-}, and the long forms that start with @samp{--}.  For
35 example, @samp{-d} is a short form and @samp{--display} is the
36 corresponding long form.
38   The long forms with @samp{--} are easier to remember, but longer to
39 type.  However, you don't have to spell out the whole option name; any
40 unambiguous abbreviation is enough.  When a long option takes an
41 argument, you can use either a space or an equal sign to separate the
42 option name and the argument.  Thus, you can write either
43 @samp{--display sugar-bombs:0.0} or @samp{--display=sugar-bombs:0.0}.
44 We recommend an equal sign because it makes the relationship clearer,
45 and the tables below always show an equal sign.
47 @cindex initial options (command line)
48 @cindex action options (command line)
49   Most options specify how to initialize Emacs, or set parameters for
50 the Emacs session.  We call them @dfn{initial options}.  A few options
51 specify things to do: for example, load libraries, call functions, or
52 terminate Emacs.  These are called @dfn{action options}.  These and file
53 names together are called @dfn{action arguments}.  Emacs processes all
54 the action arguments in the order they are written.
56 @menu
57 * Action Arguments::    Arguments to visit files, load libraries,
58                           and call functions.
59 * Initial Options::     Arguments that take effect while starting Emacs.
60 * Command Example::     Examples of using command line arguments.
61 * Resume Arguments::    Specifying arguments when you resume a running Emacs.
62 * Environment::         Environment variables that Emacs uses.
63 * Display X::           Changing the default display and using remote login.
64 * Font X::              Choosing a font for text, under X.
65 * Colors::              Choosing display colors.
66 * Window Size X::       Start-up window size, under X.
67 * Borders X::           Internal and external borders, under X.
68 * Title X::             Specifying the initial frame's title.
69 * Icons X::             Choosing what sort of icon to use, under X.
70 @end menu
72 @node Action Arguments
73 @appendixsec Action Arguments
75   Here is a table of the action arguments and options:
77 @table @samp
78 @item @var{file}
79 @opindex --visit
80 @itemx --visit=@var{file}
81 @opindex --file
82 @itemx --file=@var{file}
83 @cindex visiting files, command-line argument
84 Visit @var{file} using @code{find-file}.  @xref{Visiting}.
86 @item +@var{linenum} @var{file}
87 @opindex +@var{linenum}
88 Visit @var{file} using @code{find-file}, then go to line number
89 @var{linenum} in it.
91 @item +@var{linenum}:@var{columnnum} @var{file}
92 Visit @var{file} using @code{find-file}, then go to line number
93 @var{linenum} and put point at column number @var{columnnum}.
95 @need 3000
96 @item -l @var{file}
97 @opindex -l
98 @itemx --load=@var{file}
99 @opindex --load
100 @cindex loading Lisp libraries, command-line argument
101 Load a Lisp library named @var{file} with the function @code{load}.
102 @xref{Lisp Libraries}.  The library can be found either in the current
103 directory, or in the Emacs library search path as specified
104 with @env{EMACSLOADPATH} (@pxref{General Variables}).
106 @item -f @var{function}
107 @opindex -f
108 @itemx --funcall=@var{function}
109 @opindex --funcall
110 @cindex call Lisp functions, command-line argument
111 Call Lisp function @var{function} with no arguments.
113 @item --eval=@var{expression}
114 @opindex --eval
115 @itemx --execute=@var{expression}
116 @opindex --execute
117 @cindex evaluate expression, command-line argument
118 Evaluate Lisp expression @var{expression}.
120 @item --insert=@var{file}
121 @opindex --insert
122 @cindex insert file contents, command-line argument
123 Insert the contents of @var{file} into the current buffer.  This is like
124 what @kbd{M-x insert-file} does.  @xref{Misc File Ops}.
126 @item --kill
127 @opindex --kill
128 Exit from Emacs without asking for confirmation.
129 @end table
131 @vindex command-line-args
132   The init file can access the values of the action arguments as the
133 elements of a list in the variable @code{command-line-args}.  The init
134 file can override the normal processing of the action arguments, or
135 define new ones, by reading and setting this variable.
137 @node Initial Options
138 @appendixsec Initial Options
140   The initial options specify parameters for the Emacs session.  This
141 section describes the more general initial options; some other options
142 specifically related to the X Window System appear in the following
143 sections.
145   Some initial options affect the loading of init files.  The normal
146 actions of Emacs are to first load @file{site-start.el} if it exists,
147 then your own init file @file{~/.emacs} if it exists, and finally
148 @file{default.el} if it exists; certain options prevent loading of some
149 of these files or substitute other files for them.
151 @table @samp
152 @item -t @var{device}
153 @opindex -t
154 @itemx --terminal=@var{device}
155 @opindex --terminal
156 @cindex device for Emacs terminal I/O
157 Use @var{device} as the device for terminal input and output.
159 @item -d @var{display}
160 @opindex -d
161 @itemx --display=@var{display}
162 @opindex --display
163 @cindex display for Emacs frame
164 Use the X Window System and use the display named @var{display} to open
165 the initial Emacs frame.  @xref{Display X}, for more details.
167 @item -nw
168 @opindex -nw
169 @itemx --no-window-system
170 @opindex --no-window-system
171 @cindex disable window system
172 Don't communicate directly with the window system, disregarding the
173 @env{DISPLAY} environment variable even if it is set.  This means that
174 Emacs uses the terminal from which it was launched for all its display
175 and input.
177 @need 3000
178 @cindex batch mode
179 @item -batch
180 @opindex --batch
181 @itemx --batch
182 Run Emacs in @dfn{batch mode}, which means that the text being edited is
183 not displayed and the standard terminal interrupt characters such as
184 @kbd{C-z} and @kbd{C-c} continue to have their normal effect.  Emacs in
185 batch mode outputs to @code{stderr} only what would normally be displayed
186 in the echo area under program control, and functions which would
187 normally read from the minibuffer take their input from @code{stdin}.
189 Batch mode is used for running programs written in Emacs Lisp from
190 shell scripts, makefiles, and so on.  Normally the @samp{-l} option
191 or @samp{-f} option will be used as well, to invoke a Lisp program
192 to do the batch processing.
194 @samp{-batch} implies @samp{-q} (do not load an init file).  It also
195 causes Emacs to exit after processing all the command options.  In
196 addition, it disables auto-saving except in buffers for which it has
197 been explicitly requested.
199 @item -q
200 @opindex -q
201 @itemx --no-init-file
202 @opindex --no-init-file
203 @cindex bypassing init and site-start file
204 @cindex init file, not loading
205 @cindex @file{default.el} file, not loading
206 Do not load your Emacs init file @file{~/.emacs}, or @file{default.el}
207 either.  When invoked like this, Emacs does not allow saving options
208 changed with the @kbd{M-x customize} command and its variants.
209 @xref{Easy Customization}.
211 @item --no-site-file
212 @opindex --no-site-file
213 @cindex @file{site-start.el} file, not loading
214 Do not load @file{site-start.el}.  The options @samp{-q}, @samp{-u}
215 and @samp{-batch} have no effect on the loading of this file---this is
216 the only option that blocks it.
218 @item -u @var{user}
219 @opindex -u
220 @itemx --user=@var{user}
221 @opindex --user
222 @cindex load init file of another user
223 Load @var{user}'s Emacs init file @file{~@var{user}/.emacs} instead of
224 your own.
226 @item --debug-init
227 @opindex --debug-init
228 @cindex errors in init file
229 Enable the Emacs Lisp debugger for errors in the init file.
231 @item --unibyte
232 @opindex --unibyte
233 @cindex unibyte operation, command-line argument
234 Do almost everything with single-byte buffers and strings.
235 All buffers and strings are unibyte unless you (or a Lisp program)
236 explicitly ask for a multibyte buffer or string.  (Note that Emacs
237 always loads Lisp files in multibyte mode, even if @samp{--unibyte} is
238 specified; see @ref{Enabling Multibyte}.)  Setting the environment
239 variable @env{EMACS_UNIBYTE} has the same effect.
241 @item --multibyte
242 @opindex --multibyte
243 Inhibit the effect of @env{EMACS_UNIBYTE}, so that Emacs
244 uses multibyte characters by default, as usual.
245 @end table
247 @node Command Example
248 @appendixsec Command Argument Example
250   Here is an example of using Emacs with arguments and options.  It
251 assumes you have a Lisp program file called @file{hack-c.el} which, when
252 loaded, performs some useful operation on the current buffer, expected
253 to be a C program.
255 @example
256 emacs -batch foo.c -l hack-c -f save-buffer >& log
257 @end example
259 @noindent
260 This says to visit @file{foo.c}, load @file{hack-c.el} (which makes
261 changes in the visited file), save @file{foo.c} (note that
262 @code{save-buffer} is the function that @kbd{C-x C-s} is bound to), and
263 then exit back to the shell (because of @samp{-batch}).  @samp{-batch}
264 also guarantees there will be no problem redirecting output to
265 @file{log}, because Emacs will not assume that it has a display terminal
266 to work with.
268 @node Resume Arguments
269 @appendixsec Resuming Emacs with Arguments
271   You can specify action arguments for Emacs when you resume it after
272 a suspension.  To prepare for this, put the following code in your
273 @file{.emacs} file (@pxref{Hooks}):
275 @c `resume-suspend-hook' is correct.  It is the name of a function.
276 @example
277 (add-hook 'suspend-hook 'resume-suspend-hook)
278 (add-hook 'suspend-resume-hook 'resume-process-args)
279 @end example
281   As further preparation, you must execute the shell script
282 @file{emacs.csh} (if you use csh as your shell) or @file{emacs.bash}
283 (if you use bash as your shell).  These scripts define an alias named
284 @code{edit}, which will resume Emacs giving it new command line
285 arguments such as files to visit.  The scripts are found in the
286 @file{etc} subdirectory of the Emacs distribution.
288   Only action arguments work properly when you resume Emacs.  Initial
289 arguments are not recognized---it's too late to execute them anyway.
291   Note that resuming Emacs (with or without arguments) must be done from
292 within the shell that is the parent of the Emacs job.  This is why
293 @code{edit} is an alias rather than a program or a shell script.  It is
294 not possible to implement a resumption command that could be run from
295 other subjobs of the shell; there is no way to define a command that could
296 be made the value of @env{EDITOR}, for example.  Therefore, this feature
297 does not take the place of the Emacs Server feature (@pxref{Emacs
298 Server}).
300   The aliases use the Emacs Server feature if you appear to have a
301 server Emacs running.  However, they cannot determine this with complete
302 accuracy.  They may think that a server is still running when in
303 actuality you have killed that Emacs, because the file
304 @file{/tmp/esrv@dots{}} still exists.  If this happens, find that
305 file and delete it.
307 @node Environment
308 @appendixsec Environment Variables
309 @cindex environment variables
311   The @dfn{environment} is a feature of the operating system; it
312 consists of a collection of variables with names and values.  Each
313 variable is called an @dfn{environment variable}; environment variable
314 names are case-sensitive, and it is conventional to use upper case
315 letters only.  The values are all text strings.
317   What makes the environment useful is that subprocesses inherit the
318 environment automatically from their parent process.  This means you
319 can set up an environment variable in your login shell, and all the
320 programs you run (including Emacs) will automatically see it.
321 Subprocesses of Emacs (such as shells, compilers, and version-control
322 software) inherit the environment from Emacs, too.
324 @findex setenv
325 @findex getenv
326   Inside Emacs, the command @kbd{M-x getenv} gets the value of an
327 environment variable.  @kbd{M-x setenv} sets a variable in the Emacs
328 environment.  The way to set environment variables outside of Emacs
329 depends on the operating system, and especially the shell that you are
330 using.  For example, here's how to set the environment variable
331 @env{ORGANIZATION} to @samp{not very much} using Bash:
333 @example
334 export ORGANIZATION="not very much"
335 @end example
337 @noindent
338 and here's how to do it in csh or tcsh:
340 @example
341 setenv ORGANIZATION "not very much"
342 @end example
344   When Emacs is uses the X Window System, it inherits the use
345 of a large number of environment variables from the X libraries.  See
346 the X documentation for more information.
348 @menu
349 * General Variables::   Environment variables that all versions of Emacs use.
350 * Misc Variables::      Certain system-specific variables.
351 @end menu
353 @node General Variables
354 @appendixsubsec General Variables
356   Here is an alphabetical list of specific environment variables that
357 have special meanings in Emacs, giving the name of each variable and
358 its meaning.  Most of these variables are also used by some other
359 programs.  Emacs does not require any of these environment variables
360 to be set, but it uses their values if they are set.
362 @table @env
363 @item CDPATH
364 Used by the @code{cd} command to search for the directory you specify,
365 when you specify a relative directory name.
366 @item EMACS_UNIBYTE
367 @cindex unibyte operation, environment variable
368 Defining this environment variable with a nonempty value directs Emacs
369 to do almost everything with single-byte buffers and strings.  It is
370 equivalent to using the @samp{--unibyte} command-line option on each
371 invocation.  @xref{Initial Options}.
372 @item EMACSDATA
373 Directory for the architecture-independent files that come with Emacs.
374 This is used to initialize the Lisp variable @code{data-directory}.
375 @item EMACSDOC
376 Directory for the documentation string file,
377 @file{DOC-@var{emacsversion}}.  This is used to initialize the Lisp
378 variable @code{doc-directory}.
379 @item EMACSLOADPATH
380 A colon-separated list of directories@footnote{
381 Here and below, whenever we say ``colon-separated list of directories'',
382 it pertains to Unix and GNU/Linux systems.  On MS-DOS and MS-Windows,
383 the directories are separated by semi-colons instead, since DOS/Windows
384 file names might include a colon after a drive letter.}
385 to search for Emacs Lisp files---used to initialize @code{load-path}.
386 @item EMACSPATH
387 A colon-separated list of directories to search for executable
388 files---used to initialize @code{exec-path}.
389 @item ESHELL
390 Used for shell-mode to override the @env{SHELL} environment variable.
391 @item HISTFILE
392 The name of the file that shell commands are saved in between logins.
393 This variable defaults to @file{~/.bash_history} if you use Bash, to
394 @file{~/.sh_history} if you use ksh, and to @file{~/.history}
395 otherwise.
396 @item HOME
397 The location of the user's files in the directory tree; used for
398 expansion of file names starting with a tilde (@file{~}).  On MS-DOS, it
399 defaults to the directory from which Emacs was started, with @samp{/bin}
400 removed from the end if it was present.  On Windows, the default value
401 of @code{HOME} is @file{C:/}, the root directory of drive @file{C:}.
402 @item HOSTNAME
403 The name of the machine that Emacs is running on.
404 @item INCPATH 
405 A colon-separated list of directories.  Used by the @code{complete} package
406 to search for files.
407 @item INFOPATH
408 A colon-separated list of directories in which to search for Info files.
409 @item LC_ALL
410 @itemx LC_COLLATE
411 @itemx LC_CTYPE
412 @itemx LC_MESSAGES
413 @itemx LC_MONETARY
414 @itemx LC_NUMERIC
415 @itemx LC_TIME
416 @itemx LANG
417 The user's preferred locale.  The locale has six categories, specified
418 by the environment variables @env{LC_COLLATE} for sorting,
419 @env{LC_CTYPE} for character encoding, @env{LC_MESSAGES} for system
420 messages, @env{LC_MONETARY} for monetary formats, @env{LC_NUMERIC} for
421 numbers, and @env{LC_TIME} for dates and times.  If one of these
422 variables is not set, the category defaults to the value of the
423 @env{LANG} environment variable, or to the default @samp{C} locale if
424 @env{LANG} is not set.  But if @env{LC_ALL} is specified, it overrides
425 the settings of all the other locale environment variables.
427 The value of the LC_CTYPE category is
428 matched against entries in @code{locale-language-names},
429 @code{locale-charset-language-names}, and
430 @code{locale-preferred-coding-systems}, to select a default language
431 environment and coding system.  @xref{Language Environments}.
432 @item LOGNAME
433 The user's login name.  See also @env{USER}.
434 @item MAIL
435 The name of the user's system mail inbox.
436 @item MAILRC
437 Name of file containing mail aliases.  (The default is
438 @file{~/.mailrc}.)
439 @item MH
440 Name of setup file for the mh system.  (The default is @file{~/.mh_profile}.)
441 @item NAME
442 The real-world name of the user.
443 @item NNTPSERVER
444 The name of the news server.  Used by the mh and Gnus packages.
445 @item ORGANIZATION
446 The name of the organization to which you belong.  Used for setting the
447 `Organization:' header in your posts from the Gnus package.
448 @item PATH
449 A colon-separated list of directories in which executables reside.  This
450 is used to initialize the Emacs Lisp variable @code{exec-path}.
451 @item PWD
452 If set, this should be the default directory when Emacs was started.
453 @item REPLYTO
454 If set, this specifies an initial value for the variable
455 @code{mail-default-reply-to}.  @xref{Mail Headers}.
456 @item SAVEDIR
457 The name of a directory in which news articles are saved by default.
458 Used by the Gnus package.
459 @item SHELL
460 The name of an interpreter used to parse and execute programs run from
461 inside Emacs.
462 @cindex background mode, on @code{xterm}
463 @item TERM
464 The type of the terminal that Emacs is using.  This variable must be
465 set unless Emacs is run in batch mode.  On MS-DOS, it defaults to
466 @samp{internal}, which specifies a built-in terminal emulation that
467 handles the machine's own display.  If the value of @env{TERM} indicates
468 that Emacs runs in non-windowed mode from @code{xterm} or a similar
469 terminal emulator, the background mode defaults to @samp{light}, and
470 Emacs will choose colors that are appropriate for a light background.
471 @item TERMCAP
472 The name of the termcap library file describing how to program the
473 terminal specified by the @env{TERM} variable.  This defaults to
474 @file{/etc/termcap}.
475 @item TMPDIR
476 Used by the Emerge package as a prefix for temporary files.
477 @item TZ
478 This specifies the current time zone and possibly also daylight
479 saving time information.  On MS-DOS, if @code{TZ} is not set in the
480 environment when Emacs starts, Emacs defines a default value as
481 appropriate for the country code returned by DOS.  On MS-Windows, Emacs
482 does not use @code{TZ} at all.
483 @item USER
484 The user's login name.  See also @env{LOGNAME}.  On MS-DOS, this
485 defaults to @samp{root}.
486 @item VERSION_CONTROL
487 Used to initialize the @code{version-control} variable (@pxref{Backup
488 Names}).
489 @end table
491 @node Misc Variables
492 @appendixsubsec Miscellaneous Variables
494 These variables are used only on particular configurations:
496 @table @env
497 @item COMSPEC
498 On MS-DOS and MS-Windows, the name of the command interpreter to use
499 when invoking batch files and commands internal to the shell.  On MS-DOS
500 this is also used to make a default value for the @env{SHELL} environment
501 variable.
503 @item NAME
504 On MS-DOS, this variable defaults to the value of the @env{USER}
505 variable.
507 @item TEMP
508 @itemx TMP
509 On MS-DOS and MS-Windows, these specify the name of the directory for
510 storing temporary files in.
512 @item EMACSTEST
513 On MS-DOS, this specifies a file to use to log the operation of the
514 internal terminal emulator.  This feature is useful for submitting bug
515 reports.
517 @item EMACSCOLORS
518 On MS-DOS, this specifies the screen colors.  It is useful to set them
519 this way, since otherwise Emacs would display the default colors
520 momentarily when it starts up.
522 The value of this variable should be the two-character encoding of the
523 foreground (the first character) and the background (the second
524 character) colors of the default face.  Each character should be the
525 hexadecimal code for the desired color on a standard PC text-mode
526 display.  For example, to get blue text on a light gray background,
527 specify @samp{EMACSCOLORS=17}, since 1 is the code of the blue color and
528 7 is the code of the light gray color.
530 The PC display usually supports only eight background colors.  However,
531 Emacs switches the DOS display to a mode where all 16 colors can be used
532 for the background, so all four bits of the background color are
533 actually used.
535 @item WINDOW_GFX
536 Used when initializing the Sun windows system.
537 @end table
539 @node Display X
540 @appendixsec Specifying the Display Name 
541 @cindex display name (X Window System)
542 @cindex @env{DISPLAY} environment variable
544   The environment variable @env{DISPLAY} tells all X clients, including
545 Emacs, where to display their windows.  Its value is set by default
546 in ordinary circumstances, when you start an X server and run jobs
547 locally.  Occasionally you may need to specify the display yourself; for
548 example, if you do a remote login and want to run a client program
549 remotely, displaying on your local screen.
551   With Emacs, the main reason people change the default display is to
552 let them log into another system, run Emacs on that system, but have the
553 window displayed at their local terminal.  You might need to log in
554 to another system because the files you want to edit are there, or
555 because the Emacs executable file you want to run is there.
557   The syntax of the @env{DISPLAY} environment variable is
558 @samp{@var{host}:@var{display}.@var{screen}}, where @var{host} is the
559 host name of the X Window System server machine, @var{display} is an
560 arbitrarily-assigned number that distinguishes your server (X terminal)
561 from other servers on the same machine, and @var{screen} is a
562 rarely-used field that allows an X server to control multiple terminal
563 screens.  The period and the @var{screen} field are optional.  If
564 included, @var{screen} is usually zero.
566   For example, if your host is named @samp{glasperle} and your server is
567 the first (or perhaps the only) server listed in the configuration, your
568 @env{DISPLAY} is @samp{glasperle:0.0}.
570   You can specify the display name explicitly when you run Emacs, either
571 by changing the @env{DISPLAY} variable, or with the option @samp{-d
572 @var{display}} or @samp{--display=@var{display}}.  Here is an example:
574 @smallexample
575 emacs --display=glasperle:0 &
576 @end smallexample
578   You can inhibit the direct use of the window system and GUI with the
579 @samp{-nw} option.  It tells Emacs to display using ordinary ASCII on
580 its controlling terminal.  This is also an initial option.
582   Sometimes, security arrangements prevent a program on a remote system
583 from displaying on your local system.  In this case, trying to run Emacs
584 produces messages like this:
586 @smallexample
587 Xlib:  connection to "glasperle:0.0" refused by server
588 @end smallexample
590 @noindent
591 You might be able to overcome this problem by using the @code{xhost}
592 command on the local system to give permission for access from your
593 remote machine.
595 @node Font X
596 @appendixsec Font Specification Options
597 @cindex font name (X Window System)
599   By default, Emacs displays text in the font named @samp{9x15}, which
600 makes each character nine pixels wide and fifteen pixels high.  You can
601 specify a different font on your command line through the option
602 @samp{-fn @var{name}} (or @samp{--font}, which is an alias for
603 @samp{-fn}).
605 @table @samp
606 @item -fn @var{name}
607 @opindex -fn
608 @itemx --font=@var{name}
609 @opindex --font
610 @cindex specify default font from the command line
611 Use font @var{name} as the default font.
612 @end table
614   Under X, each font has a long name which consists of eleven words or
615 numbers, separated by dashes.  Some fonts also have shorter
616 nicknames---@samp{9x15} is such a nickname.  You can use either kind of
617 name.  You can use wildcard patterns for the font name; then Emacs lets
618 X choose one of the fonts that match the pattern.  Here is an example,
619 which happens to specify the font whose nickname is @samp{6x13}:
621 @smallexample
622 emacs -fn \
623   "-misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1" &
624 @end smallexample
626 @noindent
627 You can also specify the font in your @file{.Xdefaults} file:
629 @smallexample
630 emacs.font: -misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
631 @end smallexample
633   A long font name has the following form:
635 @smallexample
636 -@var{maker}-@var{family}-@var{weight}-@var{slant}-@var{widthtype}-@var{style}@dots{}
637 @dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{charset}
638 @end smallexample
640 @table @var
641 @item maker
642 This is the name of the font manufacturer.
643 @item family
644 This is the name of the font family---for example, @samp{courier}.
645 @item weight
646 This is normally @samp{bold}, @samp{medium} or @samp{light}.  Other
647 words may appear here in some font names.
648 @item slant
649 This is @samp{r} (roman), @samp{i} (italic), @samp{o} (oblique),
650 @samp{ri} (reverse italic), or @samp{ot} (other).
651 @item widthtype
652 This is normally @samp{condensed}, @samp{extended}, @samp{semicondensed}
653 or @samp{normal}.  Other words may appear here in some font names.
654 @item style
655 This is an optional additional style name.  Usually it is empty---most
656 long font names have two hyphens in a row at this point.
657 @item pixels
658 This is the font height, in pixels.
659 @item height
660 This is the font height on the screen, measured in tenths of a printer's
661 point---approximately 1/720 of an inch.  In other words, it is the point
662 size of the font, times ten.  For a given vertical resolution,
663 @var{height} and @var{pixels} are proportional; therefore, it is common
664 to specify just one of them and use @samp{*} for the other.
665 @item horiz
666 This is the horizontal resolution, in pixels per inch, of the screen for
667 which the font is intended.
668 @item vert
669 This is the vertical resolution, in pixels per inch, of the screen for
670 which the font is intended.  Normally the resolution of the fonts on
671 your system is the right value for your screen; therefore, you normally
672 specify @samp{*} for this and @var{horiz}.
673 @item spacing
674 This is @samp{m} (monospace), @samp{p} (proportional) or @samp{c}
675 (character cell).
676 @item width
677 This is the average character width, in pixels, multiplied by ten.
678 @item charset
679 This is the character set that the font depicts.
680 Normally you should use @samp{iso8859-1}.
681 @end table
683 @cindex listing system fonts
684   You will probably want to use a fixed-width default font---that is,
685 a font in which all characters have the same width.  Any font with
686 @samp{m} or @samp{c} in the @var{spacing} field of the long name is a
687 fixed-width font.  Here's how to use the @code{xlsfonts} program to
688 list all the fixed-width fonts available on your system:
690 @example
691 xlsfonts -fn '*x*' | egrep "^[0-9]+x[0-9]+"
692 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*'
693 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*'
694 @end example
696 @noindent
697 To see what a particular font looks like, use the @code{xfd} command.
698 For example:
700 @example
701 xfd -fn 6x13
702 @end example
704 @noindent
705 displays the entire font @samp{6x13}.
707   While running Emacs, you can set the font of the current frame
708 (@pxref{Frame Parameters}) or for a specific kind of text
709 (@pxref{Faces}).
711 @node Colors
712 @appendixsec Window Color Options
713 @cindex color of window
714 @cindex text colors, from command line
716 @findex list-colors-display
717 @cindex available colors
718   On a color display, you can specify which color to use for various
719 parts of the Emacs display.  To find out what colors are available on
720 your system, type @kbd{M-x list-colors-display}, or press
721 @kbd{C-Mouse-2} and select @samp{Display Colors} from the pop-up menu.
722 If you do not specify colors, on windowed displays the default for the
723 background is white and the default for all other colors is black.  On a
724 monochrome display, the foreground is black, the background is white,
725 and the border is gray if the display supports that.  On terminals, the
726 background is usually black and the foreground is white.
728   Here is a list of the command-line options for specifying colors:
730 @table @samp
731 @item -fg @var{color}
732 @opindex -fg
733 @itemx --foreground-color=@var{color}
734 @opindex --foreground-color
735 @cindex foreground color, command-line argument
736 Specify the foreground color.  @var{color} should be a standard color
737 name, or a numeric specification of the color's red, green, and blue
738 components as in @samp{#4682B4} or @samp{RGB:46/82/B4}.
739 @item -bg @var{color}
740 @opindex -bg
741 @itemx --background-color=@var{color}
742 @opindex --background-color
743 @cindex background color, command-line argument
744 Specify the background color.
745 @item -bd @var{color}
746 @opindex -bd
747 @itemx --border-color=@var{color}
748 @opindex --border-color
749 @cindex border color, command-line argument
750 Specify the color of the border of the X window.
751 @item -cr @var{color}
752 @opindex -cr
753 @itemx --cursor-color=@var{color}
754 @opindex --cursor-color
755 @cindex cursor color, command-line argument
756 Specify the color of the Emacs cursor which indicates where point is.
757 @item -ms @var{color}
758 @opindex -ms
759 @itemx --mouse-color=@var{color}
760 @opindex --mouse-color
761 @cindex mouse pointer color, command-line argument
762 Specify the color for the mouse cursor when the mouse is in the Emacs window.
763 @item -r
764 @opindex -r
765 @itemx -rv
766 @opindex -rv
767 @itemx --reverse-video
768 @opindex --reverse-video
769 @cindex reverse video, command-line argument
770 Reverse video---swap the foreground and background colors.
771 @item --color=@var{mode}
772 @opindex --color
773 @cindex standard colors on a character terminal
774 For a character terminal only, specify the mode of color support.  The
775 parameter @var{mode} can be one of the following:
776 @table @samp
777 @item never
778 @itemx no
779 Don't use colors even if the terminal's capabilities specify color
780 support.
781 @item default
782 @itemx auto
783 Same as when @option{--color} is not used at all: Emacs detects at
784 startup whether the terminal supports colors, and if it does, turns on
785 colored display.
786 @item always
787 @itemx yes
788 @itemx ansi8
789 Turn on the color support unconditionally, and use color commands
790 specified by the ANSI escape sequences for the 8 standard colors.
791 @item @var{num}
792 Use color mode for @var{num} colors.  If @var{num} is -1, turn off
793 color support (equivalent to @samp{never}); if it is 0, use the
794 default color support for this terminal (equivalent to @samp{auto});
795 otherwise use an appropriate standard mode for @var{num} colors.  If
796 there is no mode that supports @var{num} colors, Emacs acts as if
797 @var{num} were 0, i.e.@: it uses the terminal's default color support
798 mode.
799 @end table
800 If @var{mode} is omitted, it defaults to @var{ansi8}.
801 @end table
803   For example, to use a coral mouse cursor and a slate blue text cursor,
804 enter:
806 @example
807 emacs -ms coral -cr 'slate blue' &
808 @end example
810   You can reverse the foreground and background colors through the
811 @samp{-rv} option or with the X resource @samp{reverseVideo}.
813   The @samp{-fg}, @samp{-bg}, and @samp{-rv} options function on
814 text-only terminals as well as on window systems.
816 @node Window Size X
817 @appendixsec Options for Window Size and Position
818 @cindex geometry of Emacs window
819 @cindex position and size of Emacs frame
820 @cindex width and height of Emacs frame
821 @cindex specifying fullscreen for Emacs frame
823   Here is a list of the command-line options for specifying size and
824 position of the initial Emacs frame: 
826 @table @samp
827 @item -g @var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]}
828 @opindex -g
829 Specify window size @var{width} and @var{height} (measured in character
830 columns and lines), and positions @var{xoffset} and @var{yoffset}
831 (measured in pixels).
833 @item --geometry=@var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]}
834 @opindex --geometry
835 This is another way of writing the same thing.
837 @item -fs
838 @opindex -fs
839 @itemx --fullscreen
840 @opindex --fullscreen
841 @cindex fullscreen, command-line argument
842 Specify that width and height shall be the size of the screen.
844 @item -fh
845 @opindex -fh
846 @itemx --fullheight
847 @opindex --fullheight
848 @cindex fullheight, command-line argument
849 Specify that the height shall be the height of the screen.
851 @item -fw
852 @opindex -fw
853 @itemx --fullwidth
854 @opindex --fullwidth
855 @cindex fullwidth, command-line argument
856 Specify that the width shall be the width of the screen.
857 @end table
860 @noindent
861 In the @samp{--geometry} option, @code{@r{@{}+-@r{@}}} means either a plus
862  sign or a minus sign.  A plus
863 sign before @var{xoffset} means it is the distance from the left side of
864 the screen; a minus sign means it counts from the right side.  A plus
865 sign before @var{yoffset} means it is the distance from the top of the
866 screen, and a minus sign there indicates the distance from the bottom.
867 The values @var{xoffset} and @var{yoffset} may themselves be positive or
868 negative, but that doesn't change their meaning, only their direction.
870   Emacs uses the same units as @code{xterm} does to interpret the geometry.
871 The @var{width} and @var{height} are measured in characters, so a large font
872 creates a larger frame than a small font.  (If you specify a proportional
873 font, Emacs uses its maximum bounds width as the width unit.)  The
874 @var{xoffset} and @var{yoffset} are measured in pixels.
876   Since the mode line and the echo area occupy the last 2 lines of the
877 frame, the height of the initial text window is 2 less than the height
878 specified in your geometry.  In non-X-toolkit versions of Emacs, the
879 menu bar also takes one line of the specified number.  But in the X
880 toolkit version, the menu bar is additional and does not count against
881 the specified height.  The tool bar, if present, is also additional.
883   You do not have to specify all of the fields in the geometry
884 specification.
886   If you omit both @var{xoffset} and @var{yoffset}, the window manager
887 decides where to put the Emacs frame, possibly by letting you place
888 it with the mouse.  For example, @samp{164x55} specifies a window 164
889 columns wide, enough for two ordinary width windows side by side, and 55
890 lines tall.
892   The default width for Emacs is 80 characters and the default height is
893 40 lines.  You can omit either the width or the height or both.  If
894 you start the geometry with an integer, Emacs interprets it as the
895 width.  If you start with an @samp{x} followed by an integer, Emacs
896 interprets it as the height.  Thus, @samp{81} specifies just the width;
897 @samp{x45} specifies just the height.
899   If you start with @samp{+} or @samp{-}, that introduces an offset,
900 which means both sizes are omitted.  Thus, @samp{-3} specifies the
901 @var{xoffset} only.  (If you give just one offset, it is always
902 @var{xoffset}.)  @samp{+3-3} specifies both the @var{xoffset} and the
903 @var{yoffset}, placing the frame near the bottom left of the screen.
905   You can specify a default for any or all of the fields in
906 @file{.Xdefaults} file, and then override selected fields with a
907 @samp{--geometry} option.
910  When using one of @samp{--fullscreen}, @samp{--fullwidth} or
911 @samp{--fullheight} there may be some space around the frame
912 anyway.  That is because Emacs rounds the sizes so they are an
913 even number of character heights and widths.
915  Some window managers have options that can make them ignore both
916 program-specified and user-specified positions (sawfish is one).
917 If these are set, Emacs fails to position the window correctly.
919 @node Borders X
920 @appendixsec Internal and External Borders
921 @cindex borders (X Window System)
923   An Emacs frame has an internal border and an external border.  The
924 internal border is an extra strip of the background color around the
925 text portion of the frame.  Emacs itself draws the internal border.
926 The external border is added by the window manager outside the frame;
927 depending on the window manager you use, it may contain various boxes
928 you can click on to move or iconify the window.
930 @table @samp
931 @item -ib @var{width}
932 @opindex -ib
933 @itemx --internal-border=@var{width}
934 @opindex --internal-border
935 @cindex border width, command-line argument
936 Specify @var{width} as the width of the internal border, in pixels.
938 @item -bw @var{width}
939 @opindex -bw
940 @itemx --border-width=@var{width}
941 @opindex --border-width
942 Specify @var{width} as the width of the main border, in pixels.
943 @end table
945   When you specify the size of the frame, that does not count the
946 borders.  The frame's position is measured from the outside edge of the
947 external border.
949   Use the @samp{-ib @var{n}} option to specify an internal border
950 @var{n} pixels wide.  The default is 1.  Use @samp{-bw @var{n}} to
951 specify the width of the external border (though the window manager may
952 not pay attention to what you specify).  The default width of the
953 external border is 2.
955 @node Title X
956 @appendixsec Frame Titles
958   An Emacs frame may or may not have a specified title.  The frame
959 title, if specified, appears in window decorations and icons as the
960 name of the frame.  If an Emacs frame has no specified title, the
961 default title has the form @samp{@var{invocation-name}@@@var{machine}}
962 (if there is only one frame) or the selected window's buffer name (if
963 there is more than one frame).
965   You can specify a title for the initial Emacs frame with a command
966 line option:
968 @table @samp
969 @item -title @var{title}
970 @opindex --title
971 @itemx --title=@var{title}
972 @itemx -T @var{title}
973 @opindex -T
974 @cindex frame title, command-line argument
975 Specify @var{title} as the title for the initial Emacs frame.
976 @end table
978   The @samp{--name} option (@pxref{Resources}) also specifies the title
979 for the initial Emacs frame.
981 @node Icons X
982 @appendixsec Icons
983 @cindex icons (X Window System)
985   Most window managers allow the user to ``iconify'' a frame, removing
986 it from sight, and leaving a small, distinctive ``icon'' window in its
987 place.  Clicking on the icon window makes the frame itself appear again.
988 If you have many clients running at once, you can avoid cluttering up
989 the screen by iconifying most of the clients.
991 @table @samp
992 @item -i
993 @opindex -i
994 @itemx --icon-type
995 @opindex --icon-type
996 @cindex Emacs icon, a gnu
997 Use a picture of a gnu as the Emacs icon.
999 @item -iconic
1000 @opindex --iconic
1001 @itemx --iconic
1002 @cindex start iconified, command-line argument
1003 Start Emacs in iconified state.
1004 @end table
1006   The @samp{-i} or @samp{--icon-type} option tells Emacs to use an icon
1007 window containing a picture of the GNU gnu.  If omitted, Emacs lets the
1008 window manager choose what sort of icon to use---usually just a small
1009 rectangle containing the frame's title.
1011   The @samp{-iconic} option tells Emacs to begin running as an icon,
1012 rather than showing a frame right away.  In this situation, the icon
1013 is the only indication that Emacs has started; the text frame doesn't
1014 appear until you deiconify it.