home *** CD-ROM | disk | FTP | other *** search
/ Dr. CD ROM (Annual Premium Edition) / premium.zip / premium / IBMOS2_1 / E17INFO.ZIP / emacs / 19.17 / info / emacs-7 (.txt) < prev    next >
GNU Info File  |  1993-07-18  |  50KB  |  889 lines

  1. This is Info file ../info/emacs, produced by Makeinfo-1.54 from the
  2. input file emacs.texi.
  3. File: emacs,  Node: Log Entries,  Next: Change Logs and VC,  Prev: Variables for Check-in/out,  Up: Version Control
  4. Log Entries
  5. -----------
  6.    When you're editing an initial comment or log entry for inclusion in
  7. a master file, finish your entry by typing `C-c C-c'.
  8. `C-c C-c'
  9.      Finish the comment edit normally (`vc-finish-logentry').  This
  10.      finishes check-in.
  11.    To abort check-in, just don't type `C-c C-c' in that buffer.  You
  12. can switch buffers and do other editing.  As long as you don't try to
  13. check in another file, the entry you were editing remains in its
  14. buffer, and you can go back to that buffer at any time to complete the
  15. check-in.
  16.    If you change several source files for the same reason, it is often
  17. convenient to specify the same log entry for many of the files.  To do
  18. this, use the history of previous log entries.  The commands `M-n',
  19. `M-p', `M-s' and `M-r' for doing this work just like the minibuffer
  20. history commands (except that these versions are used outside the
  21. minibuffer).
  22.    Each time you check in a file, the log entry buffer is put into VC
  23. Log mode, which involves running two hooks: `text-mode-hook' and
  24. `vc-log-mode-hook'.  *Note Hooks::.
  25. File: emacs,  Node: Change Logs and VC,  Next: Comparing Versions,  Prev: Log Entries,  Up: Version Control
  26. Change Logs and VC
  27. ------------------
  28.    If you use RCS for a program and also maintain a change log file for
  29. it (*note Change Log::.), you can generate change log entries
  30. automatically from the version control log entries:
  31. `C-x v a'
  32.      Visit the current directory's change log file and create new
  33.      entries for versions checked in since the most recent entry in the
  34.      change log file (`vc-update-change-log').
  35.      This command works with RCS only; it does not work with SCCS.
  36.    For example, suppose the first line of `ChangeLog' is dated 10 April
  37. 1992, and that the only check-in since then was by Nathaniel Bowditch
  38. to `rcs2log' on 8 May 1992 with log text `Ignore log messages that
  39. start with `#'.'.  Then `C-x v a' visits `ChangeLog' and inserts text
  40. like this:
  41.      Fri May  8 21:45:00 1992  Nathaniel Bowditch  (nat@apn.org)
  42.      
  43.              * rcs2log: Ignore log messages that start with `#'.
  44. You can then edit the new change log entry further as you wish.
  45.    Normally, the log entry for file `foo' is displayed as `* foo: TEXT
  46. OF LOG ENTRY'.  The `:' after `foo' is omitted if the text of the log
  47. entry starts with `(FUNCTIONNAME): '.  For example, if the log entry
  48. for `vc.el' is `(vc-do-command): Check call-process status.', then the
  49. text in `ChangeLog' looks like this:
  50.      Wed May  6 10:53:00 1992  Nathaniel Bowditch  (nat@apn.org)
  51.      
  52.              * vc.el (vc-do-command): Check call-process status.
  53.    When `C-x v a' adds several change log entries at once, it groups
  54. related log entries together if they all are checked in by the same
  55. author at nearly the same time.  If the log entries for several such
  56. files all have the same text, it coalesces them into a single entry.
  57. For example, suppose the most recent checkins have the following log
  58. entries:
  59. For `vc.texinfo':
  60.      Fix expansion typos.
  61. For `vc.el':
  62.      Don't call expand-file-name.
  63. For `vc-hooks.el':
  64.      Don't call expand-file-name.
  65.    They appear like this in `ChangeLog':
  66.      Wed Apr  1 08:57:59 1992  Nathaniel Bowditch  (nat@apn.org)
  67.      
  68.              * vc.texinfo: Fix expansion typos.
  69.      
  70.              * vc.el, vc-hooks.el: Don't call expand-file-name.
  71.    Normally, `C-x v a' separates log entries by a blank line, but you
  72. can mark several related log entries to be clumped together (without an
  73. intervening blank line) by starting the text of each related log entry
  74. with a label of the form `{CLUMPNAME} '.  The label itself is not
  75. copied to `ChangeLog'.  For example, suppose the log entries are:
  76. For `vc.texinfo':
  77.      {expand} Fix expansion typos.
  78. For `vc.el':
  79.      {expand} Don't call expand-file-name.
  80. For `vc-hooks.el':
  81.      {expand} Don't call expand-file-name.
  82. Then the text in `ChangeLog' looks like this:
  83.      Wed Apr  1 08:57:59 1992  Nathaniel Bowditch  (nat@apn.org)
  84.      
  85.              * vc.texinfo: Fix expansion typos.
  86.              * vc.el, vc-hooks.el: Don't call expand-file-name.
  87.    A log entry whose text begins with `#' is not copied to `ChangeLog'.
  88. For example, if you merely fix some misspellings in comments, you can
  89. log the change with an entry beginning with `#' to avoid putting such
  90. trivia into `ChangeLog'.
  91. File: emacs,  Node: Comparing Versions,  Next: VC Status,  Prev: Change Logs and VC,  Up: Version Control
  92. Comparing Versions
  93. ------------------
  94.    To compare two versions of a file, use the command `C-x v ='
  95. (`vc-diff').
  96.    Plain `C-x v =' compares the current buffer contents (saving them in
  97. the file if necessary) with the last checked-in version of the file.
  98. With a prefix argument, `C-x v =' reads a file name and two version
  99. numbers, then compares those versions of the specified file.
  100.    If you supply a directory name instead of the name of a work file,
  101. this command compares the two specified versions of all registered files
  102. in that directory and its subdirectories.  You can also specify a
  103. snapshot name (*note Snapshots::.) instead of one or both version
  104. numbers.
  105.    You can specify a checked-in version by its number; you can specify
  106. the most recent checked-in version with an empty version number.
  107.    This command works by running the `diff' utility, getting the
  108. options from the variable `diff-switches'.  It displays the output in a
  109. special buffer in another window.  Unlike the `M-x diff' command, `C-x
  110. v =' does not try to find the changes in the old and new versions.
  111. This is because one or both versions normally do not exist as files.
  112. They exist only in the records of the master file.  *Note Comparing
  113. Files::, for more information about `M-x diff'.
  114. File: emacs,  Node: VC Status,  Next: Renaming and VC,  Prev: Comparing Versions,  Up: Version Control
  115. VC Status Commands
  116. ------------------
  117.    To view the detailed version control status and history of a file,
  118. type `C-x v l' (`vc-print-log').  It displays the history of changes to
  119. the current file, including the text of the log entries.  The output
  120. appears in a separate window.
  121.    When you are working on a large program, it's often useful to find
  122. all the files that are currently locked, or all the files maintained in
  123. version control at all.  You can use `C-x v d' (`vc-directory') to show
  124. all the locked files in or beneath the current directory.  This
  125. includes all files that are locked by any user.  `C-u C-x v d' lists
  126. all files in or beneath the current directory that are maintained with
  127. version control.
  128.    The list of files is displayed as a buffer that uses an augmented
  129. Dired mode.  The names of the users locking various files are shown (in
  130. parentheses) in place of the owner and group.  All the normal Dired
  131. commands work in this buffer.  Most interactive VC commands work also,
  132. and apply to the file name on the current line.
  133.    The `vc-next-action' command, when used in the augmented Dired
  134. buffer, operates on all the marked files (or the file on the current
  135. line).  If it operates on more than one file, it handles each file
  136. according to its current state; thus, it may check in one file and check
  137. in another (which is already checked out).  If it has to check in any
  138. files, it reads a single log entry, then uses that text for all the
  139. files being checked in.  This can be convenient for registering or
  140. checking in several files at once, as part of the same change.
  141. File: emacs,  Node: Renaming and VC,  Next: Snapshots,  Prev: VC Status,  Up: Version Control
  142. Renaming VC Work Files and Master Files
  143. ---------------------------------------
  144.    When you rename a registered file, you must also rename its master
  145. file correspondingly to get proper results.  Use `vc-rename-file' to
  146. rename the source file as you specify, and rename its master file
  147. accordingly.  It also updates any snapshots (*note Snapshots::.) that
  148. mention the file, so that they use the new name; despite this, the
  149. snapshot thus modified may not completely work (*note Snapshot
  150. Caveats::.).
  151.    You cannot use `vc-rename-file' on a file that is locked by someone
  152. else.
  153. File: emacs,  Node: Snapshots,  Next: Version Headers,  Prev: Renaming and VC,  Up: Version Control
  154. Snapshots
  155. ---------
  156.    A "snapshot" is a named set of file versions (one for each
  157. registered file) that you can treat as a unit.  One important kind of
  158. snapshot is a "release", a (theoretically) stable version of the system
  159. that is ready for distribution to users.
  160. * Menu:
  161. * Making Snapshots::        The snapshot facilities.
  162. * Snapshot Caveats::        Things to be careful of when using snapshots.
  163. File: emacs,  Node: Making Snapshots,  Next: Snapshot Caveats,  Up: Snapshots
  164. Making and Using Snapshots
  165. ..........................
  166.    There are two basic commands for snapshots; one makes a snapshot
  167. with a given name, the other retrieves a named snapshot.
  168. `C-x v s NAME RET'
  169.      Define the last saved versions of every registered file in or
  170.      under the current directory as a snapshot named NAME
  171.      (`vc-create-snapshot').
  172. `C-x v r NAME RET'
  173.      Check out all registered files at or below the current directory
  174.      level using whatever versions correspond to the snapshot NAME
  175.      (`vc-retrieve-snapshot').
  176.      This command reports an error if any files are locked at or below
  177.      the current directory, without changing anything; this is to avoid
  178.      overwriting work in progress.
  179.    A snapshot uses a very small amount of resources--just enough to
  180. record the list of file names and which version belongs to the
  181. snapshot.  Thus, you need not hesitate to create snapshots whenever
  182. they are useful.
  183.    You can give a snapshot name as an argument to `C-x v =' (*note
  184. Comparing Versions::.).  Thus, you can use it to compare a snapshot
  185. against the current files, or two snapshots against each other, or a
  186. snapshot against a named version.
  187. File: emacs,  Node: Snapshot Caveats,  Prev: Making Snapshots,  Up: Snapshots
  188. Snapshot Caveats
  189. ................
  190.    VC's snapshot facilities are modeled on RCS's named-configuration
  191. support.  They use RCS's native facilities for this, so under VC
  192. snapshots made using RCS are visible even when you bypass VC.
  193.    For SCCS, VC implements snapshots itself.  The files it uses contain
  194. name/file/version-number triples.  These snapshots are visible only
  195. through VC.
  196.    File renaming and deletion can create some difficulties with
  197. snapshots.  This is not a VC-specific problem, but a general design
  198. issue in version control systems that no one has solved very well yet.
  199.    If you rename a registered file, you need to rename its master along
  200. with it (the command `vc-rename-file' does this automatically).  If you
  201. are using SCCS, you must also update the records of the snapshot, to
  202. mention the file by its new name (`vc-rename-file' does this, too).  An
  203. old snapshot that refers to a master file that no longer exists under
  204. the recorded name is invalid; VC can no longer retrieve it.  It would
  205. be beyond the scope of this manual to explain enough about RCS and SCCS
  206. to explain how to update the snapshots by hand.
  207.    Using `vc-rename-file' makes the snapshot remain valid for
  208. retrieval, but it does not solve all problems.  For example, some of the
  209. files in the program probably refer to others by name.  At the very
  210. least, the makefile probably mentions the file that you renamed.  If you
  211. retrieve an old snapshot, the renamed file is retrieved under its new
  212. name, which is not the name that the makefile expects.  So the program
  213. won't really work as retrieved.
  214. File: emacs,  Node: Version Headers,  Prev: Snapshots,  Up: Version Control
  215. Inserting Version Control Headers
  216. ---------------------------------
  217.    Sometimes it is convenient to put version identification strings
  218. directly into working files.  Certain special strings called "version
  219. headers" are replaced in each successive version by the number of that
  220. version.
  221.    You can use the `C-x v h' command (`vc-insert-headers') to insert a
  222. suitable header string.
  223. `C-x v h'
  224.      Insert headers in a file for use with your version-control system.
  225.    The default header string is `$Id$' for RCS and `%W%' for SCCS.  You
  226. can specify other headers to insert by setting the variable
  227. `vc-header-alist'.  Its value is a list of elements of the form
  228. `(PROGRAM . STRING)' where PROGRAM is `RCS' or `SCCS' and STRING is the
  229. string to use.
  230.    Instead of a single string, you can specify a list of strings; then
  231. each string in the list is inserted as a separate header on a line of
  232. its own.
  233.    It is often necessary to use "superfluous" backslashes when writing
  234. the strings that you put in this variable.  This is to prevent the
  235. string in the constant from being interpreted as a header itself if the
  236. Emacs Lisp file containing it is maintained with version control.
  237.    Each header is inserted surrounded by tabs, inside comment
  238. delimiters, on a new line at the start of the buffer.  Normally the
  239. ordinary comment start and comment end strings of the current mode are
  240. used, but for certain modes, there are special comment delimiters for
  241. this purpose; the variable `vc-comment-alist' specifies them.  Each
  242. element of this list has the form `(MODE STARTER ENDER)'.
  243.    The variable `vc-static-header-alist' specifies further strings to
  244. add based on the name of the buffer.  Its value should be a list of
  245. elements of the form `(REGEXP . FORMAT)'.  Whenever REGEXP matches the
  246. buffer name, FORMAT is inserted as part of the header.  A header line
  247. is inserted for each element that matches the buffer name, and for each
  248. string specified by `vc-header-alist'.  The header line is made by
  249. processing the string from `vc-header-alist' with the format taken from
  250. the element.  The default value for `vc-static-header-alist' is:
  251.      (("\\.c$" .
  252.        "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n\
  253.      #endif /* lint */\n"))
  254. which specifies insertion of a string of this form:
  255.      #ifndef lint
  256.      static char vcid[] = "STRING";
  257.      #endif /* lint */
  258. File: emacs,  Node: ListDir,  Next: Comparing Files,  Prev: Version Control,  Up: Files
  259. Listing a File Directory
  260. ========================
  261.    The file system groups files into "directories".  A "directory
  262. listing" is a list of all the files in a directory.  Emacs provides
  263. directory listings in brief format (file names only) and verbose format
  264. (sizes, dates, and authors included).
  265. `C-x C-d DIR-OR-PATTERN'
  266.      Print a brief directory listing (`list-directory').
  267. `C-u C-x C-d DIR-OR-PATTERN'
  268.      Print a verbose directory listing.
  269.    The command to display a directory listing is `C-x C-d'
  270. (`list-directory').  It reads using the minibuffer a file name which is
  271. either a directory to be listed or a wildcard-containing pattern for
  272. the files to be listed.  For example,
  273.      C-x C-d /u2/emacs/etc RET
  274. lists all the files in directory `/u2/emacs/etc'.  An example of
  275. specifying a file name pattern is
  276.      C-x C-d /u2/emacs/src/*.c RET
  277.    Normally, `C-x C-d' prints a brief directory listing containing just
  278. file names.  A numeric argument (regardless of value) tells it to print
  279. a verbose listing (like `ls -l').
  280.    The text of a directory listing is obtained by running `ls' in an
  281. inferior process.  Two Emacs variables control the switches passed to
  282. `ls': `list-directory-brief-switches' is a string giving the switches
  283. to use in brief listings (`"-CF"' by default), and
  284. `list-directory-verbose-switches' is a string giving the switches to
  285. use in a verbose listing (`"-l"' by default).
  286. File: emacs,  Node: Comparing Files,  Next: Misc File Ops,  Prev: ListDir,  Up: Files
  287. Comparing Files
  288. ===============
  289.    The command `M-x diff' compares two files, displaying the
  290. differences in an Emacs buffer named `*Diff*'.  It works by running the
  291. `diff' program, using options taken from the variable `diff-switches',
  292. whose value should be a string.
  293.    The buffer `*Diff*' has Compilation mode as its major mode, so you
  294. can use `C-x `' to visit successive changed locations in the two source
  295. files.  You can also move to a particular hunk of changes and type `C-c
  296. C-c' to find the corresponding source location.  You can also use the
  297. other special commands of Compilation mode: SPC and DEL for scrolling,
  298. and `M-p' and `M-n' for cursor motion.  *Note Compilation::.
  299.    The command `M-x diff-backup' compares a specified file with its most
  300. recent backup.  If you specify the name of a backup file, `diff-backup'
  301. compares it with the source file that it is a backup of.
  302.    The command `M-x compare-windows' compares the text in the current
  303. window with that in the next window.  Comparison starts at point in each
  304. window.  Point moves forward in each window, a character at a time in
  305. each window, until the next characters in the two windows are
  306. different.  Then the command is finished.  For more information about
  307. windows in Emacs, *Note Windows::.
  308.    With a numeric argument, `compare-windows' ignores changes in
  309. whitespace.  If the variable `compare-ignore-case' is non-`nil', it
  310. ignores differences in case as well.
  311.    See also *Note Emerge::, for convenient facilities for merging two
  312. similar files.
  313. File: emacs,  Node: Misc File Ops,  Prev: Comparing Files,  Up: Files
  314. Miscellaneous File Operations
  315. =============================
  316.    Emacs has commands for performing many other operations on files.
  317. All operate on one file; they do not accept wild card file names.
  318.    `M-x view-file' allows you to scan or read a file by sequential
  319. screenfuls.  It reads a file name argument using the minibuffer.  After
  320. reading the file into an Emacs buffer, `view-file' displays the
  321. beginning.  You can then type SPC to scroll forward one windowful, or
  322. DEL to scroll backward.  Various other commands are provided for moving
  323. around in the file, but none for changing it; type `C-h' while viewing
  324. for a list of them.  They are mostly the same as normal Emacs cursor
  325. motion commands.  To exit from viewing, type `C-c'.  The commands for
  326. viewing are defined by a special major mode called View mode.
  327.    A related command, `M-x view-buffer', views a buffer already present
  328. in Emacs.  *Note Misc Buffer::.
  329.    `M-x insert-file' inserts a copy of the contents of the specified
  330. file into the current buffer at point, leaving point unchanged before
  331. the contents and the mark after them.
  332.    `M-x write-region' is the inverse of `M-x insert-file'; it copies
  333. the contents of the region into the specified file.  `M-x
  334. append-to-file' adds the text of the region to the end of the specified
  335. file.  *Note Accumulating Text::.
  336.    `M-x delete-file' deletes the specified file, like the `rm' command
  337. in the shell.  If you are deleting many files in one directory, it may
  338. be more convenient to use Dired (*note Dired::.).
  339.    `M-x rename-file' reads two file names OLD and NEW using the
  340. minibuffer, then renames file OLD as NEW.  If a file named NEW already
  341. exists, you must confirm with `yes' or renaming is not done; this is
  342. because renaming causes the old meaning of the name NEW to be lost.  If
  343. OLD and NEW are on different file systems, the file OLD is copied and
  344. deleted.
  345.    The similar command `M-x add-name-to-file' is used to add an
  346. additional name to an existing file without removing its old name.  The
  347. new name must belong on the same file system that the file is on.
  348.    `M-x copy-file' reads the file OLD and writes a new file named NEW
  349. with the same contents.  Confirmation is required if a file named NEW
  350. already exists, because copying has the consequence of overwriting the
  351. old contents of the file NEW.
  352.    `M-x make-symbolic-link' reads two file names OLD and LINKNAME, then
  353. creates a symbolic link named LINKNAME and pointing at OLD.  The effect
  354. is that future attempts to open file LINKNAME will refer to whatever
  355. file is named OLD at the time the opening is done, or will get an error
  356. if the name OLD is not in use at that time.  This command does not
  357. expand the argument FILENAME, so that it allows you to specify a
  358. relative name as the target of the link.
  359.    Confirmation is required when creating the link if LINKNAME is in
  360. use.  Note that not all systems support symbolic links.
  361. File: emacs,  Node: Buffers,  Next: Windows,  Prev: Files,  Up: Top
  362. Using Multiple Buffers
  363. **********************
  364.    The text you are editing in Emacs resides in an object called a
  365. "buffer".  Each time you visit a file, a buffer is created to hold the
  366. file's text.  Each time you invoke Dired, a buffer is created to hold
  367. the directory listing.  If you send a message with `C-x m', a buffer
  368. named `*mail*' is used to hold the text of the message.  When you ask
  369. for a command's documentation, that appears in a buffer called `*Help*'.
  370.    At any time, one and only one buffer is "selected".  It is also
  371. called the "current buffer".  Often we say that a command operates on
  372. "the buffer" as if there were only one; but really this means that the
  373. command operates on the selected buffer (most commands do).
  374.    When Emacs has multiple windows, each window has a chosen buffer
  375. which is displayed there, but at any time only one of the windows is
  376. selected and its chosen buffer is the selected buffer.  Each window's
  377. mode line displays the name of the buffer that the window is displaying
  378. (*note Windows::.).
  379.    Each buffer has a name, which can be of any length, and you can
  380. select any buffer by giving its name.  Most buffers are made by
  381. visiting files, and their names are derived from the files' names.  But
  382. you can also create an empty buffer with any name you want.  A newly
  383. started Emacs has a buffer named `*scratch*' which can be used for
  384. evaluating Lisp expressions in Emacs.  The distinction between upper
  385. and lower case matters in buffer names.
  386.    Each buffer records individually what file it is visiting, whether
  387. it is modified, and what major mode and minor modes are in effect in it
  388. (*note Major Modes::.).  Any Emacs variable can be made "local to" a
  389. particular buffer, meaning its value in that buffer can be different
  390. from the value in other buffers.  *Note Locals::.
  391. * Menu:
  392. * Select Buffer::   Creating a new buffer or reselecting an old one.
  393. * List Buffers::    Getting a list of buffers that exist.
  394. * Misc Buffer::     Renaming; changing read-onliness; copying text.
  395. * Kill Buffer::     Killing buffers you no longer need.
  396. * Several Buffers:: How to go through the list of all buffers
  397.                       and operate variously on several of them.
  398. File: emacs,  Node: Select Buffer,  Next: List Buffers,  Up: Buffers
  399. Creating and Selecting Buffers
  400. ==============================
  401. `C-x b BUFFER RET'
  402.      Select or create a buffer named BUFFER (`switch-to-buffer').
  403. `C-x 4 b BUFFER RET'
  404.      Similar, but select BUFFER in another window
  405.      (`switch-to-buffer-other-window').
  406.    To select the buffer named BUFNAME, type `C-x b BUFNAME RET'.  This
  407. runs the command `switch-to-buffer' with argument BUFNAME.  You can use
  408. completion on an abbreviation for the buffer name you want (*note
  409. Completion::.).  An empty argument to `C-x b' specifies the most
  410. recently selected buffer that is not displayed in any window.
  411.    Most buffers are created by visiting files, or by Emacs commands that
  412. want to display some text, but you can also create a buffer explicitly
  413. by typing `C-x b BUFNAME RET'.  This makes a new, empty buffer which is
  414. not visiting any file, and selects it for editing.  Such buffers are
  415. used for making notes to yourself.  If you try to save one, you are
  416. asked for the file name to use.  The new buffer's major mode is
  417. determined by the value of `default-major-mode' (*note Major Modes::.).
  418.    Note that `C-x C-f', and any other command for visiting a file, can
  419. also be used to switch buffers.  *Note Visiting::.
  420. File: emacs,  Node: List Buffers,  Next: Misc Buffer,  Prev: Select Buffer,  Up: Buffers
  421. Listing Existing Buffers
  422. ========================
  423. `C-x C-b'
  424.      List the existing buffers (`list-buffers').
  425.    To print a list of all the buffers that exist, type `C-x C-b'.  Each
  426. line in the list shows one buffer's name, major mode and visited file.
  427. The buffers are listed in the order, most recently visited first.
  428.    `*' at the beginning of a line indicates the buffer is "modified".
  429. If several buffers are modified, it may be time to save some with `C-x
  430. s' (*note Saving::.).  `%' indicates a read-only buffer.  `.' marks the
  431. selected buffer.  Here is an example of a buffer list:
  432.       MR Buffer         Size  Mode           File
  433.       -- ------         ----  ----           ----
  434.      .*  emacs.tex      383402 Texinfo       /u2/emacs/man/emacs.tex
  435.          *Help*         1287  Fundamental
  436.          files.el       23076 Emacs-Lisp     /u2/emacs/lisp/files.el
  437.        % RMAIL          64042 RMAIL          /u/rms/RMAIL
  438.       *% man            747   Dired          /u2/emacs/man/
  439.          net.emacs      343885 Fundamental   /u/rms/net.emacs
  440.          fileio.c       27691 C              /u2/emacs/src/fileio.c
  441.          NEWS           67340 Text           /u2/emacs/etc/NEWS
  442.          *scratch*       0     Lisp Interaction
  443. Note that the buffer `*Help*' was made by a help request; it is not
  444. visiting any file.  The buffer `man' was made by Dired on the directory
  445. `/u2/emacs/man/'.
  446. File: emacs,  Node: Misc Buffer,  Next: Kill Buffer,  Prev: List Buffers,  Up: Buffers
  447. Miscellaneous Buffer Operations
  448. ===============================
  449. `C-x C-q'
  450.      Toggle read-only status of buffer (`toggle-read-only').
  451. `M-x rename-buffer RET NAME RET'
  452.      Change the name of the current buffer.
  453. `M-x rename-uniquely'
  454.      Rename the current buffer by adding `<NUMBER>' to the end.
  455. `M-x view-buffer RET BUFFER RET'
  456.      Scroll through buffer BUFFER.
  457.    A buffer can be "read-only", which means that commands to change its
  458. contents are not allowed.  The mode line indicates read-only buffers
  459. with `%%' near the left margin.
  460.    Read-only buffers are made by subsystems such as Dired and Rmail that
  461. have special commands to operate on the text; also if you visit a file
  462. that is protected so you cannot write it.  If you wish to make changes
  463. in a read-only buffer, use the command `C-x C-q'
  464. (`vc-toggle-read-only').  It makes a read-only buffer writable, and
  465. makes a writable buffer read-only.  This works by setting the variable
  466. `buffer-read-only', which has a local value in each buffer and makes
  467. the buffer read-only if its value is non-`nil'.
  468.    If the file is maintained with version control, `C-x C-q' works
  469. through the version control system to change the read-only status of
  470. the buffer.
  471.    `M-x rename-buffer' changes the name of the current buffer.  Specify
  472. the new name as a minibuffer argument.  There is no default.  If you
  473. specify a name that is in use for some other buffer, an error happens
  474. and no renaming is done.
  475.    `M-x rename-uniquely' renames the current buffer to a similar name
  476. with a numeric suffix added to make it both different and unique.  This
  477. command does not need an argument.  It is useful for creating multiple
  478. shell buffers: if you rename the `*Shell*', then do `M-x shell' again,
  479. it makes a new shell buffer named `*Shell*'; meanwhile, the old shell
  480. buffer continues to exist under its altered name.  This method is also
  481. good for mail buffers, compilation buffers, and any Emacs feature which
  482. creates a special buffer with a particular name.
  483.    `M-x view-buffer' is much like `M-x view-file' (*note Misc File
  484. Ops::.) except that it examines an already existing Emacs buffer.  View
  485. mode provides commands for scrolling through the buffer conveniently
  486. but not for changing it.  When you exit View mode, the value of point
  487. that resulted from your perusal remains in effect.
  488.    The commands `M-x append-to-buffer' and `M-x insert-buffer' can be
  489. used to copy text from one buffer to another.  *Note Accumulating
  490. Text::.
  491. File: emacs,  Node: Kill Buffer,  Next: Several Buffers,  Prev: Misc Buffer,  Up: Buffers
  492. Killing Buffers
  493. ===============
  494.    If you continue an Emacs session for a while, you may accumulate a
  495. large number of buffers.  You may then find it convenient to "kill" the
  496. buffers you no longer need.  On most operating systems, killing a
  497. buffer releases its space back to the operating system so that other
  498. programs can use it.  There are several commands for killing buffers:
  499. `C-x k BUFNAME RET'
  500.      Kill buffer BUFNAME (`kill-buffer').
  501. `M-x kill-some-buffers'
  502.      Offer to kill each buffer, one by one.
  503.    `C-x k' (`kill-buffer') kills one buffer, whose name you specify in
  504. the minibuffer.  The default, used if you type just RET in the
  505. minibuffer, is to kill the current buffer.  If you kill the current
  506. buffer, another buffer is selected; one that has been selected recently
  507. but does not appear in any window now.  If you ask to kill a buffer
  508. that is modified (has unsaved editing), then you must confirm with
  509. `yes' before the buffer is killed.
  510.    The command `M-x kill-some-buffers' asks about each buffer, one by
  511. one.  An answer of `y' means to kill the buffer.  Killing the current
  512. buffer or a buffer containing unsaved changes selects a new buffer or
  513. asks for confirmation just like `kill-buffer'.
  514.    If you want to do something special every time a buffer is killed,
  515. you can add hook functions to the hook `kill-buffer-hook' (*note
  516. Hooks::.).
  517. File: emacs,  Node: Several Buffers,  Prev: Kill Buffer,  Up: Buffers
  518. Operating on Several Buffers
  519. ============================
  520.    The "buffer-menu" facility is like a "Dired for buffers"; it allows
  521. you to request operations on various Emacs buffers by editing an Emacs
  522. buffer containing a list of them.  You can save buffers, kill them
  523. (here called "deleting" them, for consistency with Dired), or display
  524. them.
  525. `M-x buffer-menu'
  526.      Begin editing a buffer listing all Emacs buffers.
  527.    The command `buffer-menu' writes a list of all Emacs buffers into
  528. the buffer `*Buffer List*', and selects that buffer in Buffer Menu
  529. mode.  The buffer is read-only, and can be changed only through the
  530. special commands described in this section.  The usual Emacs cursor
  531. motion commands can be used in the `*Buffer List*' buffer.  The
  532. following commands apply to the buffer described on the current line.
  533.      Request to delete (kill) the buffer, then move down.  The request
  534.      shows as a `D' on the line, before the buffer name.  Requested
  535.      deletions take place when you type the `x' command.
  536. `C-d'
  537.      Like `d' but move up afterwards instead of down.
  538.      Request to save the buffer.  The request shows as an `S' on the
  539.      line.  Requested saves take place when you type the `x' command.
  540.      You may request both saving and deletion for the same buffer.
  541.      Perform previously requested deletions and saves.
  542.      Remove any request made for the current line, and move down.
  543. `DEL'
  544.      Move to previous line and remove any request made for that line.
  545.    The `d', `s' and `u' commands to add or remove flags also move down
  546. a line.  They accept a numeric argument as a repeat count.
  547.    These commands operate immediately on the buffer listed on the
  548. current line:
  549.      Mark the buffer "unmodified".  The command `~' does this
  550.      immediately when you type it.
  551.      Toggle the buffer's read-only flag.  The command `%' does this
  552.      immediately when you type it.
  553.      Visit the buffer as a tag table.
  554.    There are also commands to select another buffer or buffers:
  555.      Quit the buffer menu--immediately display the most recent formerly
  556.      visible buffer in its place.
  557.      Immediately select this line's buffer in place of the `*Buffer
  558.      List*' buffer.
  559.      Immediately select this line's buffer in another window as if by
  560.      `C-x 4 b', leaving `*Buffer List*' visible.
  561. `C-o'
  562.      Immediately display this line's buffer in another window, but don't
  563.      select the window.
  564.      Immediately select this line's buffer in a full-screen window.
  565.      Immediately set up two windows, with this line's buffer in one,
  566.      and the previously selected buffer (aside from the buffer `*Buffer
  567.      List*') in the other.
  568.      Mark this line's buffer to be displayed in another window if the
  569.      `q' command is used.  The request shows as a `>' at the beginning
  570.      of the line.  The same buffer may not have both a delete request
  571.      and a display request.
  572.      Immediately select this line's buffer, and also display in other
  573.      windows any buffers previously marked with the `m' command.  If
  574.      you have not marked any buffers, this command is equivalent to `1'.
  575.    All that `buffer-menu' does directly is create and select a suitable
  576. buffer, and turn on Buffer Menu mode.  Everything else described above
  577. is implemented by the special commands provided in Buffer Menu mode.
  578. One consequence of this is that you can switch from the `*Buffer List*'
  579. buffer to another Emacs buffer, and edit there.  You can reselect the
  580. `buffer-menu' buffer later, to perform the operations already
  581. requested, or you can kill it, or pay no further attention to it.
  582.    The only difference between `buffer-menu' and `list-buffers' is that
  583. `buffer-menu' selects the `*Buffer List*' buffer and `list-buffers'
  584. does not.  If you run `list-buffers' (that is, type `C-x C-b') and
  585. select the buffer list manually, you can use all of the commands
  586. described here.
  587.    The buffer `*Buffer List*' is not updated automatically; its
  588. contents are just text.  If you have created, deleted or renamed
  589. buffers, the way to update `*Buffer List*' to show what you have done
  590. is to repeat the `buffer-menu' command.
  591. File: emacs,  Node: Windows,  Next: Frames,  Prev: Buffers,  Up: Top
  592. Multiple Windows
  593. ****************
  594.    Emacs can split a frame into two or many windows.  Multiple windows
  595. can display parts of different buffers, or different parts of one
  596. buffer.  Multiple frames always imply multiple windows, because each
  597. window belongs to one and only one frame.
  598. * Menu:
  599. * Basic Window::     Introduction to Emacs windows.
  600. * Split Window::     New windows are made by splitting existing windows.
  601. * Other Window::     Moving to another window or doing something to it.
  602. * Pop Up Window::    Finding a file or buffer in another window.
  603. * Change Window::    Deleting windows and changing their sizes.
  604. File: emacs,  Node: Basic Window,  Next: Split Window,  Prev: Windows,  Up: Windows
  605. Concepts of Emacs Windows
  606. =========================
  607.    When multiple windows are being displayed, each window has an Emacs
  608. buffer designated for display in it.  The same buffer may appear in more
  609. than one window; if it does, any changes in its text are displayed in
  610. all the windows where it appears.  But the windows showing the same
  611. buffer can show different parts of it, because each window has its own
  612. value of point.
  613.    At any time, one of the windows is the "selected window"; the buffer
  614. this window is displaying is the current buffer.  The terminal's cursor
  615. shows the location of point in this window.  Each other window has a
  616. location of point as well, but since the terminal has only one cursor
  617. there is no way to show where those locations are.  When you make
  618. multiple frames, each frame has a cursor which appears in the frame's
  619. selected window.
  620.    Commands to move point affect the value of point for the selected
  621. Emacs window only.  They do not change the value of point in any other
  622. Emacs window, even one showing the same buffer.  The same is true for
  623. commands such as `C-x b' to change the selected buffer in the selected
  624. window; they do not affect other windows at all.  However, there are
  625. other commands such as `C-x 4 b' that select a different window and
  626. switch buffers in it.  Also, all commands that display information in a
  627. window, including (for example) `C-h f' (`describe-function') and `C-x
  628. C-b' (`list-buffers'), work by switching buffers in a nonselected window
  629. without affecting the selected window.
  630.    When multiple windows show the same buffer, they can have different
  631. regions, because they can have different values of point.  This means
  632. that in Transient Mark mode, each window highlights a different part of
  633. the buffer.  The part that is highlighted in the selected window is the
  634. region that editing commands use.
  635.    Each window has its own mode line, which displays the buffer name,
  636. modification status and major and minor modes of the buffer that is
  637. displayed in the window.  *Note Mode Line::, for full details on the
  638. mode line.
  639. File: emacs,  Node: Split Window,  Next: Other Window,  Prev: Basic Window,  Up: Windows
  640. Splitting Windows
  641. =================
  642. `C-x 2'
  643.      Split the selected window into two windows, one above the other
  644.      (`split-window-vertically').
  645. `C-x 3'
  646.      Split the selected window into two windows positioned side by side
  647.      (`split-window-horizontally').
  648.    The command `C-x 2' (`split-window-vertically') breaks the selected
  649. window into two windows, one above the other.  Both windows start out
  650. displaying the same buffer, with the same value of point.  By default
  651. the two windows each get half the height of the window that was split; a
  652. numeric argument specifies how many lines to give to the top window.
  653.    `C-x 3' (`split-window-horizontally') breaks the selected window
  654. into two side-by-side windows.  A numeric argument specifies how many
  655. columns to give the one on the left.  A line of vertical bars separates
  656. the two windows.  Windows that are not the full width of the screen
  657. have mode lines, but they are truncated; also, they do not always
  658. appear in inverse video, because the Emacs display routines have not
  659. been taught how to display a region of inverse video that is only part
  660. of a line on the screen.
  661.    When a window is less than the full width, text lines too long to
  662. fit are frequent.  Continuing all those lines might be confusing.  The
  663. variable `truncate-partial-width-windows' can be set non-`nil' to force
  664. truncation in all windows less than the full width of the screen,
  665. independent of the buffer being displayed and its value for
  666. `truncate-lines'.  *Note Continuation Lines::.
  667.    Horizontal scrolling is often used in side-by-side windows.  *Note
  668. Display::.
  669.    If `split-window-keep-point' is non-nil, `C-x 2' tries to avoid
  670. shifting any text on the screen by putting point in whichever window
  671. happens to contain the screen line the cursor is already on.  The
  672. default is that `split-window-keep-point' is non-nil on slow terminals.
  673. File: emacs,  Node: Other Window,  Next: Pop Up Window,  Prev: Split Window,  Up: Windows
  674. Using Other Windows
  675. ===================
  676. `C-x o'
  677.      Select another window (`other-window').  That is `o', not zero.
  678. `C-M-v'
  679.      Scroll the next window (`scroll-other-window').
  680. `M-x compare-windows'
  681.      Find next place where the text in the selected window does not
  682.      match the text in the next window.
  683.    To select a different window, use `C-x o' (`other-window').  That is
  684. an `o', for `other', not a zero.  When there are more than two windows,
  685. this command moves through all the windows in a cyclic order, generally
  686. top to bottom and left to right.  After the rightmost and bottommost
  687. window, it goes back to the one at the upper left corner.  A numeric
  688. argument means to move several steps in the cyclic order of windows.  A
  689. negative argument moves around the cycle in the opposite order.  When
  690. the minibuffer is active, the minibuffer is the last window in the
  691. cycle; you can switch from the minibuffer window to one of the other
  692. windows, and later switch back and finish supplying the minibuffer
  693. argument that is requested.  *Note Minibuffer Edit::.
  694.    The usual scrolling commands (*note Display::.) apply to the selected
  695. window only, but there is one command to scroll the next window.
  696. `C-M-v' (`scroll-other-window') scrolls the window that `C-x o' would
  697. select.  It takes arguments, positive and negative, like `C-v'.  (In
  698. the minibuffer, `C-M-v' scrolls the window that contains the minibuffer
  699. help display, if any, rather than the next window in the standard
  700. cyclic order.)
  701.    The command `M-x compare-windows' lets you compare two files or
  702. buffers visible in two windows, by moving through them to the next
  703. mismatch.  *Note Comparing Files::.
  704. File: emacs,  Node: Pop Up Window,  Next: Change Window,  Prev: Other Window,  Up: Windows
  705. Displaying in Another Window
  706. ============================
  707.    `C-x 4' is a prefix key for commands that select another window
  708. (splitting the window if there is only one) and select a buffer in that
  709. window.  Different `C-x 4' commands have different ways of finding the
  710. buffer to select.
  711. `C-x 4 b BUFNAME RET'
  712.      Select buffer BUFNAME in another window.  This runs
  713.      `switch-to-buffer-other-window'.
  714. `C-x 4 C-o BUFNAME RET'
  715.      Display buffer BUFNAME in another window, but don't select that
  716.      buffer or that window.  This runs `display-buffer'.
  717. `C-x 4 f FILENAME RET'
  718.      Visit file FILENAME and select its buffer in another window.  This
  719.      runs `find-file-other-window'.  *Note Visiting::.
  720. `C-x 4 d DIRECTORY RET'
  721.      Select a Dired buffer for directory DIRECTORY in another window.
  722.      This runs `dired-other-window'.  *Note Dired::.
  723. `C-x 4 m'
  724.      Start composing a mail message in another window.  This runs
  725.      `mail-other-window'; its same-window analogue is `C-x m' (*note
  726.      Sending Mail::.).
  727. `C-x 4 .'
  728.      Find a tag in the current tag table in another window.  This runs
  729.      `find-tag-other-window', the multiple-window variant of `M-.'
  730.      (*note Tags::.).
  731. `C-x 4 r FILENAME RET'
  732.      Visit file FILENAME read-only, and select its buffer in another
  733.      window.  This runs `find-file-read-only-other-window'.  *Note
  734.      Visiting::.
  735. File: emacs,  Node: Change Window,  Prev: Pop Up Window,  Up: Windows
  736. Deleting and Rearranging Windows
  737. ================================
  738. `C-x 0'
  739.      Get rid of the selected window (`delete-window').  That is a zero.
  740. `C-x 1'
  741.      Get rid of all windows except the selected one
  742.      (`delete-other-windows').
  743. `C-x ^'
  744.      Make selected window taller (`enlarge-window').
  745. `C-x }'
  746.      Make selected window wider (`enlarge-window-horizontally').
  747.    To delete a window, type `C-x 0' (`delete-window').  (That is a
  748. zero.)  The space occupied by the deleted window is given to an
  749. adjacent window (but not the minibuffer window, even if that is active
  750. at the time).  Once a window is deleted, its attributes are forgotten;
  751. only restoring a window configuration can bring it back.  Deleting the
  752. window has no effect on the buffer it used to display; the buffer
  753. continues to exist, and you can select it in any window with `C-x b'.
  754.    `C-x 1' (`delete-other-windows') is more powerful than `C-x 0'; it
  755. deletes all the windows except the selected one (and the minibuffer);
  756. the selected window expands to use the whole frame except for the echo
  757. area.
  758.    To readjust the division of space among vertically adjacent windows,
  759. use `C-x ^' (`enlarge-window').  It makes the currently selected window
  760. get one line bigger, or as many lines as is specified with a numeric
  761. argument.  With a negative argument, it makes the selected window
  762. smaller.  `C-x }' (`enlarge-window-horizontally') makes the selected
  763. window wider by the specified number of columns.  The extra screen
  764. space given to a window comes from one of its neighbors, if that is
  765. possible.  If this makes any window too small, it is deleted and its
  766. space is given to an adjacent window.  The minimum size is specified by
  767. the variables `window-min-height' and `window-min-width'.
  768. File: emacs,  Node: Frames,  Next: Major Modes,  Prev: Windows,  Up: Top
  769. Frames and X Windows
  770. ********************
  771.    When using the X Window System, you can create multiple windows at
  772. the X level in a single Emacs session.  Each X window that belongs to
  773. Emacs displays a "frame" which can contain one or several Emacs windows.
  774. A frame initially contains a single general-purpose Emacs window which
  775. you can subdivide vertically or horizontally into smaller windows.  A
  776. frame normally contains its own echo area and minibuffer, but you can
  777. make frames that don't have these--they use the echo area and
  778. minibuffer of another frame.
  779.    Anything you do in one frame also affects the other frames.  For
  780. instance, if you put text in the kill ring in one frame, you can yank it
  781. in another frame.  If you exit emacs through `C-x C-c' in one frame, it
  782. terminates all the frames.  To delete just one frame, use `C-x 5 0'.
  783.    To avoid confusion, we reserve the word "window" for the
  784. subdivisions that Emacs implements, and never use it to refer to a
  785. frame.
  786. * Menu:
  787. * Mouse Commands::     Moving, cutting, and pasting, with the mouse.
  788. * Creating Frames::    Creating additional Emacs frames with various contents.
  789. * Frame Parameters::   Changing the colors and other modes of frames.
  790. * Scroll Bars::        How to enable and disable scroll bars; how to use them.
  791. * Menu Bars::          Enabling and disabling the menu bar.
  792. * Faces::              How to change the display style using faces.
  793. * Misc X::             Iconifying and deleting frames.  Region highlighting.
  794. File: emacs,  Node: Mouse Commands,  Next: Creating Frames,  Up: Frames
  795. Mouse Commands
  796. ==============
  797. `mouse-1'
  798.      Move point to where you click (`mouse-set-point').  This is
  799.      normally the left button.
  800. `drag-mouse-1'
  801.      Move point to where you release the mouse, and set the mark where
  802.      you initially clicked the mouse (`mouse-set-region').  Thus, you
  803.      can specify both ends of the region.  In Transient Mark mode, the
  804.      region highlighting appears and changes as you drag.
  805.      If you move the mouse off the top or bottom of the window while
  806.      dragging, the window scrolls at a steady rate until you move the
  807.      mouse back into the window.  This way, you can mark regions that
  808.      don't fit entirely on the screen.
  809. `mouse-2'
  810.      Yank the last kill text, where you click (`mouse-yank-at-click').
  811.      This is normally the middle button.
  812. `mouse-3'
  813.      Copy text to the kill ring (`mouse-save-then-click').  This is
  814.      normally the right button.  If you click it a second time at the
  815.      same place, that kills the text.
  816.      This operation applies to the text between point and the place
  817.      where you click.
  818.    Thus, to kill a section of text, you can press Mouse-1 at one end,
  819. then press Mouse-3 twice at the other end.  To select the text for
  820. copying without deleting it from the buffer, press Mouse-3 just once.
  821. Then you can copy it elsewhere by yanking it.  *Note Killing::.
  822.    To yank the killed or copied text somewhere else, move the mouse
  823. there and press Mouse-2.  *Note Yanking::.
  824.    To copy text to another X window, kill it or save it in the kill
  825. ring.  Under X, this also sets the "primary selection".  Then use the
  826. "paste" or "yank" command of the program operating the other window to
  827. insert the text from the selection.
  828.    To copy text from another X window, use the "cut" or "copy" command
  829. of the program operating the other window, to select the text you want.
  830. Then yank it in Emacs with `C-y' or Mouse-2.
  831. File: emacs,  Node: Creating Frames,  Next: Frame Parameters,  Prev: Mouse Commands,  Up: Frames
  832. Creating Frames
  833. ===============
  834.    The prefix key `C-x 5' is analogous to `C-x 4', with parallel
  835. subcommands.  The difference is that `C-x 5' commands create a new
  836. frame rather than just a new window in the selected frame.  (*Note Pop
  837. Up Window::.)  Different `C-x 4' commands have different ways of
  838. finding the buffer to select.
  839. `C-x 5 b BUFNAME RET'
  840.      Select buffer BUFNAME in another window.  This runs
  841.      `switch-to-buffer-other-frame'.
  842. `C-x 5 f FILENAME RET'
  843.      Visit file FILENAME and select its buffer in another frame.  This
  844.      runs `find-file-other-frame'.  *Note Visiting::.
  845. `C-x 5 d DIRECTORY RET'
  846.      Select a Dired buffer for directory DIRECTORY in another frame.
  847.      This runs `dired-other-frame'.  *Note Dired::.
  848. `C-x 5 m'
  849.      Start composing a mail message in another frame.  This runs
  850.      `mail-other-frame', and its same-frame version is `C-x m'.  *Note
  851.      Sending Mail::.
  852. `C-x 5 .'
  853.      Find a tag in the current tag table in another frame.  This runs
  854.      `find-tag-other-frame', the multiple-frame variant of `M-.'.
  855.      *Note Tags::.
  856. `C-x 5 r FILENAME RET'
  857.      Visit file FILENAME read-only, and select its buffer in another
  858.      frame.  This runs `find-file-read-only-other-frame'.  *Note
  859.      Visiting::.
  860. File: emacs,  Node: Frame Parameters,  Next: Scroll Bars,  Prev: Creating Frames,  Up: Frames
  861. Setting Frame Parameters
  862. ========================
  863.    This section describes commands for altering the display style and
  864. window management behavior of the selected frame.
  865. `M-x set-foreground-color RET COLOR RET'
  866.      Specify color COLOR for the foreground of the selected frame.
  867. `M-x set-background-color RET COLOR RET'
  868.      Specify color COLOR for the background of the selected frame.
  869. `M-x set-cursor-color RET COLOR RET'
  870.      Specify color COLOR for the cursor of the selected frame.
  871. `M-x set-mouse-color RET COLOR RET'
  872.      Specify color COLOR for the mouse cursor when it is over the
  873.      selected frame.
  874. `M-x set-border-color RET COLOR RET'
  875.      Specify color COLOR for the border of the selected frame.
  876. `M-x auto-raise-mode'
  877.      Toggle whether or not the selected frame should auto-raise.
  878.      Auto-raise means that every time you move the mouse onto the frame,
  879.      it raises the frame.
  880. `M-x auto-lower-mode'
  881.      Toggle whether or not the selected frame should auto-lower.
  882.      Auto-lower means that every time you move the mouse off of the
  883.      frame, the frame moves to the bottom of the stack of X windows.
  884. `M-x set-default-font RET FONT RET'
  885.      Specify font FONT as the default for the selected frame.  *Note
  886.      Font X::, for ways to list the available fonts on your system.
  887.      You can also set a frame's default font through a pop-up menu.
  888.      Press `C-Mouse-3' to activate this menu.
  889.