mblaze/man/mscan.1

.Dd July 22, 2016
.Dt MSCAN 1
.Os
.Sh NAME
.Nm mscan
.Nd print a one line per message mail listing
.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.
See
.Xr mmsg 7
for the message argument syntax.
.Pp
If no
.Ar msgs
are passed,
.Nm
reads file names from standard input,
or uses the mails in the current sequence when used interactively.
.Pp
By default,
.Ar format
is
.Sq Li "%c%u%r %-3n %10d %17f %t %2i%s" ,
that is, for each message,
.Nm
prints
flags,
the sequence number (if applicable),
the date,
the originator,
and the subject of the message (possibly indented).
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl n
Only print message numbers
(or file names, 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 can be used
.Ar ( wd
overrides the default width):
.Bl -tag -width Ds
.It Cm "\\n"
Newline
.It Cm "\\t"
Tab
.It Cm "%%"
A plain
.Sq Li "%" .
.It Cm "%c"
A
.Sq Li ">"
on the current message, else a blank.
.It Cm "%u"
A
.Sq Li "*"
on a flagged message, or a
.Sq Li "."
on an unseen message, or a
.Sq Li "x"
on a trashed message, or a blank.
.It Cm "%r"
A
.Sq Li "-"
on a replied-to message, or a
.Sq Li ":"
on a forwarded message, or a blank.
.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 else.
.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 "%" 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 (year, month, day).
When
.Ar wd
is greater or equal 16,
the hour-minute timestamp will be shown, too.
When
.Ar wd
is greater or equal 19,
seconds will be shown, too.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "f"
The
.Sq Li From
(or
.Sq Li To ,
if the message is from us).
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "i"
.Ar wd
(default: 1)
spaces per indentation depth in the thread tree.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "s"
The subject of the message (defaults to remaining width).
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "S"
The subject of the message (defaults to remaining width),
with leading
.Sq Li Re: ,
.Sq Li Fwd:
etc. stripped.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "b"
Human-readable size of the message (in kilobytes).
.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 "R"
The filename of the message.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "I"
The
.Sq Li Message-ID
of the message.
.El
.El
.Sh MESSAGE FLAGS
.Bl -tag -width 2n -compact
.It Li \&>
The current message
.It Li \&.
A seen 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 EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr mmsg 7
.Sh AUTHORS
.An Christian Neukirchen Aq Mt chneukirchen@gmail.com
.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/