summaryrefslogtreecommitdiff
path: root/doc/texinfo/programs/frm.texi
blob: d03b853a0306682ec50759945d729b09c00eb4e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
@c This is part of the GNU Mailutils manual.
@c Copyright (C) 1999-2020 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
@UNREVISED

GNU mailutils provides two commands for listing messages in a mailbox.
These are @command{from} and @command{frm}.

The behavior of both programs is affected by the following
configuration file statements:

@multitable @columnfractions 0.3 0.6
@headitem Statement @tab Reference
@item debug   @tab @xref{debug statement}.
@item tls     @tab @xref{tls statement}.
@item mailbox @tab @xref{mailbox statement}.
@item locking @tab @xref{locking statement}.
@end multitable

@subheading @command{frm}
@pindex frm

The @command{frm} utility outputs a header information of
the selected messages in a mailbox.  By default, @command{frm} reads 
user's system mailbox and outputs the contents of @code{From} and
@code{Subject} headers for each message.  If a folder is specified in
the command line, the program reads that folder rather than the default
mailbox.

The following command line options alter the behavior of the program:

@table @option
@item -d
@itemx --debug
Enable debugging output.
@item -f @var{string}
@itemx --field @var{string}
Display the header named by @var{string} instead of @code{From}
@code{Subject} pair.
@item -l
@itemx --to
Include the contents of @code{To} header to the output.  The output field
order is then: @code{To} @code{From} @code{Subject}.
@item -n
@itemx --number
Prefix each line with corresponding message number.
@item -Q
@itemx --Quiet
Be very quiet.  Nothing is output except error messages.  This is useful
in shell scripts where only the return status of the program is
important.
@item -q
@itemx --query
Print a message only if there are unread messages in the mailbox.
@item -S
@itemx --summary
Print a summary line.
@item -s @var{attr}
@itemx --status @var{attr}
Only display headers from messages with the given status.
@var{Attr} may be one of the following: @samp{new}, @samp{read},
@samp{unread}.  It is sufficient to specify only first letter of
an @var{attr}.  Multiple @option{-s} options are allowed.
@item -t
@itemx --align
Tidy mode.  In this mode @command{frm} tries to preserve the alignment of
the output fields.  It also enables the use of BIDI algorithm for
displaying subject lines that contain text in right-to-left
orientation (such as Arabic or Hebrew).
@end table

@subheading @command{from}
@pindex from

The @command{from} utility displays sender and subject of each message
in a mailbox.  By default, it reads the user's system mailbox.  If the
program is given a single argument, it is interpreted as a name of the
user whose mailbox is to be read.  Obviously, permissions are required
to access that user's mailbox, so such invocations may be used only
by superuser.

The option @option{-f} (@option{--file}) instructs @command{from} to read
the given mailbox.

The full list of options, supported by @command{from} follows:

@table @option
@item -c
@itemx --count
Prints only a count of messages in the mailbox and exit.

@item -d
@itemx --debug
Prints additional debugging output.

@item -s @var{string}
@itemx --sender=@var{string}
Prints only mail with @samp{From:} header containing the supplied string.
@FIXME{Probably, this should test envelopes as well.}

@item -f @var{url}
@itemx --file=@var{url}
Examine mailbox from the given @var{url}.
@end table

Return to:

Send suggestions and report system problems to the System administrator.