Return to emacs.1 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / contrib / emacs-18.55 / etc

Annotation of 43BSDReno/contrib/emacs-18.55/etc/emacs.1, revision 1.1

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

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.