![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to emacs.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Apple XNU] / GNUtools / emacs / etc|
Return to emacs.1 CVS log | Up to [Apple XNU] / GNUtools / emacs / etc |
1.1 root 1: .TH EMACS 1 "1990 November 13"
2: .UC 4
3: .SH NAME
4: emacs \- GNU project Emacs
5: .SH SYNOPSIS
6: .B emacs
7: [
8: .I command-line switches
9: ] [
10: .I files ...
11: ]
12: .br
13: .SH DESCRIPTION
14: .I GNU Emacs
15: is a new version of
16: .I Emacs,
17: written by the author of the original (PDP-10)
18: .I Emacs,
19: Richard Stallman.
20: Its user functionality encompasses
21: everything other
22: .I Emacs
23: editors do, and it is easily extensible since its
24: editing commands are written in Lisp.
25: .PP
26: .I Emacs
27: has an extensive interactive help facility,
28: but the facility assumes that you know how to manipulate
29: .I Emacs
30: windows and buffers.
31: CTRL-h (backspace
32: or CTRL-h) enters the Help facility. Help Tutorial (CTRL-h t)
33: requests an interactive tutorial which can teach beginners the fundamentals
34: of
35: .I Emacs
36: in a few minutes.
37: Help Apropos (CTRL-h a) helps you
38: find a command given its functionality, Help Character (CTRL-h c)
39: describes a given character's effect, and Help Function (CTRL-h f)
40: describes a given Lisp function specified by name.
41: .PP
42: .I Emacs's
43: Undo can undo several steps of modification to your buffers, so it is
44: easy to recover from editing mistakes.
45: .PP
46: .I GNU Emacs's
47: many special packages handle mail reading (RMail) and sending (Mail),
48: outline editing (Outline), compiling (Compile), running subshells
49: within
50: .I Emacs
51: windows (Shell), running a Lisp read-eval-print loop
52: (Lisp-Interaction-Mode), and automated psychotherapy (Doctor).
53: .PP
54: There is an extensive reference manual, but
55: users of other Emacses
56: should have little trouble adapting even
57: without a copy. Users new to
58: .I Emacs
59: will be able
60: to use basic features fairly rapidly by studying the tutorial and
61: using the self-documentation features.
62: .PP
63: .SM Emacs Options
64: .PP
65: The following options are of general interest:
66: .TP 8
67: .I file
68: Edit
69: .I file.
70: .TP
71: .BI \+ number
72: Go to the line specified by
73: .I number
74: (do not insert a space between the "+" sign and
75: the number).
76: .TP
77: .B \-q
78: Do not load an init file.
79: .TP
80: .BI \-u " user"
81: Load
82: .I user's
83: init file.
84: .TP
85: .BI \-t " file"
86: Use specified
87: .I file
88: as the terminal instead of using stdin/stdout.
89: This must be the first argument specified in the command line.
90: .PP
91: The following options are lisp-oriented
92: (these options are processed in the order encountered):
93: .TP 8
94: .BI \-f " function"
95: Execute the lisp function
96: .I function.
97: .TP
98: .BI \-l " file"
99: Load the lisp code in the file
100: .I file.
101: .PP
102: The following options are useful when running
103: .I Emacs
104: as a batch editor:
105: .TP 8
106: .BI \-batch
107: Edit in batch mode according to the other command line arguments.
108: The editor will send messages to stdout.
109: This option must be the first in the argument list.
110: .TP
111: .B \-kill
112: Exit
113: .I Emacs
114: while in batch mode.
115: .\" START DELETING HERE IF YOU'RE NOT USING X
116: .PP
117: .SM Using Emacs with X
118: .PP
119: .I Emacs
120: has been tailored to work well with the X window system.
121: If you run
122: .I Emacs
123: from under X windows, it will create its own X window to
124: display in. You will probably want to start the editor
125: as a background process
126: so that you can continue using your original window.
127: .PP
128: .I Emacs
129: can be started with the following X switches:
130: .TP 8
131: .BI \-rn " name"
132: Specifies the program name which should be used when looking up
133: defaults in the user's X resources. This must be the first option
134: specified in the command line.
135: .TP 8
136: .BI \-wn " name"
137: Specifies the name which should be assigned to the
138: .I Emacs
139: window.
140: .TP 8
141: .B \-r
142: Display the
143: .I Emacs
144: window in reverse video.
145: .TP
146: .B \-i
147: Use the "kitchen sink" bitmap icon when iconifying the
148: .I Emacs
149: window.
150: .TP
151: .BI \-font " font, " \-fn " font"
152: Set the
153: .I Emacs
154: window's font to that specified by
155: .I font.
156: You will find the various
157: .I X
158: fonts in the
159: .I /usr/lib/X11/fonts
160: directory.
161: Note that
162: .I Emacs
163: will only accept fixed width fonts.
164: Under the X11 Release 4 font-naming conventions, any font with the
165: value "m" or "c" in the eleventh field of the font name is a fixed
166: width font. Furthermore, fonts whose name are of the form
167: .IR width x height
168: are generally fixed width, as is the font
169: .IR fixed .
170: See
171: .IR xlsfonts (1)
172: for more information.
173:
174: When you specify a font, be sure to put a space between the
175: switch and the font name.
176: .TP
177: .BI \-b " pixels"
178: Set the
179: .I Emacs
180: window's border width to the number of pixels specified by
181: .I pixels.
182: Defaults to one pixel on each side of the window.
183: .TP
184: .BI \-ib " pixels"
185: Set the window's internal border width to the number of pixels specified
186: by
187: .I pixels.
188: Defaults to one pixel of padding on each side of the window.
189: .PP
190: .TP 8
191: .BI \-w " geometry, " \-geometry " geometry"
192: Set the
193: .I Emacs
194: window's width, height, and position as specified. The geometry
195: specification is in the standard X format; see
196: .IR X (1)
197: for more information.
198: The width and height are specified in characters; the default is 80 by
199: 24.
200: .PP
201: .TP 8
202: .BI \-fg " color"
203: On color displays, sets the color of the text.
204:
205: See the file
206: .I /usr/lib/X11/rgb.txt
207: for a list of valid
208: color names.
209: .TP
210: .BI \-bg " color"
211: On color displays,
212: sets the color of the window's background.
213: .TP
214: .BI \-bd " color"
215: On color displays,
216: sets the color of the window's border.
217: .TP
218: .BI \-cr " color"
219: On color displays,
220: sets the color of the window's text cursor.
221: .TP
222: .BI \-ms " color"
223: On color displays,
224: sets the color of the window's mouse cursor.
225: .TP
226: .BI \-d " displayname, " \-display " displayname"
227: Create the
228: .I Emacs
229: window on the display specified by
230: .IR displayname .
231: Must be the first option specified in the command line.
232: .TP
233: .B \-nw
234: Tells
235: .I Emacs
236: not to use its special interface to X. If you use this
237: switch when invoking
238: .I Emacs
239: from an
240: .IR xterm (1)
241: window, display is done in that window.
242: This must be the first option specified in the command line.
243: .PP
244: You can set
245: .I X
246: default values for your
247: .I Emacs
248: windows in your
249: .I \.Xresources
250: file (see
251: .IR xrdb (1)).
252: Use the following format:
253: .IP
254: emacs.keyword:value
255: .PP
256: where
257: .I value
258: specifies the default value of
259: .I keyword.
260: .I Emacs
261: lets you set default values for the following keywords:
262: .TP 8
263: .B font (\fPclass\fB Font)
264: Sets the window's text font.
265: .TP
266: .B reverseVideo (\fPclass\fB ReverseVideo)
267: If
268: .I reverseVideo's
269: value is set to
270: .I on,
271: the window will be displayed in reverse video.
272: .TP
273: .B bitmapIcon (\fPclass\fB BitmapIcon)
274: If
275: .I bitmapIcon's
276: value is set to
277: .I on,
278: the window will iconify into the "kitchen sink."
279: .TP
280: .B borderWidth (\fPclass\fB BorderWidth)
281: Sets the window's border width in pixels.
282: .TP
283: .B internalBorder (\fPclass\fB BorderWidth)
284: Sets the window's internal border width in pixels.
285: .TP
286: .B foreground (\fPclass\fB Foreground)
287: For color displays,
288: sets the window's text color.
289: .TP
290: .B background (\fPclass\fB Background)
291: For color displays,
292: sets the window's background color.
293: .TP
294: .B borderColor (\fPclass\fB BorderColor)
295: For color displays,
296: sets the color of the window's border.
297: .TP
298: .B cursorColor (\fPclass\fB Foreground)
299: For color displays,
300: sets the color of the window's text cursor.
301: .TP
302: .B pointerColor (\fPclass\fB Foreground)
303: For color displays,
304: sets the color of the window's mouse cursor.
305: .TP
306: .B geometry (\fPclass\fB Geometry)
307: Sets the geometry of the
308: .I Emacs
309: window (as described above).
310: .TP
311: .B title (\fPclass\fB Title)
312: Sets the title of the
313: .I Emacs
314: window.
315: .TP
316: .B iconName (\fPclass\fB Title)
317: Sets the icon name for the
318: .I Emacs
319: window icon.
320: .PP
321: If you try to set color values while using a black and white display,
322: the window's characteristics will default as follows:
323: the foreground color will be set to black,
324: the background color will be set to white,
325: the border color will be set to grey,
326: and the text and mouse cursors will be set to black.
327: .PP
328: .SM Using the Mouse
329: .PP
330: The following lists the mouse button bindings for the
331: .I Emacs
332: window under X11.
333:
334: .in +\w'CTRL-SHIFT-middle'u+4n
335: .ta \w'CTRL-SHIFT-middle'u+4n
336: .ti -\w'CTRL-SHIFT-middle'u+4n
337: MOUSE BUTTON FUNCTION
338: .br
339: .ti -\w'CTRL-SHIFT-middle'u+4n
340: left Set point.
341: .br
342: .ti -\w'CTRL-SHIFT-middle'u+4n
343: middle Paste text.
344: .br
345: .ti -\w'CTRL-SHIFT-middle'u+4n
346: right Cut text into X cut buffer.
347: .br
348: .ti -\w'CTRL-SHIFT-middle'u+4n
349: SHIFT-middle Cut text into X cut buffer.
350: .br
351: .ti -\w'CTRL-SHIFT-middle'u+4n
352: SHIFT-right Paste text.
353: .br
354: .ti -\w'CTRL-SHIFT-middle'u+4n
355: CTRL-middle Cut text into X cut buffer and kill it.
356: .br
357: .ti -\w'CTRL-SHIFT-middle'u+4n
358: CTRL-right Select this window, then split it into
359: two windows. Same as typing CTRL-x 2.
360: .\" START DELETING HERE IF YOU'RE NOT USING X MENUS
361: .br
362: .ti -\w'CTRL-SHIFT-middle'u+4n
363: CTRL-SHIFT-left X buffer menu--hold the buttons and keys
364: down, wait for menu to appear, select
365: buffer, and release. Move mouse out of
366: menu and release to cancel.
367: .br
368: .ti -\w'CTRL-SHIFT-middle'u+4n
369: CTRL-SHIFT-middle X help menu--pop up index card menu for
370: Emacs help.
371: .\" STOP DELETING HERE IF YOU'RE NOT USING X MENUS
372: .br
373: .ti -\w'CTRL-SHIFT-middle'u+4n
374: CTRL-SHIFT-right Select window with mouse, and delete all
375: other windows. Same as typing CTRL-x 1.
376: .\" STOP DELETING HERE IF YOU'RE NOT USING X
377: .PP
378: .SH MANUALS
379: You can order printed copies of the GNU Emacs Manual for $20.00/copy
380: postpaid from the Free Software Foundation, which develops GNU software.
381: Their address is:
382: .nf
383: Free Software Foundation
384: 675 Mass Ave.
385: Cambridge, MA 02139
386: .fi
387: See the file etc/DISTRIB in the Emacs distribution
388: for full ordering information.
389: Your local Emacs maintainer might also have copies available. As
390: with all software and publications from FSF, everyone is permitted to
391: make and distribute copies of the Emacs manual. The TeX source to the
392: manual is also included in the Emacs source distribution.
393: .PP
394: .SH FILES
395: /usr/local/emacs/src - C source files and object files
396:
397: /usr/local/emacs/lisp - Lisp source files and compiled files
398: that define most editing commands. Some are preloaded;
399: others are autoloaded from this directory when used.
400:
401: /usr/local/emacs/man - sources for the Emacs reference manual.
402:
403: /usr/local/emacs/etc - various programs that are used with
404: GNU Emacs, and some files of information.
405:
406: /usr/local/emacs/etc/DOC.* - contains the documentation
407: strings for the Lisp primitives and preloaded Lisp functions
408: of GNU Emacs. They are stored here to reduce the size of
409: Emacs proper.
410:
411: /usr/local/emacs/etc/DISTRIB discusses GNU Emacs distribution and
412: contains an order form for all of the software and manuals available
413: from the Free Software Foundation.
414:
415: /usr/local/emacs/etc/DIFF discusses GNU Emacs vs. Twenex Emacs;
416: .br
417: /usr/local/emacs/etc/CCADIFF discusses GNU Emacs vs. CCA Emacs;
418: .br
419: /usr/local/emacs/etc/GOSDIFF discusses GNU Emacs vs. Gosling Emacs.
420: .br
421: /usr/local/emacs/etc/SERVICE lists people offering various services
422: to assist users of GNU Emacs, including education, troubleshooting,
423: porting and customization.
424: .br
425: These files also have information useful to anyone wishing to write
426: programs in the Emacs Lisp extension language, which is
427: documented in the GNU Emacs Lisp Manual.
428:
429: /usr/local/emacs/info - files for the Info documentation browser
430: (a subsystem of Emacs) to refer to. Currently not much of Unix
431: is documented here, but the complete text of the Emacs reference
432: manual is included in a convenient tree structured form.
433:
434: /usr/local/emacs/lock - holds lock files that are made for all
435: files being modified in Emacs, to prevent simultaneous modification
436: of one file by two users.
437:
438: /usr/local/emacs/cpp - the GNU cpp, needed for building Emacs on
439: certain versions of Unix where the standard cpp cannot handle long
440: names for macros.
441:
442: /usr/local/emacs/shortnames - facilities for translating long names to
443: short names in C code, needed for building Emacs on certain versions
444: of Unix where the C compiler cannot handle long names for functions
445: or variables.
446:
447: .\" START DELETING HERE IF YOU'RE NOT USING X
448: /usr/lib/X11/rgb.txt - list of valid X color names.
449: .\" STOP DELETING HERE IF YOU'RE NOT USING X
450: .PP
451: .SH BUGS
452: There is a mailing list, [email protected] on the internet
453: (ucbvax!prep.ai.mit.edu!bug-gnu-emacs on UUCPnet), for reporting Emacs
454: bugs and fixes. But before reporting something as a bug, please try
455: to be sure that it really is a bug, not a misunderstanding or a
456: deliberate feature. We ask you to read the section ``Reporting Emacs
457: Bugs'' near the end of the reference manual (or Info system) for hints
458: on how and when to report bugs. Also, include the version number of
459: the Emacs you are running in \fIevery\fR bug report that you send in.
460:
461: Do not expect a personal answer to a bug report. The purpose of reporting
462: bugs is to get them fixed for everyone in the next release, if possible.
463: For personal assistance, look in the SERVICE file (see above) for
464: a list of people who offer it.
465:
466: Please do not send anything but bug reports to this mailing list.
467: Send requests to be added to mailing lists to the special list
468: [email protected] (or the corresponding UUCP
469: address). For more information about Emacs mailing lists, see the
470: file /usr/local/emacs/etc/MAILINGLISTS. Bugs tend actually to be
471: fixed if they can be isolated, so it is in your interest to report
472: them in such a way that they can be easily reproduced.
473: .PP
474: Bugs that I know about are: shell will not work with programs
475: running in Raw mode on some Unix versions.
476: .SH UNRESTRICTIONS
477: .PP
478: .I Emacs
479: is free; anyone may redistribute copies of
480: .I Emacs
481: to
482: anyone under the terms stated in the
483: .I Emacs
484: General Public License,
485: a copy of which accompanies each copy of
486: .I Emacs
487: and which also
488: appears in the reference manual.
489: .PP
490: Copies of
491: .I Emacs
492: may sometimes be received packaged with distributions of Unix systems,
493: but it is never included in the scope of any license covering those
494: systems. Such inclusion violates the terms on which distribution
495: is permitted. In fact, the primary purpose of the General Public
496: License is to prohibit anyone from attaching any other restrictions
497: to redistribution of
498: .I Emacs.
499: .PP
500: Richard Stallman encourages you to improve and extend
501: .I Emacs,
502: and urges that
503: you contribute your extensions to the GNU library. Eventually GNU
504: (Gnu's Not Unix) will be a complete replacement for Berkeley
505: Unix.
506: Everyone will be able to use the GNU system for free.
507: .SH SEE ALSO
508: X(1), xlsfonts(1), xterm(1), xrdb(1)
509: .SH AUTHORS
510: .PP
511: .I Emacs
512: was written by Richard Stallman and the Free Software Foundation.
513: Joachim Martillo and Robert Krawitz added the X features.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.