summary refs log tree commit diff
diff options
context:
space:
mode:
authorLarry Hynes <larry@larryhynes.com>2018-02-04 19:15:59 +0000
committerLeah Neukirchen <leah@vuxu.org>2018-02-04 21:04:44 +0100
commit080ea4317f0cda1bda8f2e3f6fe6c31909ebb336 (patch)
tree3612fec3f82c3b8195af473585b2014797f00c58
parent80a74ddc982f577446837cd58199d55b666551d4 (diff)
downloadmblaze-080ea4317f0cda1bda8f2e3f6fe6c31909ebb336.tar.gz
mblaze-080ea4317f0cda1bda8f2e3f6fe6c31909ebb336.tar.xz
mblaze-080ea4317f0cda1bda8f2e3f6fe6c31909ebb336.zip
mscan.1: update wording
Closes: #108 [via git-merge-pr]
-rw-r--r--man/mscan.152
1 files changed, 33 insertions, 19 deletions
diff --git a/man/mscan.1 b/man/mscan.1
index 703c2e6..48d4794 100644
--- a/man/mscan.1
+++ b/man/mscan.1
@@ -3,7 +3,7 @@
 .Os
 .Sh NAME
 .Nm mscan
-.Nd print a one line per message mail listing
+.Nd generate one-line message summaries
 .Sh SYNOPSIS
 .Nm
 .Op Fl n
@@ -13,9 +13,11 @@
 .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
@@ -34,14 +36,18 @@ for details on how to control this behaviour.
 The default
 .Ar format
 is
-.Sq Li "%c%u%r %-3n %10d %17f %t %2i%s" ;
+.Pp
+.Dl %c%u%r %-3n %10d %17f %t %2i%s
+.Pp
 that is, for each message,
 .Nm
 prints relevant flags,
-the sequence number (if applicable),
+the sequence number
+.Pq if applicable ,
 the date,
 the originator,
-and the subject of the message (possibly indented).
+and the subject of the message
+.Pq possibly indented .
 A default
 .Nm
 format may be specified in the user's
@@ -51,7 +57,7 @@ The options are as follows:
 .Bl -tag -width Ds
 .It Fl n
 Only print message numbers
-(or filenames, if the message is not in the current sequence).
+.Pq or filenames, if the message is not in the current sequence .
 .It Fl I
 Force ISO date output,
 even for
@@ -63,8 +69,10 @@ inspired by
 .Xr printf 3 .
 .Pp
 The following formatting codes may be used
-.Ar ( wd
-overrides the default width):
+.Po
+.Ar wd
+overrides the default width
+.Pc :
 .Bl -tag -width Ds
 .It Cm \en
 Newline.
@@ -74,7 +82,8 @@ Tab.
 A plain
 .Sq Li \&% .
 .It Cm "%" Ns Oo Ar wd Oc Ns Cm "b"
-Human-readable size of the message (in kilobytes).
+Human-readable size of the message
+.Pq in kilobytes .
 .It Cm "%c"
 A
 .Sq Li >
@@ -83,7 +92,8 @@ 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 (year, month, day).
+ISO date of the message
+.Pq year, month, day .
 When
 .Ar wd
 is greater or equal to 16,
@@ -95,21 +105,23 @@ seconds will also be shown.
 .It Cm "%" Ns Oo Ar wd Oc Ns Cm "f"
 The
 .Sq Li From\&:
-(or
+.Po
+or
 .Sq Li To\&: ,
-if the message is from us).
+if the message is from us
+.Pc .
 .It Cm "%" Ns Oo Ar wd Oc Ns Cm "F"
-The Maildir folder the message resides in.
+The maildir folder the message resides in.
 .It Cm "%" Ns Oo Ar wd Oc Ns Cm "i"
 .Ar wd
-(default: 1)
+.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.
+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"
@@ -121,9 +133,11 @@ 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 (defaults to remaining width).
+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 (defaults to remaining width),
+The subject of the message
+.Pq defaults to remaining width ,
 with leading
 .Sq Li Re\&: ,
 .Sq Li Fwd\&:
@@ -169,13 +183,13 @@ A replied-to message
 .Bl -tag -width 2n -compact
 .It Li \&>
 You are in
-.Sq Li To\&: .
+.Sq Li To\&:
 .It Li \&+
 You are in
-.Sq Li Cc\:& .
+.Sq Li Cc\:&
 .It Li \&:
 You are in
-.Sq Li Resent\&-To\&: .
+.Sq Li Resent\&-To\&:
 .El
 .Sh ENVIRONMENT
 .Bl -tag -width MBLAZE_PAGER