Commit 86f03cee 86f03cee20b6b1eccaa955da162cfbc9727d966c by Sergey Poznyakoff

Document `from'

1 parent 9fbbd738
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
9 * configuration:: Common Configuration File. 9 * configuration:: Common Configuration File.
10 * authentication:: Authorization and Authentication Principles. 10 * authentication:: Authorization and Authentication Principles.
11 11
12 * frm:: List Headers from a Mailbox. 12 * frm and from:: List Headers from a Mailbox.
13 * mail:: Send and Receive Mail. 13 * mail:: Send and Receive Mail.
14 * messages:: Count the Number of Messages in a Mailbox. 14 * messages:: Count the Number of Messages in a Mailbox.
15 * movemail:: Moves Mail from the User Maildrop to the Local File. 15 * movemail:: Moves Mail from the User Maildrop to the Local File.
...@@ -476,8 +476,13 @@ system:sql:virtdomains ...@@ -476,8 +476,13 @@ system:sql:virtdomains
476 @end smallexample 476 @end smallexample
477 477
478 @page 478 @page
479 @node frm 479 @node frm and from
480 @section @command{frm} --- List Headers from a Mailbox 480 @section @command{frm} and @command{from} --- List Headers from a Mailbox
481
482 GNU mailutils provides two commands for listing messages in a mailbox.
483 These are @command{from} and @command{frm}.
484
485 @subheading @command{frm}
481 @pindex frm 486 @pindex frm
482 487
483 The @command{frm} command outputs a header information of 488 The @command{frm} command outputs a header information of
...@@ -522,8 +527,44 @@ Only display headers from messages with the given status. ...@@ -522,8 +527,44 @@ Only display headers from messages with the given status.
522 an @var{attr}. Multiple @option{-s} options are allowed. 527 an @var{attr}. Multiple @option{-s} options are allowed.
523 @item -t 528 @item -t
524 @itemx --align 529 @itemx --align
525 Tidy mode. Currently is not implemented. Included for compatibility with 530 Tidy mode. In this mode @command{frm} tries to preserve the alignment of
526 @command{frm} program from Elm package. 531 the output fields. It also enables the use of BIDI algorithm for
532 displaying subject lines that contain text in right-to-left
533 orientation (such as Arabic or Hebrew).
534 @end table
535
536 @subheading @command{from}
537 @pindex from
538
539 The @command{from} utility displays sender and subject of each message
540 in a mailbox. By default, it reads the user's system mailbox. If the
541 program is given a single argument, it is interpreted as a user
542 name whose mailbox is to be read. Obviously, permissions are required
543 to access that user's mailbox, so such invocations may be used only
544 by superuser.
545
546 Option @option{-f} (@option{--file}) instructs the program to read
547 the given mailbox.
548
549 The full list of options, supported by @command{from} follows:
550
551 @table @option
552 @item -c
553 @itemx --count
554 Prints only a count of messages in the mailbox and exit.
555
556 @item -d
557 @itemx --debug
558 Prints additional debugging outut.
559
560 @item -s @var{string}
561 @itemx --sender=@var{string}
562 Prints only mail from addresses containing the supplied string.
563 FIXME: only @code{From:} header is examined.
564
565 @item -f @var{url}
566 @itemx --file=@var{url}
567 Examine mailbox from the given @var{url}.
527 @end table 568 @end table
528 569
529 @page 570 @page
......