diff options
| author | Glenn Morris | 2009-02-16 01:33:10 +0000 |
|---|---|---|
| committer | Glenn Morris | 2009-02-16 01:33:10 +0000 |
| commit | 554fda1a964a4ed4ee790e48542e392ba1a9b8e2 (patch) | |
| tree | a55f70348b0843b4d5ee6d228dcf9b0471771056 | |
| parent | d4653d3c30fe35f88cffd9e798f33ac90619bd28 (diff) | |
| download | emacs-554fda1a964a4ed4ee790e48542e392ba1a9b8e2.tar.gz emacs-554fda1a964a4ed4ee790e48542e392ba1a9b8e2.zip | |
(rmail-output, rmail-output-as-seen): Further doc fixes.
| -rw-r--r-- | lisp/mail/rmailout.el | 40 |
1 files changed, 18 insertions, 22 deletions
diff --git a/lisp/mail/rmailout.el b/lisp/mail/rmailout.el index 3c762ed82cf..7edd27c735a 100644 --- a/lisp/mail/rmailout.el +++ b/lisp/mail/rmailout.el | |||
| @@ -393,23 +393,29 @@ display message number MSG." | |||
| 393 | ;;;###autoload | 393 | ;;;###autoload |
| 394 | (defun rmail-output (file-name &optional count noattribute from-gnus) | 394 | (defun rmail-output (file-name &optional count noattribute from-gnus) |
| 395 | "Append this message to mail file FILE-NAME. | 395 | "Append this message to mail file FILE-NAME. |
| 396 | This works with both mbox format and Babyl format files, | 396 | Writes mbox format, unless FILE-NAME exists and is Babyl format, in which |
| 397 | outputting in the appropriate format for each. | 397 | case it writes Babyl. |
| 398 | 398 | ||
| 399 | Interactively, the default file name comes from `rmail-default-file', | 399 | Interactively, the default file name comes from `rmail-default-file', |
| 400 | which is updated to the name you use in this command. In all uses, if | 400 | which is updated to the name you use in this command. In all uses, if |
| 401 | FILE-NAME is not absolute, it is expanded with the directory part of | 401 | FILE-NAME is not absolute, it is expanded with the directory part of |
| 402 | `rmail-default-file'. | 402 | `rmail-default-file'. |
| 403 | 403 | ||
| 404 | A prefix argument COUNT says to output that many consecutive messages, | 404 | If a buffer is visiting FILE-NAME, adds the text to that buffer |
| 405 | starting with the current one. Deleted messages are skipped and don't count. | 405 | rather than saving the file directly. If the buffer is an Rmail |
| 406 | When called from Lisp code, COUNT may be omitted and defaults to 1. | 406 | buffer, updates it accordingly. |
| 407 | |||
| 408 | This command always outputs the complete message header, even if | ||
| 409 | the header display is currently pruned. | ||
| 407 | 410 | ||
| 408 | This command always outputs the complete message header, | 411 | Optional prefix argument COUNT (default 1) says to output that |
| 409 | even if the header display is currently pruned. | 412 | many consecutive messages, starting with the current one (ignoring |
| 413 | deleted messages). If `rmail-delete-after-output' is non-nil, deletes | ||
| 414 | messages after output. | ||
| 410 | 415 | ||
| 411 | The optional third argument NOATTRIBUTE, if non-nil, says not | 416 | The optional third argument NOATTRIBUTE, if non-nil, says not to |
| 412 | to set the `filed' attribute, and not to display a message. | 417 | set the `filed' attribute, and not to display a \"Wrote file\" |
| 418 | message (if writing a file directly). | ||
| 413 | 419 | ||
| 414 | The optional fourth argument FROM-GNUS is set when called from Gnus." | 420 | The optional fourth argument FROM-GNUS is set when called from Gnus." |
| 415 | (interactive | 421 | (interactive |
| @@ -476,21 +482,11 @@ The optional fourth argument FROM-GNUS is set when called from Gnus." | |||
| 476 | (kill-buffer tembuf)))) | 482 | (kill-buffer tembuf)))) |
| 477 | 483 | ||
| 478 | ;; FIXME gnus does not use this function. | 484 | ;; FIXME gnus does not use this function. |
| 485 | ;; FIXME this duplicates much code from rmail-output. | ||
| 479 | (defun rmail-output-as-seen (file-name &optional count noattribute from-gnus) | 486 | (defun rmail-output-as-seen (file-name &optional count noattribute from-gnus) |
| 480 | "Append this message to mbox file named FILE-NAME. | 487 | "Append this message to mbox file named FILE-NAME. |
| 481 | A prefix argument COUNT says to output that many consecutive messages, | 488 | The details are as for `rmail-output', except that the header is output |
| 482 | starting with the current one. Deleted messages are skipped and don't count. | 489 | as currently seen, and that this function cannot write to Babyl files." |
| 483 | When called from Lisp code, COUNT may be omitted and defaults to 1. | ||
| 484 | |||
| 485 | This outputs the message header as you see it. | ||
| 486 | |||
| 487 | The default file name comes from `rmail-default-file', | ||
| 488 | which is updated to the name you use in this command. | ||
| 489 | |||
| 490 | The optional third argument NOATTRIBUTE, if non-nil, says not | ||
| 491 | to set the `filed' attribute, and not to display a message. | ||
| 492 | |||
| 493 | The optional fourth argument FROM-GNUS is set when called from Gnus." | ||
| 494 | (interactive | 490 | (interactive |
| 495 | (list (rmail-output-read-file-name) | 491 | (list (rmail-output-read-file-name) |
| 496 | (prefix-numeric-value current-prefix-arg))) | 492 | (prefix-numeric-value current-prefix-arg))) |