|
|
1.1 root 1:
2:
3:
4: EMACS(1) UNIX Programmer's Manual EMACS(1)
5:
6:
7:
8: NNAAMMEE
9: emacs - GNU project Emacs
10:
11: SSYYNNOOPPSSIISS
12: eemmaaccss [file ...]
13:
14: DDEESSCCRRIIPPTTIIOONN
15: _G_N_U _E_m_a_c_s is a new version of _E_m_a_c_s, written by the author
16: of the original (PDP-10) _E_m_a_c_s, Richard Stallman. Its user
17: functionality encompasses everything other _E_m_a_c_s editors do,
18: and it is easily extensible since its editing commands are
19: written in Lisp.
20:
21: _E_m_a_c_s has an extensive interactive help facility, but the
22: facility assumes that you know how to manipulate _E_m_a_c_s win-
23: dows and buffers. CTRL-h (backspace or CTRL-h) enters the
24: Help facility. Help Tutorial (CTRL-h t) requests an
25: interactive tutorial which can teach beginners the fundamen-
26: tals of _E_m_a_c_s in a few minutes. Help Apropos (CTRL-h a)
27: helps you find a command given its functionality, Help Char-
28: acter (CTRL-h c) describes a given character's effect, and
29: Help Function (CTRL-h f) describes a given Lisp function
30: specified by name.
31:
32: _E_m_a_c_s'_s Undo can undo several steps of modification to your
33: buffers, so it is easy to recover from editing mistakes.
34:
35: _G_N_U _E_m_a_c_s'_s many special packages handle mail reading
36: (RMail) and sending (Mail), outline editing (Outline), com-
37: piling (Compile), running subshells within _E_m_a_c_s windows
38: (Shell), running a Lisp read-eval-print loop (Lisp-
39: Interaction-Mode), and automated psychotherapy (Doctor).
40:
41: There is an extensive reference manual, but users of other
42: Emacses should have little trouble adapting even without a
43: copy. Users new to _E_m_a_c_s will be able to use basic features
44: fairly rapidly by studying the tutorial and using the self-
45: documentation features.
46:
47: Emacs Options
48:
49: The following options are of general interest:
50:
51: ffiillee Edit _f_i_l_e.
52:
53: ++nnuummbbeerr Go to the line specified by _n_u_m_b_e_r (do not insert a
54: space between the "+" sign and the number).
55:
56: --dd ddiissppllaayynnaammee
57: Create the _E_m_a_c_s window on the display specified by
58: _d_i_s_p_l_a_y_n_a_m_e. This must be the first argument listed
59: in the command line.
60:
61:
62:
63: Printed 6/29/90 1987 September 1 1
64:
65:
66:
67:
68:
69:
70: EMACS(1) UNIX Programmer's Manual EMACS(1)
71:
72:
73:
74: --qq Do not load an init file.
75:
76: --uu uusseerr Load _u_s_e_r'_s init file.
77:
78: --tt ffiillee Use specified _f_i_l_e as the terminal instead of using
79: stdin/stdout. This must be the first argument
80: specified in the command line.
81:
82: The following options are lisp-oriented (these options are
83: processed in the order encountered):
84:
85: --ff ffuunnccttiioonn
86: Execute the lisp function _f_u_n_c_t_i_o_n.
87:
88: --ll ffiillee Load the lisp code in the file _f_i_l_e.
89:
90: The following options are useful when running _E_m_a_c_s as a
91: batch editor:
92:
93: --bbaattcchh ccoommmmaannddffiillee
94: Edit in batch mode using the commands found in _c_o_m_-
95: _m_a_n_d_f_i_l_e. The editor will send messages to stdout.
96: This option must be the first in the argument list.
97:
98: --kkiillll Exit _E_m_a_c_s while in batch mode.
99:
100: _U_s_i_n_g _E_m_a_c_s _w_i_t_h _X
101:
102: _E_m_a_c_s has been tailored to work well with the X window sys-
103: tem. To enable this feature, you must define the macro
104: HHAAVVEE__XX__WWIINNDDOOWWSS in the file _s_r_c/_c_o_n_f_i_g._h before compiling
105: _E_m_a_c_s. If you run _E_m_a_c_s from under X windows, it will create
106: its own X window to display in. You will probably want to
107: start the editor as a background process so that you can
108: continue using your original window. To use the optional X
109: Menu features, define also the macro HHAAVVEE__XX__MMEENNUU.. This macro
110: is separate from HHAAVVEE__XX__WWIINNDDOOWWSS because the Menu facility of
111: X does not work on all the systems that support X. _E_m_a_c_s
112: can be started with the following X switches:
113:
114: --rr Display the _E_m_a_c_s window in inverse video.
115:
116: --ii Use the "kitchen sink" bitmap icon when iconifying
117: the _E_m_a_c_s window.
118:
119: --ffoonntt ffoonntt
120: Set the _E_m_a_c_s window's font to that specified by
121: _f_o_n_t. You will find the various _X fonts in the
122: /_u_s_r/_n_e_w/_l_i_b/_X/_f_o_n_t directory. Note that _E_m_a_c_s will
123: only accept fixed width fonts. These include the
124: _6_x_1_0._o_n_x, _6_x_1_3._o_n_x, _6_x_1_3_p._o_n_x, _8_x_1_3._o_n_x, and
125: _9_x_1_5._o_n_x fonts. The other fixed width fonts are
126:
127:
128:
129: Printed 6/29/90 1987 September 1 2
130:
131:
132:
133:
134:
135:
136: EMACS(1) UNIX Programmer's Manual EMACS(1)
137:
138:
139:
140: specified by the _f_x character sequence that comes
141: before the ._o_n_x extension.
142:
143: When you specify a font, do not include the ._o_n_x
144: extension. Be sure to put a space between the -_f_o_n_t
145: switch and the font specification argument.
146:
147: --bb ppiixxeellss
148: Set the _E_m_a_c_s window's border width to the number of
149: pixels specified by _p_i_x_e_l_s.
150:
151: --iibb ppiixxeellss
152: Set the window's internal border width to the number
153: of pixels specified by _p_i_x_e_l_s. Defaults to one pixel
154: of padding on each side of the window.
155:
156: --ww ==[[WWIIDDTTHH]][[xxHHEEIIGGHHTT]][[{{++--}}XXOOFFFF[[{{++--}}YYOOFFFF]]]]
157: Set the _E_m_a_c_s window's width, height, and position
158: on the screen. The []'s denote optional arguments,
159: the {}'s surround alternatives. WIDTH and HEIGHT
160: are in number of characters, XOFF and YOFF are in
161: pixels. WIDTH defaults to 80, HEIGHT to 24, XOFF
162: and YOFF to 1. If you don't give XOFF and/or YOFF,
163: then you must use the mouse to create the window.
164: If you give XOFF and/or YOFF, then a WIDTHxHEIGHT
165: window will automatically be creating without inter-
166: vention. XOFF and YOFF specify deltas from a corner
167: of the screen to the corresponding corner of the
168: window, as follows:
169:
170: +XOFF+YOFF upper left to upper left
171: -XOFF+YOFF upper right to upper right
172: +XOFF-YOFF lower left to lower left
173: -XOFF-YOFF lower right to lower right
174:
175: --ffgg ccoolloorr
176: On color displays, sets the color of the text.
177:
178: --bbgg ccoolloorr
179: On color displays, sets the color of the window's
180: background. See the file /_u_s_r/_l_i_b/_r_g_b._t_x_t for a
181: list of valid _c_o_l_o_r names.
182:
183: --bbdd ccoolloorr
184: On color displays, sets the color of the window's
185: border.See the file /_u_s_r/_l_i_b/_r_g_b._t_x_t for a list of
186: valid _c_o_l_o_r names.
187:
188: --ccrr ccoolloorr
189: On color displays, sets the color of the window's
190: text cursor. See the file /_u_s_r/_l_i_b/_r_g_b._t_x_t for a
191: list of valid _c_o_l_o_r names.
192:
193:
194:
195: Printed 6/29/90 1987 September 1 3
196:
197:
198:
199:
200:
201:
202: EMACS(1) UNIX Programmer's Manual EMACS(1)
203:
204:
205:
206: --mmss ccoolloorr
207: On color displays, sets the color of the window's
208: mouse cursor. See the file /_u_s_r/_l_i_b/_r_g_b._t_x_t for a
209: list of valid _c_o_l_o_r names.
210:
211: --dd ddiissppllaayynnaammee
212: Create the _E_m_a_c_s window on the display specified by
213: _d_i_s_p_l_a_y_n_a_m_e. Must be the first option specified in
214: the command line. --nnww Tells _E_m_a_c_s not to use its
215: special interface to X. If you use this switch when
216: invoking _E_m_a_c_s from an _x_t_e_r_m window, display is done
217: in the _x_t_e_r_m window. This must be the first option
218: specified in the command line.
219:
220: You can set _X default values for your _E_m_a_c_s windows in your
221: ._X_d_e_f_a_u_l_t_s file. Use the following format:
222:
223: emacs.keyword:value
224:
225: where _v_a_l_u_e specifies the default value of _k_e_y_w_o_r_d. _E_m_a_c_s
226: lets you set default values for the following keywords:
227:
228: BBooddyyFFoonntt
229: Sets the window's text font.
230:
231: RReevveerrsseeVViiddeeoo
232: If _R_e_v_e_r_s_e_V_i_d_e_o'_s value is set to _o_n, the window
233: will be displayed in inverse video.
234:
235: BBiittMMaappIIccoonn
236: If _B_i_t_M_a_p_I_c_o_n'_s value is set to _o_n, the window will
237: iconify into the "kitchen sink."
238:
239: BBoorrddeerrWWiiddtthh
240: Sets the window's border width in pixels.
241:
242: FFoorreeggrroouunndd
243: For color displays, sets the window's text color.
244: See the file /_u_s_r/_l_i_b/_r_g_b._t_x_t for a list of valid
245: _c_o_l_o_r names.
246:
247: BBaacckkggrroouunndd
248: For color displays, sets the window's background
249: color. See the file /_u_s_r/_l_i_b/_r_g_b._t_x_t for a list of
250: valid _c_o_l_o_r names.
251:
252: BBoorrddeerr For color displays, sets the color of the window's
253: border. See the file /_u_s_r/_l_i_b/_r_g_b._t_x_t for a list of
254: valid _c_o_l_o_r names.
255:
256: CCuurrssoorr For color displays, sets the color of the window's
257: text cursor. See the file /_u_s_r/_l_i_b/_r_g_b._t_x_t for a
258:
259:
260:
261: Printed 6/29/90 1987 September 1 4
262:
263:
264:
265:
266:
267:
268: EMACS(1) UNIX Programmer's Manual EMACS(1)
269:
270:
271:
272: list of valid _c_o_l_o_r names.
273:
274: MMoouussee For color displays, sets the color of the window's
275: mouse cursor. See the file /_u_s_r/_l_i_b/_r_g_b._t_x_t for a
276: list of valid _c_o_l_o_r names.
277:
278: If you try to set color values while using a black and white
279: display, the window's characteristics will default as fol-
280: lows: the foreground color will be set to black, the back-
281: ground color will be set to white, the border color will be
282: set to grey, and the text and mouse cursors will be set to
283: black.
284:
285:
286: _U_s_i_n_g _t_h_e _M_o_u_s_e
287:
288: The following lists the key bindings for the mouse cursor
289: when used in an _E_m_a_c_s window.
290:
291:
292: MOUSE BUTTON FUNCTION
293: left set mark
294: middle set cursor
295: right select (Emacs) window
296: SHIFT-middle put text into X cut buffer (cut text)
297: SHIFT-right paste text
298: CTRL-middle cut text and kill it
299: CTRL-right select this window, then split it into
300: two windows
301: CTRL-SHIFT-left X buffer menu--hold the buttons and keys
302: down, wait for menu to appear, select
303: buffer, and release. Move mouse out of
304: menu and release to cancel.
305: CTRL-SHIFT-middle X help menu--pop up index card menu for
306: Emacs help.
307: CTRL-SHIFT-right Select window with mouse, and delete all
308: other windows. Same as typing
309: CTRL-x 1.
310:
311:
312: MMAANNUUAALLSS
313: You can order printed copies of the GNU Emacs Manual for
314: $15.00/copy postpaid from the Free Software Foundation,
315: which develops GNU software (contact them for quantity
316: prices on the manual). Their address is:
317: Free Software Foundation
318: 675 Mass Ave.
319: Cambridge, MA 02139
320: Your local Emacs maintainer might also have copies avail-
321: able. As with all software and publications from FSF,
322: everyone is permitted to make and distribute copies of the
323: Emacs manual. The TeX source to the manual is also included
324:
325:
326:
327: Printed 6/29/90 1987 September 1 5
328:
329:
330:
331:
332:
333:
334: EMACS(1) UNIX Programmer's Manual EMACS(1)
335:
336:
337:
338: in the Emacs source distribution.
339:
340: FFIILLEESS
341: /usr/local/emacs/src - C source files and object files
342:
343: /usr/local/emacs/lisp - Lisp source files and compiled files
344: that define most editing commands. Some are preloaded; oth-
345: ers are autoloaded from this directory when used.
346:
347: /usr/local/emacs/man - sources for the Emacs reference
348: manual.
349:
350: /usr/local/emacs/etc - various programs that are used with
351: GNU Emacs, and some files of information.
352:
353: /usr/local/emacs/etc/DOC.* - contains the documentation
354: strings for the Lisp primitives and preloaded Lisp functions
355: of GNU Emacs. They are stored here to reduce the size of
356: Emacs proper.
357:
358: /usr/local/emacs/etc/DIFF discusses GNU Emacs vs. Twenex
359: Emacs;
360: /usr/local/emacs/etc/CCADIFF discusses GNU Emacs vs. CCA
361: Emacs;
362: /usr/local/emacs/etc/GOSDIFF discusses GNU Emacs vs. Gosling
363: Emacs.
364: /usr/local/emacs/etc/SERVICE lists people offering various
365: services to assist users of GNU Emacs, including education,
366: troubleshooting, porting and customization.
367: These files also have information useful to anyone wishing
368: to write programs in the Emacs Lisp extension language,
369: which has not yet been fully documented.
370:
371: /usr/local/emacs/info - files for the Info documentation
372: browser (a subsystem of Emacs) to refer to. Currently not
373: much of Unix is documented here, but the complete text of
374: the Emacs reference manual is included in a convenient tree
375: structured form.
376:
377: /usr/local/emacs/lock - holds lock files that are made for
378: all files being modified in Emacs, to prevent simultaneous
379: modification of one file by two users.
380:
381: /usr/local/emacs/cpp - the GNU cpp, needed for building
382: Emacs on certain versions of Unix where the standard cpp
383: cannot handle long names for macros.
384:
385: /usr/local/emacs/shortnames - facilities for translating
386: long names to short names in C code, needed for building
387: Emacs on certain versions of Unix where the C compiler can-
388: not handle long names for functions or variables.
389:
390:
391:
392:
393: Printed 6/29/90 1987 September 1 6
394:
395:
396:
397:
398:
399:
400: EMACS(1) UNIX Programmer's Manual EMACS(1)
401:
402:
403:
404: BBUUGGSS
405: There is a mailing list, [email protected] on
406: the internet (ucbvax!prep.ai.mit.edu!bug-gnu-emacs on
407: UUCPnet), for reporting Emacs bugs and fixes. But before
408: reporting something as a bug, please try to be sure that it
409: really is a bug, not a misunderstanding or a deliberate
410: feature. We ask you to read the section ``Reporting Emacs
411: Bugs'' near the end of the reference manual (or Info system)
412: for hints on how and when to report bugs. Also, include the
413: version number of the Emacs you are running in _e_v_e_r_y bug
414: report that you send in.
415:
416: Do not expect a personal answer to a bug report. The pur-
417: pose of reporting bugs is to get them fixed for everyone in
418: the next release, if possible. For personal assistance,
419: look in the SERVICE file (see above) for a list of people
420: who offer it.
421:
422: Please do not send anything but bug reports to this mailing
423: list. Send requests to be added to mailing lists to the
424: special list [email protected] (or the
425: corresponding UUCP address). For more information about
426: Emacs mailing lists, see the file
427: /usr/local/emacs/etc/MAILINGLISTS. Bugs tend actually to be
428: fixed if they can be isolated, so it is in your interest to
429: report them in such a way that they can be easily repro-
430: duced.
431:
432: Bugs that I know about are: shell will not work with pro-
433: grams running in Raw mode on some Unix versions.
434:
435: UUNNRREESSTTRRIICCTTIIOONNSS
436: _E_m_a_c_s is free; anyone may redistribute copies of _E_m_a_c_s to
437: anyone under the terms stated in the _E_m_a_c_s General Public
438: License, a copy of which accompanies each copy of _E_m_a_c_s and
439: which also appears in the reference manual.
440:
441: Copies of _E_m_a_c_s may sometimes be received packaged with dis-
442: tributions of Unix systems, but it is never included in the
443: scope of any license covering those systems. Such inclusion
444: violates the terms on which distribution is permitted. In
445: fact, the primary purpose of the General Public License is
446: to prohibit anyone from attaching any other restrictions to
447: redistribution of _E_m_a_c_s.
448:
449: Richard Stallman encourages you to improve and extend _E_m_a_c_s,
450: and urges that you contribute your extensions to the GNU
451: library. Eventually GNU (Gnu's Not Unix) will be a complete
452: replacement for Berkeley Unix. Everyone will be able to use
453: the GNU system for free.
454:
455:
456:
457:
458:
459: Printed 6/29/90 1987 September 1 7
460:
461:
462:
463:
464:
465:
466: EMACS(1) UNIX Programmer's Manual EMACS(1)
467:
468:
469:
470: AAUUTTHHOORRSS
471: _E_m_a_c_s was written by Richard Stallman and the Free Software
472: Foundation. Joachim Martillo and Robert Krawitz added the X
473: features.
474:
475:
476:
477:
478:
479:
480:
481:
482:
483:
484:
485:
486:
487:
488:
489:
490:
491:
492:
493:
494:
495:
496:
497:
498:
499:
500:
501:
502:
503:
504:
505:
506:
507:
508:
509:
510:
511:
512:
513:
514:
515:
516:
517:
518:
519:
520:
521:
522:
523:
524:
525: Printed 6/29/90 1987 September 1 8
526:
527:
528:
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.