1 .\" See section COPYING for copyright and redistribution information.
2 .TH EMACS 1 "2007 April 13" "GNU Emacs 24.2.90"
6 emacs \- GNU project Emacs
12 .I command-line switches
22 written by the author of the original (PDP-10)
25 The user functionality of GNU Emacs encompasses everything other
26 editors do, and it is easily extensible since its editing commands are
29 The primary documentation of GNU Emacs is in the GNU Emacs Manual,
30 which you can read using Info, either from Emacs or as a standalone
32 Please look there for complete and up-to-date documentation.
33 This man page is updated only when someone volunteers to do so.
36 has an extensive interactive help facility,
37 but the facility assumes that you know how to manipulate
40 CTRL-h or F1 enters the Help facility.
41 Help Tutorial (CTRL-h t) starts an interactive tutorial to quickly
42 teach beginners the fundamentals of
44 Help Apropos (CTRL-h a) helps you find a command with a name matching
45 a given pattern, Help Key (CTRL-h k) describes a given key sequence,
46 and Help Function (CTRL-h f) describes a given Lisp function.
49 many special packages handle mail reading (RMail) and sending (Mail),
50 outline editing (Outline), compiling (Compile), running subshells
53 windows (Shell), running a Lisp read-eval-print loop
54 (Lisp-Interaction-Mode), automated psychotherapy (Doctor), and much more.
57 The following options are of general interest:
64 .BI \-\-file " file\fR,\fP " \-\-find-file " file\fR,\fP " \-\-visit " file"
65 The same as specifying
67 directly as an argument.
70 Go to the line specified by
72 (do not insert a space between the "+" sign and
74 This applies only to the next file specified.
82 .BR \-q ", " \-\-no\-init\-file
83 Do not load an init file.
86 Do not load the site-wide startup file.
89 Do not load a saved desktop.
91 .BR \-Q ", " \-\-quick
92 Similar to "\-q \-\-no\-site\-file \-\-no\-splash". Also, avoid
93 processing X resources.
96 Do not display a splash screen during start-up.
101 Lisp debugger during the processing of the user init file
103 This is useful for debugging problems in the init file.
105 .BI \-u " user\fR,\fP " \-\-user " user"
110 .BI \-t " file\fR,\fP " \-\-terminal " file"
113 as the terminal instead of using stdin/stdout.
114 This must be the first argument specified in the command line.
117 Start Emacs as a daemon, enabling the Emacs server and disconnecting
118 from the terminal. You can then use the emacsclient command to
119 connect to the server (see
120 .BR emacsclient (1)).
125 version information and exit.
128 Display this help and exit.
131 The following options are Lisp-oriented
132 (these options are processed in the order encountered):
135 .BI \-f " function\fR,\fP " \-\-funcall " function"
136 Execute the lisp function
139 .BI \-l " file\fR,\fP " \-\-load " file"
140 Load the lisp code in the file
143 .BI \-\-eval " expr\fR,\fP " \-\-execute " expr"
144 Evaluate the Lisp expression
148 The following options are useful when running
155 The editor will send messages to stderr.
156 You must use \-l and \-f options to specify files to execute
157 and functions to call.
159 .BI \-\-script " file"
162 as an Emacs Lisp script.
164 .BI \-\-insert " file"
167 into the current buffer.
174 .BI \-L " dir\fR,\fP " \-\-directory " dir"
177 to the list of directories
179 searches for Lisp files.
182 .\" START DELETING HERE IF YOU'RE NOT USING X
183 .SS Using Emacs with X
185 has been tailored to work well with the X window system.
188 from under X windows, it will create its own X window to
190 You will probably want to start the editor as a background
191 process so that you can continue using your original window.
194 can be started with the following X switches:
198 Specify the name which should be assigned to the initial
201 This controls looking up X resources as well as the window title.
203 .BI \-T " name\fR,\fP " \-\-title " name"
204 Specify the title for the initial X window.
206 .BR \-r ", " \-rv ", " \-\-reverse\-video
209 window in reverse video.
211 .BI \-fn " font\fR,\fP " \-\-font " font"
214 window's font to that specified by
216 You will find the various
219 .I /usr/lib/X11/fonts
223 will only accept fixed width fonts.
224 Under the X11 Release 4 font-naming conventions, any font with the
225 value "m" or "c" in the eleventh field of the font name is a fixed
227 Furthermore, fonts whose name are of the form
229 are generally fixed width, as is the font
233 for more information.
235 When you specify a font, be sure to put a space between the
236 switch and the font name.
238 .BI \-\-xrm " resources"
239 Set additional X resources.
241 .BI "\-\-color\fR,\fP \-\-color=" mode
242 Override color mode for character terminals;
244 defaults to `auto', and can also be `never', `auto', `always',
245 or a mode name like `ansi8'.
247 .BI \-bw " pixels\fR,\fP " \-\-border\-width " pixels"
250 window's border width to the number of pixels specified by
252 Defaults to one pixel on each side of the window.
254 .BI \-ib " pixels\fR,\fP " \-\-internal\-border " pixels"
255 Set the window's internal border width to the number of pixels specified
258 Defaults to one pixel of padding on each side of the window.
260 .BI \-g " geometry\fR,\fP " \-\-geometry " geometry"
263 window's width, height, and position as specified.
264 The geometry specification is in the standard X format; see
266 for more information.
267 The width and height are specified in characters; the default is
269 See the Emacs manual, section "Options for Window Size and Position",
270 for information on how window sizes interact
271 with selecting or deselecting the tool bar and menu bar.
273 .BI \-lsp " pixels\fR,\fP " \-\-line\-spacing " pixels"
274 Additional space to put between lines.
276 .BR \-vb ", " \-\-vertical\-scroll\-bars
277 Enable vertical scrollbars.
279 .BR \-fh ", " \-\-fullheight
280 Make the first frame as high as the screen.
282 .BR \-fs ", " \-\-fullscreen
283 Make the first frame fullscreen.
285 .BR \-fw ", " \-\-fullwidth
286 Make the first frame as wide as the screen.
288 .BR \-mm ", " \-\-maximized
289 Maximize the first frame, like "\-fw \-fh".
291 .BI \-fg " color\fR,\fP " \-\-foreground\-color " color"
292 On color displays, set the color of the text.
295 .I M\-x list\-colors\-display
296 for a list of valid color names.
298 .BI \-bg " color\fR,\fP " \-\-background\-color " color"
299 On color displays, set the color of the window's background.
301 .BI \-bd " color\fR,\fP " \-\-border\-color " color"
302 On color displays, set the color of the window's border.
304 .BI \-cr " color\fR,\fP " \-\-cursor\-color " color"
305 On color displays, set the color of the window's text cursor.
307 .BI \-ms " color\fR,\fP " \-\-mouse\-color " color"
308 On color displays, set the color of the window's mouse cursor.
310 .BI \-d " displayname\fR,\fP " \-\-display " displayname"
313 window on the display specified by
315 Must be the first option specified in the command line.
317 .BR \-nbi ", " \-\-no\-bitmap\-icon
318 Do not use picture of gnu for Emacs icon.
325 .BR \-nbc ", " \-\-no\-blinking\-cursor
326 Disable blinking cursor.
328 .BR \-nw ", " \-\-no\-window\-system
331 not to create a graphical frame.
332 If you use this switch when invoking
336 window, display is done in that window.
338 .BR \-D ", " \-\-basic\-display
339 This option disables many display features; use it for
345 default values for your
351 Use the following format:
353 .RI emacs. keyword : value
357 specifies the default value of
360 lets you set default values for the following keywords:
363 .BR background " (class " Background )
365 sets the window's background color.
367 .BR bitmapIcon " (class " BitmapIcon )
372 the window will iconify into the "kitchen sink."
374 .BR borderColor " (class " BorderColor )
376 sets the color of the window's border.
378 .BR borderWidth " (class " BorderWidth )
379 Sets the window's border width in pixels.
381 .BR cursorColor " (class " Foreground )
383 sets the color of the window's text cursor.
385 .BR cursorBlink " (class " CursorBlink )
386 Specifies whether to make the cursor blink.
393 to turn cursor blinking off.
395 .BR font " (class " Font )
396 Sets the window's text font.
398 .BR foreground " (class " Foreground )
400 sets the window's text color.
402 .BR fullscreen " (class " Fullscreen )
403 The desired fullscreen size.
404 The value can be one of
410 which correspond to the command-line options `\-fs', `\-mm', `\-fw',
411 and `\-fh', respectively.
412 Note that this applies to the initial frame only.
414 .BR geometry " (class " Geometry )
415 Sets the geometry of the
417 window (as described above).
419 .BR iconName " (class " Title )
420 Sets the icon name for the
424 .BR internalBorder " (class " BorderWidth )
425 Sets the window's internal border width in pixels.
427 .BR lineSpacing " (class " LineSpacing )
428 Additional space ("leading") between lines, in pixels.
430 .BR menuBar " (class " MenuBar )
431 Gives frames menu bars if
433 don't have menu bars if
435 See the Emacs manual, sections "Lucid Resources" and "LessTif
436 Resources", for how to control the appearance of the menu bar
439 .BR minibuffer " (class " Minibuffer )
442 don't make a minibuffer in this frame.
443 It will use a separate minibuffer frame instead.
445 .BR paneFont " (class " Font )
446 Font name for menu pane titles, in non-toolkit versions of
449 .BR pointerColor " (class " Foreground )
451 sets the color of the window's mouse cursor.
453 .BR privateColormap " (class " PrivateColormap )
456 use a private color map, in the case where the "default
463 .BR reverseVideo " (class " ReverseVideo )
468 the window will be displayed in reverse video.
470 .BR screenGamma " (class "ScreenGamma )
471 Gamma correction for colors, equivalent to the frame parameter
474 .BR scrollBarWidth " (class "ScrollBarWidth )
475 The scroll bar width in pixels, equivalent to the frame parameter
476 `scroll\-bar\-width'.
478 .BR selectionFont " (class " SelectionFont )
479 Font name for pop-up menu items, in non-toolkit versions of
481 (For toolkit versions, see the Emacs manual, sections
482 "Lucid Resources" and "LessTif Resources".)
484 .BR selectionTimeout " (class " SelectionTimeout )
485 Number of milliseconds to wait for a selection reply.
486 A value of 0 means wait as long as necessary.
488 .BR synchronous " (class " Synchronous )
489 Run Emacs in synchronous mode if
491 Synchronous mode is useful for debugging X problems.
493 .BR title " (class " Title )
494 Sets the title of the
498 .BR toolBar " (class " ToolBar )
499 Number of lines to reserve for the tool bar.
501 .BR useXIM " (class " UseXIM )
502 Turns off use of X input methods (XIM) if
507 .BR verticalScrollBars " (class " ScrollBars )
508 Gives frames scroll bars if
510 suppresses scroll bars if
513 .BR visualClass " (class " VisualClass )
514 Specify the "visual" that X should use.
515 This tells X how to handle colors.
516 The value should start with one of
528 is the number of color planes.
532 You can order printed copies of the GNU Emacs Manual from the Free
533 Software Foundation, which develops GNU software.
534 See the online store at <http://shop.fsf.org/>.
536 Your local administrator might also have copies available.
537 As with all software and publications from FSF, everyone is permitted
538 to make and distribute copies of the Emacs manual.
539 The Texinfo source to the manual is also included in the Emacs source
544 /usr/local/share/info \(em files for the Info documentation browser.
545 The complete text of the Emacs reference manual is included in a
546 convenient tree structured form.
547 Also includes the Emacs Lisp Reference Manual, useful to anyone
548 wishing to write programs in the Emacs Lisp extension language,
549 and the Introduction to Programming in Emacs Lisp.
551 /usr/local/share/emacs/$VERSION/lisp \(em Lisp source files and
552 compiled files that define most editing commands.
553 Some are preloaded; others are autoloaded from this directory when
556 /usr/local/libexec/emacs/$VERSION/$ARCH \(em various programs that are
559 /usr/local/share/emacs/$VERSION/etc \(em various files of information.
561 /usr/local/share/emacs/$VERSION/etc/DOC.* \(em contains the documentation
562 strings for the Lisp primitives and preloaded Lisp functions
564 They are stored here to reduce the size of Emacs proper.
566 /usr/local/share/emacs/$VERSION/etc/SERVICE lists people offering
567 various services to assist users of GNU Emacs, including education,
568 troubleshooting, porting and customization.
572 There is a mailing list, bug-gnu-emacs@gnu.org, for reporting Emacs
574 But before reporting something as a bug, please try to be sure that
575 it really is a bug, not a misunderstanding or a deliberate feature.
576 We ask you to read the section ``Reporting Bugs'' in the Emacs manual
577 for hints on how and when to report bugs.
578 Also, include the version number of the Emacs you are running in
579 \fIevery\fR bug report that you send in.
580 Bugs tend actually to be fixed if they can be isolated, so it is
581 in your interest to report them in such a way that they can be
584 Do not expect a personal answer to a bug report.
585 The purpose of reporting bugs is to get them fixed for everyone
586 in the next release, if possible.
587 For personal assistance, look in the SERVICE file (see above) for
588 a list of people who offer it.
590 Please do not send anything but bug reports to this mailing list.
591 For more information about Emacs mailing lists, see the
592 file /usr/local/share/emacs/$VERSION/etc/MAILINGLISTS.
597 is free; anyone may redistribute copies of
599 to anyone under the terms stated in the GNU General Public License,
600 a copy of which accompanies each copy of
603 appears in the reference manual.
607 may sometimes be received packaged with distributions of Unix systems,
608 but it is never included in the scope of any license covering those
610 Such inclusion violates the terms on which distribution is permitted.
611 In fact, the primary purpose of the GNU General Public License is to
612 prohibit anyone from attaching any other restrictions to
616 Richard Stallman encourages you to improve and extend
619 you contribute your extensions to the GNU library.
620 Eventually GNU (Gnu's Not Unix) will be a complete replacement
622 Everyone will be free to use, copy, study and change the GNU system.
636 was written by Richard Stallman and the Free Software Foundation.
637 For detailed credits and acknowledgments, see the GNU Emacs manual.
645 1995, 1999-2012 Free Software Foundation, Inc.
647 Permission is granted to make and distribute verbatim copies of this
648 document provided the copyright notice and this permission notice are
649 preserved on all copies.
651 Permission is granted to copy and distribute modified versions of
652 this document under the conditions for verbatim copying, provided that
653 the entire resulting derived work is distributed under the terms of
654 a permission notice identical to this one.
656 Permission is granted to copy and distribute translations of this
657 document into another language, under the above conditions for
658 modified versions, except that this permission notice may be stated
659 in a translation approved by the Free Software Foundation.