1 .\" See section COPYING for copyright and redistribution information.
2 .TH EMACS 1 "2007 April 13" "GNU Emacs @version@"
6 emacs \- GNU project Emacs editor
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 .BI \-\-chdir= "directory"
86 .BR \-q ", " \-\-no\-init\-file
87 Do not load an init file.
89 .BR \-nl ", " \-\-no\-shared\-memory
90 Do not use shared memory.
93 Do not load the site-wide startup file.
95 .BR \-nsl ", " \-\-no\-site\-lisp
96 Do not add site-lisp directories to load-path.
99 Do not load a saved desktop.
101 .BR \-Q ", " \-\-quick
102 Similar to "\-q \-\-no\-site\-file \-\-no\-splash". Also, avoid
103 processing X resources.
106 Do not display a splash screen during start-up.
111 Lisp debugger during the processing of the user init file
113 This is useful for debugging problems in the init file.
115 .BI \-u " user\fR,\fP " \-\-user= "user"
120 .BI \-t " file\fR,\fP " \-\-terminal= "file"
123 as the terminal instead of using stdin/stdout.
124 This must be the first argument specified in the command line.
126 .BI \-\-daemon "\fR[=\fPname\fR], " \-\-bg\-daemon "\fR[=\fPname\fR]"
127 Start Emacs as a daemon, enabling the Emacs server and disconnecting
128 from the terminal. You can then use the emacsclient (see
131 connect to the server (with optional
134 .BI \-\-fg\-daemon "\fR[=\fPname\fR]"
135 Like "\-\-bg\-daemon", but don't disconnect from the terminal.
140 version information and exit.
143 Display this help and exit.
146 The following options are Lisp-oriented
147 (these options are processed in the order encountered):
150 .BI \-f " function\fR,\fP " \-\-funcall= "function"
151 Execute the lisp function
154 .BI \-l " file\fR,\fP " \-\-load= "file"
155 Load the lisp code in the file
158 .BI \-\-eval= "expr\fR,\fP " \-\-execute= "expr"
159 Evaluate the Lisp expression
163 The following options are useful when running
170 The editor will send messages to stderr.
171 You must use \-l and \-f options to specify files to execute
172 and functions to call.
174 .BI \-\-script= "file"
177 as an Emacs Lisp script.
179 .BI \-\-insert= "file"
182 into the current buffer.
189 .BI \-L " dir\fR,\fP " \-\-directory= "dir"
192 to the list of directories
194 searches for Lisp files.
197 .\" START DELETING HERE IF YOU'RE NOT USING X
198 .SS Using Emacs with X
200 has been tailored to work well with the X window system.
203 from under X windows, it will create its own X window to
205 You will probably want to start the editor as a background
206 process so that you can continue using your original window.
209 can be started with the following X switches:
213 Specify the name which should be assigned to the initial
216 This controls looking up X resources as well as the window title.
218 .BI \-T " name\fR,\fP " \-\-title= "name"
219 Specify the title for the initial X window.
221 .BR \-r ", " \-rv ", " \-\-reverse\-video
224 window in reverse video.
226 .BI \-fn " font\fR,\fP " \-\-font= "font"
229 window's font to that specified by
231 You will find the various
234 .I /usr/lib/X11/fonts
238 will only accept fixed width fonts.
239 Under the X11 Release 4 font-naming conventions, any font with the
240 value "m" or "c" in the eleventh field of the font name is a fixed
242 Furthermore, fonts whose name are of the form
244 are generally fixed width, as is the font
248 for more information.
250 When you specify a font, be sure to put a space between the
251 switch and the font name.
253 .BI \-\-xrm= "resources"
254 Set additional X resources.
256 .BI "\-\-color\fR,\fP \-\-color=" mode
257 Override color mode for character terminals;
259 defaults to "auto", and can also be "never", "auto", "always",
260 or a mode name like "ansi8".
262 .BI \-bw " pixels\fR,\fP " \-\-border\-width= "pixels"
265 window's border width to the number of pixels specified by
267 Defaults to one pixel on each side of the window.
269 .BI \-ib " pixels\fR,\fP " \-\-internal\-border= "pixels"
270 Set the window's internal border width to the number of pixels specified
273 Defaults to one pixel of padding on each side of the window.
275 .BI \-g " geometry\fR,\fP " \-\-geometry= "geometry"
278 window's width, height, and position as specified.
279 The geometry specification is in the standard X format; see
281 for more information.
282 The width and height are specified in characters; the default is
284 See the Emacs manual, section "Options for Window Size and Position",
285 for information on how window sizes interact
286 with selecting or deselecting the tool bar and menu bar.
288 .BI \-lsp " pixels\fR,\fP " \-\-line\-spacing= "pixels"
289 Additional space to put between lines.
291 .BR \-vb ", " \-\-vertical\-scroll\-bars
292 Enable vertical scrollbars.
294 .BR \-fh ", " \-\-fullheight
295 Make the first frame as high as the screen.
297 .BR \-fs ", " \-\-fullscreen
298 Make the first frame fullscreen.
300 .BR \-fw ", " \-\-fullwidth
301 Make the first frame as wide as the screen.
303 .BR \-mm ", " \-\-maximized
304 Maximize the first frame, like "\-fw \-fh".
306 .BI \-fg " color\fR,\fP " \-\-foreground\-color= "color"
307 On color displays, set the color of the text.
310 .I M\-x list\-colors\-display
311 for a list of valid color names.
313 .BI \-bg " color\fR,\fP " \-\-background\-color= "color"
314 On color displays, set the color of the window's background.
316 .BI \-bd " color\fR,\fP " \-\-border\-color= "color"
317 On color displays, set the color of the window's border.
319 .BI \-cr " color\fR,\fP " \-\-cursor\-color= "color"
320 On color displays, set the color of the window's text cursor.
322 .BI \-ms " color\fR,\fP " \-\-mouse\-color= "color"
323 On color displays, set the color of the window's mouse cursor.
325 .BI \-d " displayname\fR,\fP " \-\-display= "displayname"
328 window on the display specified by
330 Must be the first option specified in the command line.
332 .BR \-nbi ", " \-\-no\-bitmap\-icon
333 Do not use picture of gnu for Emacs icon.
340 .BR \-nbc ", " \-\-no\-blinking\-cursor
341 Disable blinking cursor.
343 .BI \-\-parent-id= "xid"
346 .BR \-nw ", " \-\-no\-window\-system
349 not to create a graphical frame.
350 If you use this switch when invoking
354 window, display is done in that window.
356 .BR \-D ", " \-\-basic\-display
357 This option disables many display features; use it for
363 default values for your
369 Use the following format:
371 .RI emacs. keyword : value
375 specifies the default value of
378 lets you set default values for the following keywords:
381 .BR background " (class " Background )
383 sets the window's background color.
385 .BR bitmapIcon " (class " BitmapIcon )
390 the window will iconify into the "kitchen sink."
392 .BR borderColor " (class " BorderColor )
394 sets the color of the window's border.
396 .BR borderWidth " (class " BorderWidth )
397 Sets the window's border width in pixels.
399 .BR cursorColor " (class " Foreground )
401 sets the color of the window's text cursor.
403 .BR cursorBlink " (class " CursorBlink )
404 Specifies whether to make the cursor blink.
411 to turn cursor blinking off.
413 .BR font " (class " Font )
414 Sets the window's text font.
416 .BR foreground " (class " Foreground )
418 sets the window's text color.
420 .BR fullscreen " (class " Fullscreen )
421 The desired fullscreen size.
422 The value can be one of
428 which correspond to the command-line options "\-fs", "\-mm", "\-fw",
429 and "\-fh", respectively.
430 Note that this applies to the initial frame only.
432 .BR geometry " (class " Geometry )
433 Sets the geometry of the
435 window (as described above).
437 .BR iconName " (class " Title )
438 Sets the icon name for the
442 .BR internalBorder " (class " BorderWidth )
443 Sets the window's internal border width in pixels.
445 .BR lineSpacing " (class " LineSpacing )
446 Additional space ("leading") between lines, in pixels.
448 .BR menuBar " (class " MenuBar )
449 Gives frames menu bars if
451 don't have menu bars if
453 See the Emacs manual, sections "Lucid Resources" and "Motif
454 Resources", for how to control the appearance of the menu bar
457 .BR minibuffer " (class " Minibuffer )
460 don't make a minibuffer in this frame.
461 It will use a separate minibuffer frame instead.
463 .BR paneFont " (class " Font )
464 Font name for menu pane titles, in non-toolkit versions of
467 .BR pointerColor " (class " Foreground )
469 sets the color of the window's mouse cursor.
471 .BR privateColormap " (class " PrivateColormap )
474 use a private color map, in the case where the "default
481 .BR reverseVideo " (class " ReverseVideo )
486 the window will be displayed in reverse video.
488 .BR screenGamma " (class "ScreenGamma )
489 Gamma correction for colors, equivalent to the frame parameter
492 .BR scrollBarWidth " (class "ScrollBarWidth )
493 The scroll bar width in pixels, equivalent to the frame parameter
494 "scroll\-bar\-width".
496 .BR selectionFont " (class " SelectionFont )
497 Font name for pop-up menu items, in non-toolkit versions of
499 (For toolkit versions, see the Emacs manual, sections
500 "Lucid Resources" and "Motif Resources".)
502 .BR selectionTimeout " (class " SelectionTimeout )
503 Number of milliseconds to wait for a selection reply.
504 A value of 0 means wait as long as necessary.
506 .BR synchronous " (class " Synchronous )
507 Run Emacs in synchronous mode if
509 Synchronous mode is useful for debugging X problems.
511 .BR title " (class " Title )
512 Sets the title of the
516 .BR toolBar " (class " ToolBar )
517 Number of lines to reserve for the tool bar.
519 .BR useXIM " (class " UseXIM )
520 Turns off use of X input methods (XIM) if
525 .BR verticalScrollBars " (class " ScrollBars )
526 Gives frames scroll bars if
528 suppresses scroll bars if
531 .BR visualClass " (class " VisualClass )
532 Specify the "visual" that X should use.
533 This tells X how to handle colors.
534 The value should start with one of
546 is the number of color planes.
550 You can order printed copies of the GNU Emacs Manual from the Free
551 Software Foundation, which develops GNU software.
552 See the online store at <https://shop.fsf.org/>.
554 Your local administrator might also have copies available.
555 As with all software and publications from FSF, everyone is permitted
556 to make and distribute copies of the Emacs manual.
557 The Texinfo source to the manual is also included in the Emacs source
562 /usr/local/share/info \(em files for the Info documentation browser.
563 The complete text of the Emacs reference manual is included in a
564 convenient tree structured form.
565 Also includes the Emacs Lisp Reference Manual, useful to anyone
566 wishing to write programs in the Emacs Lisp extension language,
567 and the Introduction to Programming in Emacs Lisp.
569 /usr/local/share/emacs/$VERSION/lisp \(em Lisp source files and
570 compiled files that define most editing commands.
571 Some are preloaded; others are autoloaded from this directory when
574 /usr/local/libexec/emacs/$VERSION/$ARCH \(em various programs that are
577 /usr/local/share/emacs/$VERSION/etc \(em various files of information.
579 /usr/local/share/emacs/$VERSION/etc/DOC.* \(em contains the documentation
580 strings for the Lisp primitives and preloaded Lisp functions
582 They are stored here to reduce the size of Emacs proper.
587 There is a mailing list, @PACKAGE_BUGREPORT@, for reporting Emacs
589 But before reporting something as a bug, please try to be sure that
590 it really is a bug, not a misunderstanding or a deliberate feature.
591 We ask you to read the section "Reporting Bugs" in the Emacs manual
592 for hints on how and when to report bugs.
593 Also, include the version number of the Emacs you are running in
594 \fIevery\fR bug report that you send in.
595 Bugs tend actually to be fixed if they can be isolated, so it is
596 in your interest to report them in such a way that they can be
599 Do not expect a personal answer to a bug report.
600 The purpose of reporting bugs is to get them fixed for everyone
601 in the next release, if possible.
602 For personal assistance, consult the service directory at
603 <https://www.fsf.org/resources/service/> for a list of people who offer it.
605 Please do not send anything but bug reports to this mailing list.
606 For other Emacs lists, see <https://savannah.gnu.org/mail/?group=emacs>.
611 is free; anyone may redistribute copies of
613 to anyone under the terms stated in the GNU General Public License,
614 a copy of which accompanies each copy of
617 appears in the reference manual.
621 may sometimes be received packaged with distributions of Unix systems,
622 but it is never included in the scope of any license covering those
624 Such inclusion violates the terms on which distribution is permitted.
625 In fact, the primary purpose of the GNU General Public License is to
626 prohibit anyone from attaching any other restrictions to
630 Richard Stallman encourages you to improve and extend
633 you contribute your extensions to the GNU library.
634 Eventually GNU (Gnu's Not Unix) will be a complete replacement
636 Everyone will be free to use, copy, study and change the GNU system.
650 was written by Richard Stallman and the Free Software Foundation.
651 For detailed credits and acknowledgments, see the GNU Emacs manual.
656 Copyright 1995, 1999-2018 Free Software Foundation, Inc.
658 Permission is granted to make and distribute verbatim copies of this
659 document provided the copyright notice and this permission notice are
660 preserved on all copies.
662 Permission is granted to copy and distribute modified versions of
663 this document under the conditions for verbatim copying, provided that
664 the entire resulting derived work is distributed under the terms of
665 a permission notice identical to this one.
667 Permission is granted to copy and distribute translations of this
668 document into another language, under the above conditions for
669 modified versions, except that this permission notice may be stated
670 in a translation approved by the Free Software Foundation.