home *** CD-ROM | disk | FTP | other *** search
/ Dream 49 / Amiga_Dream_49.iso / beos / emacs / emacs-19.34-bin / emacs-19 / info / emacs-8 (.txt) < prev    next >
GNU Info File  |  1997-09-17  |  49KB  |  841 lines

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