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

  1. This is Info file ../info/emacs, produced by Makeinfo-1.63 from the
  2. input file emacs.texi.
  3. File: emacs,  Node: Rmail Output,  Next: Rmail Labels,  Prev: Rmail Files,  Up: Rmail
  4. Copying Messages Out to Files
  5. =============================
  6.    These commands copy messages from an Rmail file into another file.
  7. `o FILE RET'
  8.      Append a copy of the current message to the file FILE, using Rmail
  9.      file format by default (`rmail-output-to-rmail-file').
  10. `C-o FILE RET'
  11.      Append a copy of the current message to the file FILE, using
  12.      system inbox file format by default (`rmail-output').
  13.    The commands `o' and `C-o' copy the current message into a specified
  14. file.  This file may be an Rmail file or it may be in system inbox
  15. format; the output commands ascertain the file's format and write the
  16. copied message in that format.
  17.    The `o' and `C-o' commands differ in two ways: each has its own
  18. separate default file name, and each specifies a choice of format to
  19. use when the file does not already exist.  The `o' command uses Rmail
  20. format when it creates a new file, while `C-o' uses system inbox format
  21. for a new file.  The default file name for `o' is the file name used
  22. last with `o', and the default file name for `C-o' is the file name
  23. used last with `C-o'.
  24.    If the output file is an Rmail file currently visited in an Emacs
  25. buffer, the output commands copy the message into that buffer.  It is
  26. up to you to save the buffer eventually in its file.
  27.    You can also output a message to an Rmail file chosen with a menu.
  28. Choose first the menu bar Classify item, then from the Classify menu
  29. choose the Output Rmail Menu item; then choose the Rmail file you want.
  30. This outputs the current message to that file, like the `o' command.
  31. The variables `rmail-secondary-file-directory' and
  32. `rmail-secondary-file-regexp' specify which files to offer in the menu:
  33. the first variable says which directory to find them in; the second
  34. says which files in that directory to offer (all those that match the
  35. regular expression).
  36.    Copying a message gives the original copy of the message the `filed'
  37. attribute, so that `filed' appears in the mode line when such a message
  38. is current.  If you like to keep just a single copy of every mail
  39. message, set the variable `rmail-delete-after-output' to `t'; then the
  40. `o' and `C-o' commands delete the original message after copying it.
  41. (You can undelete the original afterward if you wish.)
  42.    Copying messages into files in system inbox format uses the header
  43. fields that are displayed in Rmail at the time.  Thus, if you use the
  44. `t' command to view the entire header and then copy the message, the
  45. entire header is copied.  *Note Rmail Display::.
  46.    The variable `rmail-output-file-alist' lets you specify intelligent
  47. defaults for the output file, based on the contents of the current
  48. message.  The value should be a list whose elements have this form:
  49.      (REGEXP . NAME-EXP)
  50. If there's a match for REGEXP in the current message, then the default
  51. file name for output is NAME-EXP.  If multiple elements match the
  52. message, the first matching element decides the default file name.  The
  53. subexpression NAME-EXP may be a string constant giving the file name to
  54. use, or more generally it may be any Lisp expression that returns a
  55. file name as a string.  `rmail-output-file-alist' applies to both `o'
  56. and `C-o'.
  57. File: emacs,  Node: Rmail Labels,  Next: Rmail Reply,  Prev: Rmail Output,  Up: Rmail
  58. Labels
  59. ======
  60.    Each message can have various "labels" assigned to it as a means of
  61. classification.  Each label has a name; different names are different
  62. labels.  Any given label is either present or absent on a particular
  63. message.  A few label names have standard meanings and are given to
  64. messages automatically by Rmail when appropriate; these special labels
  65. are called "attributes".  All other labels are assigned only by users.
  66. `a LABEL RET'
  67.      Assign the label LABEL to the current message (`rmail-add-label').
  68. `k LABEL RET'
  69.      Remove the label LABEL from the current message
  70.      (`rmail-kill-label').
  71. `C-M-n LABELS RET'
  72.      Move to the next message that has one of the labels LABELS
  73.      (`rmail-next-labeled-message').
  74. `C-M-p LABELS RET'
  75.      Move to the previous message that has one of the labels LABELS
  76.      (`rmail-previous-labeled-message').
  77. `C-M-l LABELS RET'
  78.      Make a summary of all messages containing any of the labels LABELS
  79.      (`rmail-summary-by-labels').
  80.    The `a' (`rmail-add-label') and `k' (`rmail-kill-label') commands
  81. allow you to assign or remove any label on the current message.  If the
  82. LABEL argument is empty, it means to assign or remove the same label
  83. most recently assigned or removed.
  84.    Once you have given messages labels to classify them as you wish,
  85. there are two ways to use the labels: in moving and in summaries.
  86.    The command `C-M-n LABELS RET' (`rmail-next-labeled-message') moves
  87. to the next message that has one of the labels LABELS.  The argument
  88. LABELS specifies one or more label names, separated by commas.  `C-M-p'
  89. (`rmail-previous-labeled-message') is similar, but moves backwards to
  90. previous messages.  A numeric argument to either command serves as a
  91. repeat count.
  92.    The command `C-M-l LABELS RET' (`rmail-summary-by-labels') displays
  93. a summary containing only the messages that have at least one of a
  94. specified set of labels.  The argument LABELS is one or more label
  95. names, separated by commas.  *Note Rmail Summary::, for information on
  96. summaries.
  97.    If the LABELS argument to `C-M-n', `C-M-p' or `C-M-l' is empty, it
  98. means to use the last set of labels specified for any of these commands.
  99.    Some labels such as `deleted' and `filed' have built-in meanings and
  100. are assigned to or removed from messages automatically at appropriate
  101. times; these labels are called "attributes".  Here is a list of Rmail
  102. attributes:
  103. `unseen'
  104.      Means the message has never been current.  Assigned to messages
  105.      when they come from an inbox file, and removed when a message is
  106.      made current.  When you start Rmail, it initially shows the first
  107.      message that has this attribute.
  108. `deleted'
  109.      Means the message is deleted.  Assigned by deletion commands and
  110.      removed by undeletion commands (*note Rmail Deletion::.).
  111. `filed'
  112.      Means the message has been copied to some other file.  Assigned by
  113.      the file output commands (*note Rmail Files::.).
  114. `answered'
  115.      Means you have mailed an answer to the message.  Assigned by the
  116.      `r' command (`rmail-reply').  *Note Rmail Reply::.
  117. `forwarded'
  118.      Means you have forwarded the message.  Assigned by the `f' command
  119.      (`rmail-forward').  *Note Rmail Reply::.
  120. `edited'
  121.      Means you have edited the text of the message within Rmail.  *Note
  122.      Rmail Editing::.
  123. `resent'
  124.      Means you have resent the message.  Assigned by the command `M-x
  125.      rmail-resend'.  *Note Rmail Reply::.
  126.    All other labels are assigned or removed only by the user, and have
  127. no standard meaning.
  128. File: emacs,  Node: Rmail Reply,  Next: Rmail Summary,  Prev: Rmail Labels,  Up: Rmail
  129. Sending Replies
  130. ===============
  131.    Rmail has several commands that use Mail mode to send outgoing mail.
  132. *Note Sending Mail::, for information on using Mail mode.  What are
  133. documented here are the special commands of Rmail for entering Mail
  134. mode.  Note that the usual keys for sending mail--`C-x m', `C-x 4 m',
  135. and `C-x 5 m'--are available in Rmail mode and work just as they
  136. usually do.
  137.      Send a message (`rmail-mail').
  138.      Continue editing already started outgoing message
  139.      (`rmail-continue').
  140.      Send a reply to the current Rmail message (`rmail-reply').
  141.      Forward current message to other users (`rmail-forward').
  142. `C-u f'
  143.      Resend the current message to other users (`rmail-resend').
  144. `M-m'
  145.      Try sending a bounced message a second time
  146.      (`rmail-retry-failure').
  147.    The most common reason to send a message while in Rmail is to reply
  148. to the message you are reading.  To do this, type `r' (`rmail-reply').
  149. This displays the `*mail*' buffer in another window, much like `C-x 4
  150. m', but preinitializes the `Subject', `To', `CC' and `In-reply-to'
  151. header fields based on the message you are replying to.  The `To' field
  152. starts out as the address of the person who sent the message you
  153. received, and the `CC' field starts out with all the other recipients
  154. of that message.
  155.    You can exclude certain recipients from being placed automatically in
  156. the `CC', using the variable `rmail-dont-reply-to-names'.  Its value
  157. should be a regular expression (as a string); any recipient that the
  158. regular expression matches, is excluded from the `CC' field.  The
  159. default value matches your own name, and any name starting with
  160. `info-'.  (Those names are excluded because there is a convention of
  161. using them for large mailing lists to broadcast announcements.)
  162.    To omit the `CC' field completely for a particular reply, enter the
  163. reply command with a numeric argument: `C-u r' or `1 r'.
  164.    Once the `*mail*' buffer has been initialized, editing and sending
  165. the mail goes as usual (*note Sending Mail::.).  You can edit the
  166. presupplied header fields if they are not right for you.  You can also
  167. use the commands of Mail mode (*note Mail Mode::.), including `C-c C-y'
  168. which yanks in the message that you are replying to.  You can switch to
  169. the Rmail buffer, select a different message there, switch back, and
  170. yank the new current message.
  171.    Sometimes a message does not reach its destination.  Mailers usually
  172. send the failed message back to you, enclosed in a "failure message".
  173. The Rmail command `M-m' (`rmail-retry-failure') prepares to send the
  174. same message a second time: it sets up a `*mail*' buffer with the same
  175. text and header fields as before.  If you type `C-c C-c' right away,
  176. you send the message again exactly the same as the first time.
  177. Alternatively, you can edit the text or headers and then send it.  The
  178. variable `rmail-retry-ignored-headers', in the same format as
  179. `rmail-ignored-headers' (*note Rmail Display::.), controls which
  180. headers are stripped from the failed message when retrying it; it
  181. defaults to nil.
  182.    Another frequent reason to send mail in Rmail is to "forward" the
  183. current message to other users.  `f' (`rmail-forward') makes this easy
  184. by preinitializing the `*mail*' buffer with the current message as the
  185. text, and a subject designating a forwarded message.  All you have to
  186. do is fill in the recipients and send.  When you forward a message,
  187. recipients get a message which is "from" you, and which has the
  188. original message in its contents.
  189.    Forwarding a message encloses it between two delimiter lines.  It
  190. also modifies every line that starts with a dash, by inserting `- ' at
  191. the start of the line.  When you receive a forwarded message, if it
  192. contains something besides ordinary text--for example, program source
  193. code--you might find it useful to undo that transformation.  You can do
  194. this by selecting the forwarded message and typing `M-x
  195. unforward-rmail-message'.  This command extracts the original forwarded
  196. message, deleting the inserted `- ' strings, and inserts it into the
  197. Rmail file as a separate message immediately following the current one.
  198.    "Resending" is an alternative similar to forwarding; the difference
  199. is that resending sends a message that is "from" the original sender,
  200. just as it reached you--with a few added header fields `Resent-from'
  201. and `Resent-to' to indicate that it came via you.  To resend a message
  202. in Rmail, use `C-u f'.  (`f' runs `rmail-forward', which is programmed
  203. to invoke `rmail-resend' if you provide a numeric argument.)
  204.    The `m' (`rmail-mail') command is used to start editing an outgoing
  205. message that is not a reply.  It leaves the header fields empty.  Its
  206. only difference from `C-x 4 m' is that it makes the Rmail buffer
  207. accessible for `C-c C-y', just as `r' does.  Thus, `m' can be used to
  208. reply to or forward a message; it can do anything `r' or `f' can do.
  209.    The `c' (`rmail-continue') command resumes editing the `*mail*'
  210. buffer, to finish editing an outgoing message you were already
  211. composing, or to alter a message you have sent.
  212.    If you set the variable `rmail-mail-new-frame' to a non-`nil' value,
  213. then all the Rmail commands to start sending a message create a new
  214. frame to edit it in.  This frame is deleted when you send the message,
  215. or when you use the `Don't Send' item in the `Mail' menu.
  216. File: emacs,  Node: Rmail Summary,  Next: Rmail Sorting,  Prev: Rmail Reply,  Up: Rmail
  217. Summaries
  218. =========
  219.    A "summary" is a buffer containing one line per message to give you
  220. an overview of the mail in an Rmail file.  Each line shows the message
  221. number, the sender, the labels, and the subject.  Almost all Rmail
  222. commands are valid in the summary buffer also; these apply to the
  223. message described by the current line of the summary.  Moving point in
  224. the summary buffer selects messages as you move to their summary lines.
  225.    A summary buffer applies to a single Rmail file only; if you are
  226. editing multiple Rmail files, each one can have its own summary buffer.
  227. The summary buffer name is made by appending `-summary' to the Rmail
  228. buffer's name.  Normally only one summary buffer is displayed at a time.
  229. * Menu:
  230. * Rmail Make Summary::         Making various sorts of summaries.
  231. * Rmail Summary Edit::         Manipulating messages from the summary.
  232. File: emacs,  Node: Rmail Make Summary,  Next: Rmail Summary Edit,  Up: Rmail Summary
  233. Making Summaries
  234. ----------------
  235.    Here are the commands to create a summary for the current Rmail file.
  236. Once the Rmail file has a summary buffer, changes in the Rmail file
  237. (such as deleting or expunging messages, and getting new mail)
  238. automatically update the summary.
  239. `C-M-h'
  240.      Summarize all messages (`rmail-summary').
  241. `l LABELS RET'
  242. `C-M-l LABELS RET'
  243.      Summarize message that have one or more of the specified labels
  244.      (`rmail-summary-by-labels').
  245. `C-M-r RCPTS RET'
  246.      Summarize messages that have one or more of the specified
  247.      recipients (`rmail-summary-by-recipients').
  248. `C-M-t TOPIC RET'
  249.      Summarize messages that have a match for the specified regexp
  250.      TOPIC in their subjects (`rmail-summary-by-topic').
  251.    The `h' or `C-M-h' (`rmail-summary') command fills the summary buffer
  252. for the current Rmail file with a summary of all the messages in the
  253. file.  It then displays and selects the summary buffer in another
  254. window.
  255.    `C-M-l LABELS RET' (`rmail-summary-by-labels') makes a partial
  256. summary mentioning only the messages that have one or more of the
  257. labels LABELS.  LABELS should contain label names separated by commas.
  258.    `C-M-r RCPTS RET' (`rmail-summary-by-recipients') makes a partial
  259. summary mentioning only the messages that have one or more of the
  260. recipients RCPTS.  RCPTS should contain mailing addresses separated by
  261. commas.
  262.    `C-M-t TOPIC RET' (`rmail-summary-by-topic') makes a partial summary
  263. mentioning only the messages whose subjects have a match for the
  264. regular expression TOPIC.
  265.    Note that there is only one summary buffer for any Rmail file;
  266. making one kind of summary discards any previously made summary.
  267.    The variable `rmail-summary-window-size' says how many lines to use
  268. for the summary window.
  269. File: emacs,  Node: Rmail Summary Edit,  Prev: Rmail Make Summary,  Up: Rmail Summary
  270. Editing in Summaries
  271. --------------------
  272.    You can use the Rmail summary buffer to do almost anything you can do
  273. in the Rmail buffer itself.  In fact, once you have a summary buffer,
  274. there's no need to switch back to the Rmail buffer.
  275.    You can select and display various messages in the Rmail buffer, from
  276. the summary buffer, just by moving point in the summary buffer to
  277. different lines.  It doesn't matter what Emacs command you use to move
  278. point; whichever line point is on at the end of the command, that
  279. message is selected in the Rmail buffer.
  280.    Almost all Rmail commands work in the summary buffer as well as in
  281. the Rmail buffer.  Thus, `d' in the summary buffer deletes the current
  282. message, `u' undeletes, and `x' expunges.  `o' and `C-o' output the
  283. current message to a file; `r' starts a reply to it.  You can scroll
  284. the current message while remaining in the summary buffer using SPC and
  285.    The Rmail commands to move between messages also work in the summary
  286. buffer, but with a twist: they move through the set of messages included
  287. in the summary.  They also ensure the Rmail buffer appears on the screen
  288. (unlike cursor motion commands, which update the contents of the Rmail
  289. buffer but don't display it in a window unless it already appears).
  290. Here is a list of these commands:
  291.      Move to next line, skipping lines saying `deleted', and select its
  292.      message.
  293.      Move to previous line, skipping lines saying `deleted', and select
  294.      its message.
  295. `M-n'
  296.      Move to next line and select its message.
  297. `M-p'
  298.      Move to previous line and select its message.
  299.      Move to the last line, and select its message.
  300.      Move to the first line, and select its message.
  301. `M-s PATTERN RET'
  302.      Search through messages for PATTERN starting with the current
  303.      message; select the message found, and move point in the summary
  304.      buffer to that message's line.
  305.    Deletion, undeletion, and getting new mail, and even selection of a
  306. different message all update the summary buffer when you do them in the
  307. Rmail buffer.  If the variable `rmail-redisplay-summary' is non-`nil',
  308. these actions also bring the summary buffer back onto the screen.
  309.    When you are finished using the summary, type `w'
  310. (`rmail-summary-wipe') to delete the summary buffer's window.  You can
  311. also exit Rmail while in the summary: `q' (`rmail-summary-quit')
  312. deletes the summary window, then exits from Rmail by saving the Rmail
  313. file and switching to another buffer.
  314. File: emacs,  Node: Rmail Sorting,  Next: Rmail Display,  Prev: Rmail Summary,  Up: Rmail
  315. Sorting the Rmail File
  316. ======================
  317. `M-x rmail-sort-by-date'
  318.      Sort messages of current Rmail file by date.
  319. `M-x rmail-sort-by-subject'
  320.      Sort messages of current Rmail file by subject.
  321. `M-x rmail-sort-by-author'
  322.      Sort messages of current Rmail file by author's name.
  323. `M-x rmail-sort-by-recipient'
  324.      Sort messages of current Rmail file by recipient's names.
  325. `M-x rmail-sort-by-correspondent'
  326.      Sort messages of current Rmail file by the name of the other
  327.      correspondent.
  328. `M-x rmail-sort-by-lines'
  329.      Sort messages of current Rmail file by size (number of lines).
  330. `M-x rmail-sort-by-keywords RET LABELS RET'
  331.      Sort messages of current Rmail file by labels.  The argument
  332.      LABELS should be a comma-separated list of labels.  The order of
  333.      these labels specifies the order of messages; messages with the
  334.      first label come first, messages with the second label come
  335.      second, and so on.  Messages which have none of these labels come
  336.      last.
  337.    The Rmail sort commands perform a *stable sort*: if there is no
  338. reason to prefer either one of two messages, their order remains
  339. unchanged.  You can use this to sort by more than one criterion.  For
  340. example, if you use `rmail-sort-by-date' and then
  341. `rmail-sort-by-author', messages from the same author appear in order
  342. by date.
  343.    With a numeric argument, all these commands reverse the order of
  344. comparison.  This means they sort messages from newest to oldest, from
  345. biggest to smallest, or in reverse alphabetical order.
  346. File: emacs,  Node: Rmail Display,  Next: Rmail Editing,  Prev: Rmail Sorting,  Up: Rmail
  347. Display of Messages
  348. ===================
  349.    Rmail reformats the header of each message before displaying it for
  350. the first time.  Reformatting hides uninteresting header fields to
  351. reduce clutter.  You can use the `t' command to show the entire header
  352. or to repeat the header reformatting operation.
  353.      Toggle display of complete header (`rmail-toggle-header').
  354.    Reformatting the header involves deleting most header fields, on the
  355. grounds that they are not interesting.  The variable
  356. `rmail-ignored-headers' holds a regular expression that specifies which
  357. header fields to hide in this way--if it matches the beginning of a
  358. header field, that whole field is hidden.
  359.    Rmail saves the complete original header before reformatting; to see
  360. it, use the `t' command (`rmail-toggle-header').  This discards the
  361. reformatted headers of the current message and displays it with the
  362. original header.  Repeating `t' reformats the message again.  Selecting
  363. the message again also reformats.
  364.    One consequence of this is that if you edit the reformatted header
  365. (using `e'; *note Rmail Editing::.), subsequent use of `t' will discard
  366. your edits.  On the other hand, if you use `e' after `t', to edit the
  367. original (unreformatted) header, those changes are permanent.
  368.    When used with a window system that supports multiple fonts, Rmail
  369. highlights certain header fields that are especially interesting--by
  370. default, the `From' and `Subject' fields.  The variable
  371. `rmail-highlighted-headers' holds a regular expression that specifies
  372. the header fields to highlight; if it matches the beginning of a header
  373. field, that whole field is highlighted.
  374.    If you specify unusual colors for your text foreground and
  375. background, the colors used for highlighting may not go well with them.
  376. If so, specify different colors for the `highlight' face.  That is
  377. worth doing because the `highlight' face is used for other kinds of
  378. highlighting as well.  *Note Faces::, for how to do this.
  379.    To turn off highlighting entirely in Rmail, set
  380. `rmail-highlighted-headers' to `nil'.
  381. File: emacs,  Node: Rmail Editing,  Next: Rmail Digest,  Prev: Rmail Display,  Up: Rmail
  382. Editing Within a Message
  383. ========================
  384.    Most of the usual Emacs commands are available in Rmail mode, though
  385. a few, such as `C-M-n' and `C-M-h', are redefined by Rmail for other
  386. purposes.  However, the Rmail buffer is normally read only, and most of
  387. the letters are redefined as Rmail commands.  If you want to edit the
  388. text of a message, you must use the Rmail command `e'.
  389.      Edit the current message as ordinary text.
  390.    The `e' command (`rmail-edit-current-message') switches from Rmail
  391. mode into Rmail Edit mode, another major mode which is nearly the same
  392. as Text mode.  The mode line indicates this change.
  393.    In Rmail Edit mode, letters insert themselves as usual and the Rmail
  394. commands are not available.  When you are finished editing the message
  395. and are ready to go back to Rmail, type `C-c C-c', which switches back
  396. to Rmail mode.  Alternatively, you can return to Rmail mode but cancel
  397. all the editing that you have done, by typing `C-c C-]'.
  398.    Entering Rmail Edit mode runs the hook `text-mode-hook'; then it
  399. runs the hook `rmail-edit-mode-hook' (*note Hooks::.).  It adds the
  400. attribute `edited' to the message.
  401. File: emacs,  Node: Rmail Digest,  Next: Out of Rmail,  Prev: Rmail Editing,  Up: Rmail
  402. Digest Messages
  403. ===============
  404.    A "digest message" is a message which exists to contain and carry
  405. several other messages.  Digests are used on some moderated mailing
  406. lists; all the messages that arrive for the list during a period of time
  407. such as one day are put inside a single digest which is then sent to the
  408. subscribers.  Transmitting the single digest uses much less computer
  409. time than transmitting the individual messages even though the total
  410. size is the same, because the per-message overhead in network mail
  411. transmission is considerable.
  412.    When you receive a digest message, the most convenient way to read
  413. it is to "undigestify" it: to turn it back into many individual
  414. messages.  Then you can read and delete the individual messages as it
  415. suits you.
  416.    To do this, select the digest message and type the command `M-x
  417. undigestify-rmail-message'.  This extracts the submessages as separate
  418. Rmail messages, and inserts them following the digest.  The digest
  419. message itself is flagged as deleted.
  420. File: emacs,  Node: Out of Rmail,  Next: Rmail Rot13,  Prev: Rmail Digest,  Up: Rmail
  421. Converting an Rmail File to Inbox Format
  422. ========================================
  423.    The command `M-x unrmail' converts a file in Rmail format to inbox
  424. format (also known as the system mailbox format), so that you can use it
  425. with other mail-editing tools.  You must specify two arguments, the name
  426. of the Rmail file and the name to use for the converted file.  `M-x
  427. unrmail' does not alter the Rmail file itself.
  428. File: emacs,  Node: Rmail Rot13,  Prev: Out of Rmail,  Up: Rmail
  429. Reading Rot13 Messages
  430. ======================
  431.    Mailing list messages that might offend some readers are sometimes
  432. encoded in a simple code called "rot13"--so named because it rotates
  433. the alphabet by 13 letters.  This code is not for secrecy, as it
  434. provides none; rather, it enables those who might be offended to avoid
  435. ever seeing the real text of the message.
  436.    To view a buffer using the rot13 code, use the command `M-x
  437. rot13-other-window'.  This displays the current buffer in another window
  438. which applies the code when displaying the text.
  439. File: emacs,  Node: Dired,  Next: Calendar/Diary,  Prev: Rmail,  Up: Top
  440. Dired, the Directory Editor
  441. ***************************
  442.    Dired makes an Emacs buffer containing a listing of a directory, and
  443. optionally some of its subdirectories as well.  You can use the normal
  444. Emacs commands to move around in this buffer, and special Dired commands
  445. to operate on the files listed.
  446. * Menu:
  447. * Enter: Dired Enter.         How to invoke Dired.
  448. * Commands: Dired Commands.   Commands in the Dired buffer.
  449. * Deletion: Dired Deletion.   Deleting files with Dired.
  450. * Flagging Many Files::       Flagging files based on their names.
  451. * Visit: Dired Visiting.      Other file operations through Dired.
  452. * Marks vs Flags::          Flagging for deletion vs marking.
  453. * Operating on Files::          How to copy, rename, print, compress, etc.
  454.                     either one file or several files.
  455. * Shell Commands in Dired::   Running a shell command on the marked files.
  456. * Transforming File Names::   Using patterns to rename multiple files.
  457. * Comparison in Dired::          Running `diff' by way of Dired.
  458. * Subdirectories in Dired::   Adding subdirectories to the Dired buffer.
  459. * Subdirectory Motion::          Moving across subdirectories, and up and down.
  460. * Hiding Subdirectories::     Making subdirectories visible or invisible.
  461. * Updating: Dired Updating.   Discarding lines for files of no interest.
  462. * Find: Dired and Find.          Using `find' to choose the files for Dired.
  463. File: emacs,  Node: Dired Enter,  Next: Dired Commands,  Up: Dired
  464. Entering Dired
  465. ==============
  466.    To invoke Dired, do `C-x d' or `M-x dired'.  The command reads a
  467. directory name or wildcard file name pattern as a minibuffer argument
  468. to specify which files to list.  Where `dired' differs from
  469. `list-directory' is in putting the buffer into Dired mode so that the
  470. special commands of Dired are available.
  471.    The variable `dired-listing-switches' specifies the options to give
  472. to `ls' for listing directory; this string *must* contain `-l'.  If you
  473. use a numeric prefix argument with the `dired' command, you can specify
  474. the `ls' switches with the minibuffer after you finish entering the
  475. directory specification.
  476.    To display the Dired buffer in another window rather than in the
  477. selected window, use `C-x 4 d' (`dired-other-window)' instead of `C-x
  478. d'.  `C-x 5 d' (`dired-other-frame') uses a separate frame to display
  479. the Dired buffer.
  480. File: emacs,  Node: Dired Commands,  Next: Dired Deletion,  Prev: Dired Enter,  Up: Dired
  481. Commands in the Dired Buffer
  482. ============================
  483.    The Dired buffer is "read-only", and inserting text in it is not
  484. useful, so ordinary printing characters such as `d' and `x' are used
  485. for special Dired commands.  Some Dired commands "mark" or "flag" the
  486. "current file" (that is, the file on the current line); other commands
  487. operate on the marked files or on the flagged files.
  488.    All the usual Emacs cursor motion commands are available in Dired
  489. buffers.  Some special purpose cursor motion commands are also
  490. provided.  The keys `C-n' and `C-p' are redefined to put the cursor at
  491. the beginning of the file name on the line, rather than at the
  492. beginning of the line.
  493.    For extra convenience, SPC and `n' in Dired are equivalent to `C-n'.
  494. `p' is equivalent to `C-p'.  (Moving by lines is so common in Dired
  495. that it deserves to be easy to type.)  DEL (move up and unflag) is
  496. often useful simply for moving up.
  497. File: emacs,  Node: Dired Deletion,  Next: Flagging Many Files,  Prev: Dired Commands,  Up: Dired
  498. Deleting Files with Dired
  499. =========================
  500.    The primary use of Dired is to "flag" files for deletion and then
  501. delete the files previously flagged.
  502.      Flag this file for deletion.
  503.      Remove deletion flag on this line.
  504. `DEL'
  505.      Move point to previous line and remove the deletion flag on that
  506.      line.
  507.      Delete the files that are flagged for deletion.
  508.    You can flag a file for deletion by moving to the line describing the
  509. file and typing `d'.  The deletion flag is visible as a `D' at the
  510. beginning of the line.  This command moves point to the next line, so
  511. that repeated `d' commands flag successive files.  A numeric argument
  512. serves as a repeat count.
  513.    The files are flagged for deletion rather than deleted immediately to
  514. reduce the danger of deleting a file accidentally.  Until you direct
  515. Dired to expunge the flagged files, you can remove deletion flags using
  516. the commands `u' and DEL.  `u' works just like `d', but removes flags
  517. rather than making flags.  DEL moves upward, removing flags; it is like
  518. `u' with numeric argument automatically negated.
  519.    To delete the flagged files, type `x' (`dired-expunge').  This
  520. command first displays a list of all the file names flagged for
  521. deletion, and requests confirmation with `yes'.  If you confirm, Dired
  522. deletes the flagged files, then deletes their lines from the text of
  523. the Dired buffer.  The shortened Dired buffer remains selected.
  524.    If you answer `no' or quit with `C-g' when asked to confirm, you
  525. return immediately to Dired, with the deletion flags still present in
  526. the buffer, and no files actually deleted.
  527. File: emacs,  Node: Flagging Many Files,  Next: Dired Visiting,  Prev: Dired Deletion,  Up: Dired
  528. Flagging Many Files
  529. ===================
  530.      Flag all auto-save files (files whose names start and end with `#')
  531.      for deletion (*note Auto Save::.).
  532.      Flag all backup files (files whose names end with `~') for deletion
  533.      (*note Backup::.).
  534. `. (Period)'
  535.      Flag excess numeric backup files for deletion.  The oldest and
  536.      newest few backup files of any one file are exempt; the middle
  537.      ones are flagged.
  538. `% d REGEXP RET'
  539.      Flag for deletion all files whose names match the regular
  540.      expression REGEXP (`dired-flag-files-regexp').
  541.    The `#', `~' and `.' commands flag many files for deletion, based on
  542. their file names.  These commands are useful precisely because they do
  543. not actually delete any files; you can remove the deletion flags from
  544. any flagged files that you really wish to keep.
  545.    `#' flags for deletion all files whose names look like auto-save
  546. files (*note Auto Save::.)--that is, files whose names begin and end
  547. with `#'.  `~' flags for deletion all files whose names say they are
  548. backup files (*note Backup::.)--that is, whose names end in `~'.
  549.    `.' (Period) flags just some of the backup files for deletion: all
  550. but the oldest few and newest few backups of any one file.  Normally
  551. `dired-kept-versions' (*not* `kept-new-versions'; that applies only
  552. when saving) specifies the number of newest versions of each file to
  553. keep, and `kept-old-versions' specifies the number of oldest versions
  554. to keep.
  555.    Period with a positive numeric argument, as in `C-u 3 .', specifies
  556. the number of newest versions to keep, overriding
  557. `dired-kept-versions'.  A negative numeric argument overrides
  558. `kept-old-versions', using minus the value of the argument to specify
  559. the number of oldest versions of each file to keep.
  560.    The `% d' command flags all files whose names match a specified
  561. regular expression (`dired-flag-files-regexp').  Only the non-directory
  562. part of the file name is used in matching.  You can use `^' and `$' to
  563. anchor matches.  You can exclude subdirectories by hiding them (*note
  564. Hiding Subdirectories::.).
  565. File: emacs,  Node: Dired Visiting,  Next: Marks vs Flags,  Prev: Flagging Many Files,  Up: Dired
  566. Visiting Files in Dired
  567. =======================
  568.    There are several Dired commands for visiting or examining the files
  569. listed in the Dired buffer.  All of them apply to the current line's
  570. file; if that file is really a directory, these commands invoke Dired on
  571. that subdirectory (making a separate Dired buffer).
  572.      Visit the file described on the current line, like typing `C-x C-f'
  573.      and supplying that file name (`dired-find-file').  *Note
  574.      Visiting::.
  575. `RET'
  576.      Equivalent to `f'.
  577.      Like `f', but uses another window to display the file's buffer
  578.      (`dired-find-file-other-window').  The Dired buffer remains visible
  579.      in the first window.  This is like using `C-x 4 C-f' to visit the
  580.      file.  *Note Windows::.
  581. `C-o'
  582.      Visit the file described on the current line, and display the
  583.      buffer in another window, but do not select that window
  584.      (`dired-display-file').
  585. `Mouse-2'
  586.      Visit the file named by the line you click on
  587.      (`dired-mouse-find-file-other-window').  This uses another window
  588.      to display the file, like the `o' command.
  589.      View the file described on the current line, using `M-x view-file'
  590.      (`dired-view-file').
  591.      Viewing a file is like visiting it, but is slanted toward moving
  592.      around in the file conveniently and does not allow changing the
  593.      file.  *Note View File: Misc File Ops.
  594. File: emacs,  Node: Marks vs Flags,  Next: Operating on Files,  Prev: Dired Visiting,  Up: Dired
  595. Dired Marks vs. Flags
  596. =====================
  597.    Instead of flagging a file with `D', you can "mark" the file with
  598. some other character (usually `*').  Most Dired commands to operate on
  599. files, aside from "expunge" (`x'), look for files marked with `*'.
  600.    Here are some commands for marking with `*' (and also for
  601. unmarking).  (*Note Dired Deletion::, for commands to flag and unflag
  602. files.)
  603.      Mark the current file with `*' (`dired-mark').  With a numeric
  604.      argument N, mark the next N files starting with the current file.
  605.      (If N is negative, mark the previous -N files.)
  606.      Mark all executable files with `*' (`dired-mark-executables').
  607.      With a numeric argument, unmark all those files.
  608.      Mark all symbolic links with `*' (`dired-mark-symlinks').  With a
  609.      numeric argument, unmark all those files.
  610.      Mark with `*' all files which are actually directories, except for
  611.      `.' and `..' (`dired-mark-directories').  With a numeric argument,
  612.      unmark all those files.
  613. `M-DEL MARKCHAR'
  614.      Remove all marks that use the character MARKCHAR
  615.      (`dired-unmark-all-files').  If you specify RET as MARKCHAR, this
  616.      command removes all marks, no matter what the marker character is.
  617.      With a numeric argument, this command queries about each marked
  618.      file, asking whether to remove its mark.  You can answer `y'
  619.      meaning yes, `n' meaning no, `!' to remove the marks from the
  620.      remaining files without asking about them.
  621. `c OLD NEW'
  622.      Replace all marks that use the character OLD with marks that use
  623.      the character NEW (`dired-change-marks').  This command is the
  624.      primary way to create or use marks other than `*' or `D'.  The
  625.      arguments are single characters--do not use RET to terminate them.
  626.      You can use almost any character as a mark character by means of
  627.      this command, to distinguish various classes of files.  If OLD is a
  628.      space (` '), then the command operates on all unmarked files; if
  629.      NEW is a space, then the command unmarks the files it acts on.
  630.      To illustrate the power of this command, here is how to put `*'
  631.      marks on all the files that are unmarked, while unmarking all
  632.      those that have `*' marks:
  633.           c * t  c SPC *  c t SPC
  634. `% m REGEXP RET'
  635.      Mark (with `*') all files whose names match the regular expression
  636.      REGEXP (`dired-mark-files-regexp').  `% m' is like `% d', except
  637.      that it marks files with `*' instead of flagging with `D'.  *Note
  638.      Flagging Many Files::.
  639.      Only the non-directory part of the file name is used in matching.
  640.      Use `^' and `$' to anchor matches.  Exclude subdirectories by
  641.      hiding them (*note Hiding Subdirectories::.).
  642. File: emacs,  Node: Operating on Files,  Next: Shell Commands in Dired,  Prev: Marks vs Flags,  Up: Dired
  643. Operating on Files
  644. ==================
  645.    This section describes the basic Dired commands to operate on one
  646. file or several files.  All of these commands are capital letters; all
  647. of them use the minibuffer, either to read an argument or to ask for
  648. confirmation, before they act.  All use the following convention to
  649. decide which files to manipulate:
  650.    * If you give the command a numeric prefix argument N, it operates
  651.      on the next N files, starting with the current file.  (If N is
  652.      negative, the command operates on the -N files preceding the
  653.      current line.)
  654.    * Otherwise, if some files are marked with `*', the command operates
  655.      on all those files.
  656.    * Otherwise, the command operates on the current file only.
  657.    Here are the file-manipulating commands that operate on files in this
  658. way.  (Some other Dired commands, such as `!' and the `%' commands,
  659. also use these conventions to decide which files to work on.)
  660. `C NEW RET'
  661.      Copy the specified files (`dired-do-copy').  The argument NEW is
  662.      the directory to copy into, or (if copying a single file) the new
  663.      name.
  664.      If `dired-copy-preserve-time' is non-`nil', then copying with this
  665.      command sets the modification time of the new file to be the same
  666.      as that of the old file.
  667. `R NEW RET'
  668.      Rename the specified files (`dired-do-rename').  The argument NEW
  669.      is the directory to rename into, or (if renaming a single file)
  670.      the new name.
  671.      Dired automatically changes the visited file name of buffers
  672.      associated with renamed files so that they refer to the new names.
  673. `H NEW RET'
  674.      Make hard links to the specified files (`dired-do-hardlink').  The
  675.      argument NEW is the directory to make the links in, or (if making
  676.      just one link) the name to give the link.
  677. `S NEW RET'
  678.      Make symbolic links to the specified files (`dired-do-symlink').
  679.      The argument NEW is the directory to make the links in, or (if
  680.      making just one link) the name to give the link.
  681. `M MODESPEC RET'
  682.      Change the mode (also called "permission bits") of the specified
  683.      files (`dired-do-chmod').  This uses the `chmod' program, so
  684.      MODESPEC can be any argument that `chmod' can handle.
  685. `G NEWGROUP RET'
  686.      Change the group of the specified files to NEWGROUP
  687.      (`dired-do-chgrp').
  688. `O NEWOWNER RET'
  689.      Change the owner of the specified files to NEWOWNER
  690.      (`dired-do-chown').  (On most systems, only the superuser can do
  691.      this.)
  692.      The variable `dired-chown-program' specifies the name of the
  693.      program to use to do the work (different systems put `chown' in
  694.      different places).
  695. `P COMMAND RET'
  696.      Print the specified files (`dired-do-print').  You must specify the
  697.      command to print them with, but the minibuffer starts out with a
  698.      suitable guess made using the variables `lpr-command' and
  699.      `lpr-switches' (the same variables that `lpr-file' uses; *note
  700.      Hardcopy::.).
  701.      Compress or uncompress the specified files (`dired-do-compress').
  702.      If the file appears to be a compressed file, it is uncompressed;
  703.      otherwise, it is compressed.
  704.      Load the specified Emacs Lisp files (`dired-do-load').  *Note Lisp
  705.      Libraries::.
  706.      Byte compile the specified Emacs Lisp files
  707.      (`dired-do-byte-compile').  *Note Byte Compilation: (elisp)Byte
  708.      Compilation.
  709. `A REGEXP RET'
  710.      Search all the specified files for the regular expression REGEXP
  711.      (`dired-do-search').
  712.      This command is a variant of `tags-search'.  The search stops at
  713.      the first match it finds; use `M-,' to resume the search and find
  714.      the next match.  *Note Tags Search::.
  715. `Q FROM RET TO RET'
  716.      Perform `query-replace-regexp' on each of the specified files,
  717.      replacing matches for FROM (a regular expression) with the string
  718.      TO (`dired-do-query-replace').
  719.      This command is a variant of `tags-query-replace'.  If you exit the
  720.      query replace loop, you can use `M-,' to resume the scan and
  721.      replace more matches.  *Note Tags Search::.
  722.    One special file-operation command is `+'
  723. (`dired-create-directory').  This command reads a directory name and
  724. creates the directory if it does not already exist.
  725. File: emacs,  Node: Shell Commands in Dired,  Next: Transforming File Names,  Prev: Operating on Files,  Up: Dired
  726. Shell Commands in Dired
  727. =======================
  728.    The dired command `!' (`dired-do-shell-command') reads a shell
  729. command string in the minibuffer and runs that shell command on all the
  730. specified files.  There are two ways of applying a shell command to
  731. multiple files:
  732.    * If you use `*' in the shell command, then it runs just once, with
  733.      the list of file names substituted for the `*'.  The order of file
  734.      names is the order of appearance in the Dired buffer.
  735.      Thus, `! tar cf foo.tar * RET' runs `tar' on the entire list of
  736.      file names, putting them into one tar file `foo.tar'.
  737.    * If the command string doesn't contain `*', then it runs once *for
  738.      each file*, with the file name added at the end.
  739.      For example, `! uudecode RET' runs `uudecode' on each file.
  740.    What if you want to run the shell command once for each file but with
  741. the file name inserted in the middle?  Or if you want to use the file
  742. names in a more complicated fashion?  Use a shell loop.  For example,
  743. this shell command would run `uuencode' on each of the specified files,
  744. writing the output into a corresponding `.uu' file:
  745.      for file in *; uuencode $file $file >$file.uu; done
  746.    The working directory for the shell command is the top level
  747. directory of the Dired buffer.
  748.    The `!' command does not attempt to update the Dired buffer to show
  749. new or modified files, because it doesn't really understand shell
  750. commands, and does not know what files the shell command changed.  Use
  751. the `g' command to update the Dired buffer (*note Dired Updating::.).
  752. File: emacs,  Node: Transforming File Names,  Next: Comparison in Dired,  Prev: Shell Commands in Dired,  Up: Dired
  753. Transforming File Names in Dired
  754. ================================
  755.    Here are commands that alter file names in a systematic way:
  756. `% u'
  757.      Rename each of the selected files to an upper case name
  758.      (`dired-upcase').  If the old file names are `Foo' and `bar', the
  759.      new names are `FOO' and `BAR'.
  760. `% l'
  761.      Rename each of the selected files to a lower case name
  762.      (`dired-downcase').  If the old file names are `Foo' and `bar',
  763.      the new names are `foo' and `bar'.
  764. `% R FROM RET TO RET'
  765. `% C FROM RET TO RET'
  766. `% H FROM RET TO RET'
  767. `% S FROM RET TO RET'
  768.      These four commands rename, copy, make hard links and make soft
  769.      links, in each case computing the new name by regular expression
  770.      substitution from the name of the old file.
  771.    The four regular expression substitution commands effectively perform
  772. a search-and-replace on the selected file names in the Dired buffer.
  773. They read two arguments: a regular expression FROM, and a substitution
  774. pattern TO.
  775.    The commands match each "old" file name against the regular
  776. expression FROM, and then replace the matching part with TO.  You can
  777. use `\&' and `\DIGIT' in TO to refer to all or part of what the pattern
  778. matched in the old file name, as in `query-replace-regexp' (*note Query
  779. Replace::.).  If the regular expression matches more than once in a
  780. file name, only the first match is replaced.
  781.    For example, `% R ^.*$ RET x-\& RET' renames each selected file by
  782. prepending `x-' to its name.  The inverse of this, removing `x-' from
  783. the front of each file name, is also possible: one method is `% R
  784. ^x-\(.*\)$ RET \1 RET'; another is `% R ^x- RET RET'.  (Use `^' and `$'
  785. to anchor matches that should span the whole filename.)
  786.    Normally, the replacement process does not consider the files'
  787. directory names; it operates on the file name within the directory.  If
  788. you specify a numeric argument of zero, then replacement affects the
  789. entire absolute file name including directory name.
  790.    Often you will want to apply the command to all files matching the
  791. same REGEXP that you use in the command.  To do this, mark those files
  792. with `% m REGEXP RET', then use the same regular expression in the
  793. command to operate on the files.  To make this easier, the `%' commands
  794. to operate on files use the last regular expression specified in any
  795. `%' command as a default.
  796. File: emacs,  Node: Comparison in Dired,  Next: Subdirectories in Dired,  Prev: Transforming File Names,  Up: Dired
  797. File Comparison with Dired
  798. ==========================
  799.    Here are two Dired commands that compare specified files using
  800. `diff'.
  801.      Compare the current file (the file at point) with another file
  802.      (the file at the mark) using the `diff' program (`dired-diff').
  803.      The file at the mark is the first argument of `diff', and the file
  804.      at point is the second argument.
  805. `M-='
  806.      Compare the current file with its latest backup file
  807.      (`dired-backup-diff').  If the current file is itself a backup,
  808.      compare it with the file it is a backup of; this way, you can
  809.      compare a file with any backup version of your choice.
  810.      The backup file is the first file given to `diff'.
  811. File: emacs,  Node: Subdirectories in Dired,  Next: Subdirectory Motion,  Prev: Comparison in Dired,  Up: Dired
  812. Subdirectories in Dired
  813. =======================
  814.    A Dired buffer displays just one directory in the normal case; but
  815. you can optionally include its subdirectories as well.
  816.    The simplest way to include multiple directories in one Dired buffer
  817. is to specify the options `-lR' for running `ls'.  (If you give a
  818. numeric argument when you run Dired, then you can specify these options
  819. in the minibuffer.)  That produces a recursive directory listing showing
  820. all subdirectories at all levels.
  821.    But usually all the subdirectories are too many; usually you will
  822. prefer to include specific subdirectories only.  You can do this with
  823. the `i' command:
  824.      Insert the contents of a subdirectory later in the buffer.
  825.    Use the `i' (`dired-maybe-insert-subdir') command on a line that
  826. describes a file which is a directory.  It inserts the contents of that
  827. directory into the same Dired buffer, and moves there.  Inserted
  828. subdirectory contents follow the top-level directory of the Dired
  829. buffer, just as they do in `ls -lR' output.
  830.    If the subdirectory's contents are already present in the buffer, the
  831. `i' command just moves to it.
  832.    In either case, `i' sets the Emacs mark before moving, so `C-u
  833. C-SPC' takes you back to the old position in the buffer (the line
  834. describing that subdirectory).
  835.    Use the `l' command (`dired-do-redisplay') to update the
  836. subdirectory's contents.  Use `k' to delete the subdirectory.  *Note
  837. Dired Updating::.
  838. File: emacs,  Node: Subdirectory Motion,  Next: Hiding Subdirectories,  Prev: Subdirectories in Dired,  Up: Dired
  839. Moving Over Subdirectories
  840. ==========================
  841.    When a Dired buffer lists subdirectories, you can use the page motion
  842. commands `C-x [' and `C-x ]' to move by entire directories.
  843.    The following commands move across, up and down in the tree of
  844. directories within one Dired buffer.  They move to "directory header
  845. lines", which are the lines that give a directory's name, at the
  846. beginning of the directory's contents.
  847. `C-M-n'
  848.      Go to next subdirectory header line, regardless of level
  849.      (`dired-next-subdir').
  850. `C-M-p'
  851.      Go to previous subdirectory header line, regardless of level
  852.      (`dired-prev-subdir').
  853. `C-M-u'
  854.      Go up to the parent directory's header line (`dired-tree-up').
  855. `C-M-d'
  856.      Go down in the directory tree, to the first subdirectory's header
  857.      line (`dired-tree-down').
  858. File: emacs,  Node: Hiding Subdirectories,  Next: Dired Updating,  Prev: Subdirectory Motion,  Up: Dired
  859. Hiding Subdirectories
  860. =====================
  861.    "Hiding" a subdirectory means to make it invisible, except for its
  862. header line, via selective display (*note Selective Display::.).
  863.      Hide or reveal the subdirectory that point is in, and move point
  864.      to the next subdirectory (`dired-hide-subdir').  A numeric
  865.      argument serves as a repeat count.
  866. `M-$'
  867.      Hide all subdirectories in this Dired buffer, leaving only their
  868.      header lines (`dired-hide-all').  Or, if any subdirectory is
  869.      currently hidden, make all subdirectories visible again.  You can
  870.      use this command to get an overview in very deep directory trees
  871.      or to move quickly to subdirectories far away.
  872.    Ordinary Dired commands never consider files inside a hidden
  873. subdirectory.  For example, the commands to operate on marked files
  874. ignore files in hidden directories even if they are marked.  Thus you
  875. can use hiding to temporarily exclude subdirectories from operations
  876. without having to remove the markers.
  877.    The subdirectory hiding commands toggle; that is, they hide what was
  878. visible, and show what was hidden.
  879.