Penguin
Recent Changes
Annotated edit history of emacs(1) version 2, including all changes. View license author blame.
Rev Author # Line
1 perry 1 EMACS
2 !!!EMACS
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 MANUALS
7 FILES
8 BUGS
9 UNRESTRICTIONS
10 SEE ALSO
11 AUTHORS
12 ----
13 !!NAME
14
15
16 emacs - GNU project Emacs
17 !!SYNOPSIS
18
19
20 __emacs__ [[ ''command-line switches'' ] [[ ''files
21 ...'' ]
22 !!DESCRIPTION
23
24
25 ''GNU Emacs'' is a version of ''Emacs,'' written by
26 the author of the original (PDP-10) ''Emacs,'' Richard
27 Stallman.
28 The primary documentation of GNU Emacs is in the GNU Emacs
29 Manual, which you can read on line using Info, a subsystem
30 of Emacs. Please look there for complete and up-to-date
31 documentation. This man page is updated only when someone
32 volunteers to do so; the Emacs maintainers' priority goal is
33 to minimize the amount of time this man page takes away from
34 other more useful projects.
35 The user functionality of GNU Emacs encompasses everything
36 other ''Emacs'' editors do, and it is easily extensible
37 since its editing commands are written in Lisp.
38
39
40 ''Emacs'' has an extensive interactive help facility, but
41 the facility assumes that you know how to manipulate
42 ''Emacs'' windows and buffers. CTRL-h (backspace or
43 CTRL-h) enters the Help facility. Help Tutorial (CTRL-h t)
44 requests an interactive tutorial which can teach beginners
45 the fundamentals of ''Emacs'' in a few minutes. Help
46 Apropos (CTRL-h a) helps you find a command given its
47 functionality, Help Character (CTRL-h c) describes a given
48 character's effect, and Help Function (CTRL-h f) describes a
49 given Lisp function specified by name.
50
51
52 ''Emacs's'' Undo can undo several steps of modification
53 to your buffers, so it is easy to recover from editing
54 mistakes.
55
56
57 ''GNU Emacs's'' many special packages handle mail reading
58 (RMail) and sending (Mail), outline editing (Outline),
59 compiling (Compile), running subshells within ''Emacs''
60 windows (Shell), running a Lisp read-eval-print loop
61 (Lisp-Interaction-Mode), and automated psychotherapy
62 (Doctor).
63
64
65 There is an extensive reference manual, but users of other
66 Emacses should have little trouble adapting even without a
67 copy. Users new to ''Emacs'' will be able to use basic
68 features fairly rapidly by studying the tutorial and using
69 the self-documentation features.
70
71
72 Emacs Options
73
74
75 The following options are of general interest:
76
77
78 ''file''
79
80
81 Edit ''file.''
82
83
84 __+__''number''
85
86
87 Go to the line specified by ''number'' (do not insert a
88 space between the
89 ''
90
91
92 __-q__
93
94
95 Do not load an init file.
96
97
98 __-u__ ''user''
99
100
101 Load ''user's'' init file.
102
103
104 __-t__ ''file''
105
106
107 Use specified ''file'' as the terminal instead of using
108 stdin/stdout. This must be the first argument specified in
109 the command line.
110
111
112 The following options are lisp-oriented (these options are
113 processed in the order encountered):
114
115
116 __-f__ ''function''
117
118
119 Execute the lisp function ''function.''
120
121
122 __-l__ ''file''
123
124
125 Load the lisp code in the file ''file.''
126
127
128 The following options are useful when running ''Emacs''
129 as a batch editor:
130
131
132 __-batch__
133
134
135 Edit in batch mode. The editor will send messages to stderr.
136 This option must be the first in the argument list. You must
137 use -l and -f options to specify files to execute and
138 functions to call.
139
140
141 __-kill__
142
143
144 Exit ''Emacs'' while in batch mode.
145
146
147 Using Emacs with X
148
149
150 ''Emacs'' has been tailored to work well with the X
151 window system. If you run ''Emacs'' from under X windows,
152 it will create its own X window to display in. You will
153 probably want to start the editor as a background process so
154 that you can continue using your original
155 window.
156
157
158 ''Emacs'' can be started with the following X
159 switches:
160
161
162 __-name__ ''name''
163
164
165 Specifies the name which should be assigned to the initial
166 ''Emacs'' window. This controls looking up X resources as
167 well as the window title.
168
169
170 __-title__ ''name''
171
172
173 Specifies the title for the initial X window.
174
175
176 __-r__
177
178
179 Display the ''Emacs'' window in reverse
180 video.
181
182
183 __-i__
184
185
186 Use the Emacs icon when iconifying the ''Emacs''
187 window.
188
189
190 __-font__ ''font,'' __-fn__
191 ''font''
192
193
194 Set the ''Emacs'' window's font to that specified by
195 ''font.'' You will find the various ''X'' fonts in the
196 ''/usr/lib/X11/fonts'' directory. Note that ''Emacs''
197 will only accept fixed width fonts. Under the X11 Release 4
198 font-naming conventions, any font with the value
199 ''width''x''height'' are
200 generally fixed width, as is the font ''fixed''. See
201 xlsfonts(1) for more information.
202
203
204 When you specify a font, be sure to put a space between the
205 switch and the font name.
206
207
208 __-b__ ''pixels''
209
210
211 Set the ''Emacs'' window's border width to the number of
212 pixels specified by ''pixels.'' Defaults to one pixel on
213 each side of the window.
214
215
216 __-ib__ ''pixels''
217
218
219 Set the window's internal border width to the number of
220 pixels specified by ''pixels.'' Defaults to one pixel of
221 padding on each side of the window.
222
223
224 __-geometry__ ''geometry''
225
226
227 Set the ''Emacs'' window's width, height, and position as
228 specified. The geometry specification is in the standard X
229 format; see ''X''(1) for more information. The width and
230 height are specified in characters; the default is 80 by
231 24.
232
233
234 __-fg__ ''color''
235
236
237 On color displays, sets the color of the text.
238
239
240 See the file ''/usr/lib/X11/rgb.txt'' for a list of valid
241 color names.
242
243
244 __-bg__ ''color''
245
246
247 On color displays, sets the color of the window's
248 background.
249
250
251 __-bd__ ''color''
252
253
254 On color displays, sets the color of the window's
255 border.
256
257
258 __-cr__ ''color''
259
260
261 On color displays, sets the color of the window's text
262 cursor.
263
264
265 __-ms__ ''color''
266
267
268 On color displays, sets the color of the window's mouse
269 cursor.
270
271
272 __-d__ ''displayname,'' __-display__
273 ''displayname''
274
275
276 Create the ''Emacs'' window on the display specified by
277 ''displayname''. Must be the first option specified in
278 the command line.
279
280
281 __-nw__
282
283
284 Tells ''Emacs'' not to use its special interface to X. If
285 you use this switch when invoking ''Emacs'' from an
286 xterm(1) window, display is done in that window. This
287 must be the first option specified in the command
288 line.
289
290
291 You can set ''X'' default values for your ''Emacs''
292 windows in your ''.Xresources'' file (see
293 xrdb(1)). Use the following format:
294
295
296 emacs.keyword:value
297
298
299 where ''value'' specifies the default value of
300 ''keyword. Emacs'' lets you set default values for the
301 following keywords:
302
303
304 __font (__class __Font)__
305
306
307 Sets the window's text font.
308
309
2 perry 310 __reverseVideo (__class __!ReverseVideo)__
1 perry 311
312
313 If ''reverseVideo's'' value is set to ''on,'' the
314 window will be displayed in reverse video.
315
316
2 perry 317 __bitmapIcon (__class __!BitmapIcon)__
1 perry 318
319
320 If ''bitmapIcon's'' value is set to ''on,'' the window
321 will iconify into the ''
322
323
2 perry 324 __borderWidth (__class __!BorderWidth)__
1 perry 325
326
327 Sets the window's border width in pixels.
328
329
330 __internalBorder (__class
2 perry 331 __!BorderWidth)__
1 perry 332
333
334 Sets the window's internal border width in
335 pixels.
336
337
338 __foreground (__class __Foreground)__
339
340
341 For color displays, sets the window's text
342 color.
343
344
345 __background (__class __Background)__
346
347
348 For color displays, sets the window's background
349 color.
350
351
2 perry 352 __borderColor (__class __!BorderColor)__
1 perry 353
354
355 For color displays, sets the color of the window's
356 border.
357
358
359 __cursorColor (__class __Foreground)__
360
361
362 For color displays, sets the color of the window's text
363 cursor.
364
365
366 __pointerColor (__class __Foreground)__
367
368
369 For color displays, sets the color of the window's mouse
370 cursor.
371
372
373 __geometry (__class __Geometry)__
374
375
376 Sets the geometry of the ''Emacs'' window (as described
377 above).
378
379
380 __title (__class __Title)__
381
382
383 Sets the title of the ''Emacs'' window.
384
385
386 __iconName (__class __Title)__
387
388
389 Sets the icon name for the ''Emacs'' window
390 icon.
391
392
393 If you try to set color values while using a black and white
394 display, the window's characteristics will default as
395 follows: the foreground color will be set to black, the
396 background color will be set to white, the border color will
397 be set to grey, and the text and mouse cursors will be set
398 to black.
399
400
401 Using the Mouse
402
403
404 The following lists the mouse button bindings for the
405 ''Emacs'' window under X11.
406
407
408 MOUSE BUTTON FUNCTION
409
410
411 left Set point.
412
413
414 middle Paste text.
415
416
417 right Cut text into X cut buffer.
418
419
420 SHIFT-middle Cut text into X cut buffer.
421
422
423 SHIFT-right Paste text.
424
425
426 CTRL-middle Cut text into X cut buffer and kill
427 it.
428
429
430 CTRL-right Select this window, then split it into two
431 windows. Same as typing CTRL-x 2.
432
433
434 CTRL-SHIFT-left X buffer menu--hold the buttons and keys
435 down, wait for menu to appear, select buffer, and release.
436 Move mouse out of menu and release to cancel.
437
438
439 CTRL-SHIFT-middle X help menu--pop up index card menu for
440 Emacs help.
441
442
443 CTRL-SHIFT-right Select window with mouse, and delete all
444 other windows. Same as typing CTRL-x 1.
445 !!MANUALS
446
447
448 You can order printed copies of the GNU Emacs Manual from
449 the Free Software Foundation, which develops GNU software.
450 See the file ORDERS for ordering information.
451 Your local Emacs maintainer might also have copies
452 available. As with all software and publications from FSF,
453 everyone is permitted to make and distribute copies of the
454 Emacs manual. The TeX source to the manual is also included
455 in the Emacs source distribution.
456 !!FILES
457
458
459 /usr/info - files for the Info documentation browser (a
460 subsystem of Emacs) to refer to. Currently not much of Unix
461 is documented here, but the complete text of the Emacs
462 reference manual is included in a convenient tree structured
463 form.
464
465
466 /usr/share/emacs/$VERSION/src - C source files and object
467 files
468
469
470 /usr/share/emacs/$VERSION/lisp - Lisp source files and
471 compiled files that define most editing commands. Some are
472 preloaded; others are autoloaded from this directory when
473 used.
474
475
476 /usr/share/emacs/$VERSION/etc - various programs that are
477 used with GNU Emacs, and some files of
478 information.
479
480
481 /usr/share/emacs/$VERSION/etc/DOC.* - contains the
482 documentation strings for the Lisp primitives and preloaded
483 Lisp functions of GNU Emacs. They are stored here to reduce
484 the size of Emacs proper.
485
486
487 /usr/share/emacs/$VERSION/etc/OTHER.EMACSES discusses GNU
488 Emacs vs. other versions of Emacs.
489 /usr/share/emacs/$VERSION/etc/SERVICE lists people offering
490 various services to assist users of GNU Emacs, including
491 education, troubleshooting, porting and customization.
492 These files also have information useful to anyone wishing
493 to write programs in the Emacs Lisp extension language,
494 which has not yet been fully documented.
495
496
497 /usr/com/emacs/lock - holds lock files that are made for all
498 files being modified in Emacs, to prevent simultaneous
499 modification of one file by two users.
500
501
502 /usr/lib/X11/rgb.txt - list of valid X color
503 names.
504 !!BUGS
505
506
507 There is a mailing list, bug-gnu-emacs@prep.ai.mit.edu on
508 the internet (ucbvax!prep.ai.mit.edu!bug-gnu-emacs on
509 UUCPnet), for reporting Emacs bugs and fixes. But before
510 reporting something as a bug, please try to be sure that it
511 really is a bug, not a misunderstanding or a deliberate
512 feature. We ask you to read the section ``Reporting Emacs
513 Bugs'' near the end of the reference manual (or Info system)
514 for hints on how and when to report bugs. Also, include the
515 version number of the Emacs you are running in ''every''
516 bug report that you send in.
517
518
519 Do not expect a personal answer to a bug report. The purpose
520 of reporting bugs is to get them fixed for everyone in the
521 next release, if possible. For personal assistance, look in
522 the SERVICE file (see above) for a list of people who offer
523 it.
524
525
526 Please do not send anything but bug reports to this mailing
527 list. Send requests to be added to mailing lists to the
528 special list info-gnu-emacs-request@prep.ai.mit.edu (or the
529 corresponding UUCP address). For more information about
530 Emacs mailing lists, see the file
531 /usr/emacs/etc/MAILINGLISTS. Bugs tend actually to be fixed
532 if they can be isolated, so it is in your interest to report
533 them in such a way that they can be easily
534 reproduced.
535
536
537 Bugs that I know about are: shell will not work with
538 programs running in Raw mode on some Unix
539 versions.
540 !!UNRESTRICTIONS
541
542
543 ''Emacs'' is free; anyone may redistribute copies of
544 ''Emacs'' to anyone under the terms stated in the
545 ''Emacs'' General Public License, a copy of which
546 accompanies each copy of ''Emacs'' and which also appears
547 in the reference manual.
548
549
550 Copies of ''Emacs'' may sometimes be received packaged
551 with distributions of Unix systems, but it is never included
552 in the scope of any license covering those systems. Such
553 inclusion violates the terms on which distribution is
554 permitted. In fact, the primary purpose of the General
555 Public License is to prohibit anyone from attaching any
556 other restrictions to redistribution of
557 ''Emacs.''
558
559
560 Richard Stallman encourages you to improve and extend
561 ''Emacs,'' and urges that you contribute your extensions
562 to the GNU library. Eventually GNU (Gnu's Not Unix) will be
563 a complete replacement for Berkeley Unix. Everyone will be
564 free to use, copy, study and change the GNU
565 system.
566 !!SEE ALSO
567
568
569 X(1), xlsfonts(1), xterm(1), xrdb(1)
570 !!AUTHORS
571
572
573 ''Emacs'' was written by Richard Stallman and the Free
574 Software Foundation. Joachim Martillo and Robert Krawitz
575 added the X features.
576 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.