about summary refs log tree commit diff
path: root/man/mscan.1
blob: 48d47947b60c91e5cc55b70fd1f7aff5dd6c5327 (plain) (blame)
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
.Dd June 28, 2017
.Dt MSCAN 1
.Os
.Sh NAME
.Nm mscan
.Nd generate one-line message summaries
.Sh SYNOPSIS
.Nm
.Op Fl n
.Op Fl f Ar format
.Op Fl I
.Ar msgs\ ...
.Sh DESCRIPTION
.Nm
prints a one line summary for each message.
.Po
See
.Xr mmsg 7
for the message argument syntax.
.Pc
.Pp
If no
.Ar msgs
are specified,
.Nm
reads filenames from the standard input,
or scans the mails in the current sequence if used interactively.
.Pp
By default,
.Nm
will spawn a pager on its output when used interactively.
See
.Sx ENVIRONMENT
for details on how to control this behaviour.
.Pp
The default
.Ar format
is
.Pp
.Dl %c%u%r %-3n %10d %17f %t %2i%s
.Pp
that is, for each message,
.Nm
prints relevant flags,
the sequence number
.Pq if applicable ,
the date,
the originator,
and the subject of the message
.Pq possibly indented .
A default
.Nm
format may be specified in the user's
.Xr mblaze-profile 5 .
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl n
Only print message numbers
.Pq or filenames, if the message is not in the current sequence .
.It Fl I
Force ISO date output,
even for
.Sq Cm "%d" .
.It Fl f Ar format
Format according to the string
.Ar format ,
inspired by
.Xr printf 3 .
.Pp
The following formatting codes may be used
.Po
.Ar wd
overrides the default width
.Pc :
.Bl -tag -width Ds
.It Cm \en
Newline.
.It Cm \et
Tab.
.It Cm \&%%
A plain
.Sq Li \&% .
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "b"
Human-readable size of the message
.Pq in kilobytes .
.It Cm "%c"
A
.Sq Li >
on the current message,
otherwise a blank.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "d"
Adaptive date of the message.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "D"
ISO date of the message
.Pq year, month, day .
When
.Ar wd
is greater or equal to 16,
the hour-minute timestamp will also be shown.
When
.Ar wd
is greater or equal to 19,
seconds will also be shown.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "f"
The
.Sq Li From\&:
.Po
or
.Sq Li To\&: ,
if the message is from us
.Pc .
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "F"
The maildir folder the message resides in.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "i"
.Ar wd
.Pq default: 1
spaces per indentation depth in the thread tree.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "I"
The
.Sq Li Message\&-ID\&:
of the message.
.It Cm "%M"
The raw maildir flags of the message.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "n"
The number of the message in the current sequence.
.It Cm "%r"
A
.Sq Li \&-
on a replied-to message, or a
.Sq Li \&:
on a forwarded message, or a blank.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "R"
The filename of the message.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "s"
The subject of the message
.Pq defaults to remaining width .
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "S"
The subject of the message
.Pq defaults to remaining width ,
with leading
.Sq Li Re\&: ,
.Sq Li Fwd\&:
etc. stripped.
.It Cm "%t"
A
.Sq Li \&>
if you are in
.Sq Li To\&: ,
a
.Sq Li \&+
if you are in
.Sq Li Cc\&: ,
a
.Sq Li \&:
if you are in
.Sq Li Resent\&-To\&: ,
or a blank.
.It Cm "%u"
An
.Sq Li \&*
on a flagged message, a
.Sq Li \&.
on an unseen message, an
.Sq Li x
on a trashed message, or a blank.
.El
.El
.Sh MESSAGE FLAGS
.Bl -tag -width 2n -compact
.It Li \&>
The current message
.It Li \&.
An unseen message
.It Li x
A trashed message
.It Li \&*
A flagged message
.It Li \&-
A replied-to message
.El
.Sh SUBJECT FLAGS
.Bl -tag -width 2n -compact
.It Li \&>
You are in
.Sq Li To\&:
.It Li \&+
You are in
.Sq Li Cc\:&
.It Li \&:
You are in
.Sq Li Resent\&-To\&:
.El
.Sh ENVIRONMENT
.Bl -tag -width MBLAZE_PAGER
.It Ev MBLAZE_PAGER
Any non-empty value of the environment variable
.Ev MBLAZE_PAGER
is used instead of the standard pagination program, specified in
.Ev PAGER .
When empty, or set to
.Sq Ic cat ,
no pager is spawned.
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr mblaze-profile 5 ,
.Xr mmsg 7
.Sh AUTHORS
.An Leah Neukirchen Aq Mt leah@vuxu.org
.Sh LICENSE
.Nm
is in the public domain.
.Pp
To the extent possible under law,
the creator of this work
has waived all copyright and related or
neighboring rights to this work.
.Pp
.Lk http://creativecommons.org/publicdomain/zero/1.0/