man: fix rendering with groff

Closes #32.
pull/34/head
Leah Neukirchen 7 years ago
parent 152394d261
commit ceeb3848e4

@ -10,7 +10,7 @@
.Op Fl v .Op Fl v
.Op Fl i .Op Fl i
.Op Fl a | Fl d .Op Fl a | Fl d
.Ar header Ns Cm ":" Ns Ar regex .Ar header Ns Cm \&: Ns Ar regex
.Op Ar msgs\ ... .Op Ar msgs\ ...
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
@ -30,7 +30,7 @@ will instead match against the Maildir flags of the messages.
If If
.Ar header .Ar header
is is
.Sq Li "/" , .Sq Cm \&/ ,
.Nm .Nm
will instead search the plain text parts of the will instead search the plain text parts of the
.Em body .Em body

@ -17,10 +17,10 @@ which usually resides in
if set.) if set.)
.Pp .Pp
This file consists of a RFC 2822 style header message with lines like This file consists of a RFC 2822 style header message with lines like
.Dl Ar key Ns ":" Ar value .Dl Ar key Ns \&: Ar value
.Pp .Pp
You can use a key You can use a key
.Sq Li "#" .Sq Cm \&#
for comments: for comments:
.Dl Li "#:" Ar comment .Dl Li "#:" Ar comment
.Pp .Pp

@ -32,7 +32,7 @@ to all messages in the
directory. directory.
.Pp .Pp
Sequences have the format Sequences have the format
.Sq Ar start Ns Cm ":" Ns Ar stop , .Sq Ar start Ns Cm \&: Ns Ar stop ,
where where
.Ar start .Ar start
and and
@ -50,24 +50,24 @@ is the empty string,
.Li \&-1 .Li \&-1
will be used instead. will be used instead.
Thus, Thus,
.Sq Cm ":" .Sq Cm \&:
represents the whole sequence. represents the whole sequence.
If the sequence does not contain a If the sequence does not contain a
.Sq Cm ":" , .Sq Cm \&: ,
it is considered to be a single message, equivalent to the range it is considered to be a single message, equivalent to the range
.Sq Ar start Ns Cm ":" Ns Ar start .Sq Ar start Ns Cm \&: Ns Ar start
of size one. of size one.
.Pp .Pp
If the sequence is threaded, the following If the sequence is threaded, the following
syntax may be used: syntax may be used:
.Sq Ar msg Ns Cm "=" .Sq Ar msg Ns Cm \&=
refers to the whole thread that contains refers to the whole thread that contains
.Ar msg . .Ar msg .
.Sq Ar msg Ns Cm "^" .Sq Ar msg Ns Cm \&^
refers to the parent of the message refers to the parent of the message
.Ar msg .Ar msg
and may be repeated to refer to grand-parents. and may be repeated to refer to grand-parents.
.Sq Ar msg Ns Cm "_" .Sq Ar msg Ns Cm \&_
refers to the subthread headed by refers to the subthread headed by
.Ar msg .Ar msg
(i.e. all messages below with more indentation). (i.e. all messages below with more indentation).

@ -42,7 +42,7 @@ and can include:
.It Ar n .It Ar n
Message number Message number
.Ar n . .Ar n .
.It Ar n Ns Cm ":" Ns Ar m , Ar n Ns Cm "-" Ns Ar m .It Ar n Ns Cm \&: Ns Ar m , Ar n Ns Cm \&- Ns Ar m
An inclusive range of message numbers between An inclusive range of message numbers between
.Ar n .Ar n
and and
@ -50,11 +50,11 @@ and
.It Ar address .It Ar address
All messages from All messages from
.Ar address . .Ar address .
.It Cm "/" Ns Ar string .It Cm \&/ Ns Ar string
All messages with All messages with
.Ar string .Ar string
in the subject line (case ignored). in the subject line (case ignored).
.It Cm ":" Ns Ar c .It Cm \&: Ns Ar c
All message of type All message of type
.Ar c , .Ar c ,
where where

@ -56,18 +56,18 @@ The following formatting codes can be used
.Ar ( wd .Ar ( wd
overrides the default width): overrides the default width):
.Bl -tag -width Ds .Bl -tag -width Ds
.It Cm "\\n" .It Cm \en
Newline Newline
.It Cm "\\t" .It Cm \et
Tab Tab
.It Cm "%%" .It Cm \&%%
A plain A plain
.Sq Li "%" . .Sq Li \&% .
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "b" .It Cm "%" Ns Oo Ar wd Oc Ns Cm "b"
Human-readable size of the message (in kilobytes). Human-readable size of the message (in kilobytes).
.It Cm "%c" .It Cm "%c"
A A
.Sq Li ">" .Sq Li \&
on the current message, else a blank. on the current message, else a blank.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "d" .It Cm "%" Ns Oo Ar wd Oc Ns Cm "d"
Adaptive date of the message. Adaptive date of the message.
@ -103,9 +103,9 @@ The raw Maildir flags of the message.
The number of the message in the current sequence. The number of the message in the current sequence.
.It Cm "%r" .It Cm "%r"
A A
.Sq Li "-" .Sq Li \&-
on a replied-to message, or a on a replied-to message, or a
.Sq Li ":" .Sq Li \&:
on a forwarded message, or a blank. on a forwarded message, or a blank.
.It Cm "%" Ns Oo Ar wd Oc Ns Cm "R" .It Cm "%" Ns Oo Ar wd Oc Ns Cm "R"
The filename of the message. The filename of the message.
@ -119,25 +119,25 @@ with leading
etc. stripped. etc. stripped.
.It Cm "%t" .It Cm "%t"
A A
.Sq Li ">" .Sq Li \&>
if you are in if you are in
.Sq Li "To:" , .Sq Li "To:" ,
a a
.Sq Li "+" .Sq Li \&+
if you are in if you are in
.Sq Li "Cc:" , .Sq Li "Cc:" ,
a a
.Sq Li ":" .Sq Li \&:
if you are in if you are in
.Sq Li "Resent-To:" , .Sq Li "Resent-To:" ,
or a blank else. or a blank else.
.It Cm "%u" .It Cm "%u"
A A
.Sq Li "*" .Sq Li \&*
on a flagged message, or a on a flagged message, or a
.Sq Li "." .Sq Li \&.
on an unseen message, or a on an unseen message, or a
.Sq Li "x" .Sq Li x
on a trashed message, or a blank. on a trashed message, or a blank.
.El .El
.El .El

@ -42,25 +42,25 @@ The separators
the command letter may be subsituted with an arbitrary symbol, just as in the command letter may be subsituted with an arbitrary symbol, just as in
.Xr sed 1 . .Xr sed 1 .
Multiple commands can be separated by Multiple commands can be separated by
.Sq Cm ";" . .Sq Cm \&; .
.Bl -tag -width Ds .Bl -tag -width Ds
.It Cm "/" Ns Ar header Ns Cm "/" Ns Ic a Ns Cm "/" Ns Ar value Ns Cm "/" .It Cm \&/ Ns Ar header Ns Cm \&/ Ns Ic a Ns Cm \&/ Ns Ar value Ns Cm \&/
If the header If the header
.Sq Ar header Ns Cm ":" .Sq Ar header Ns Cm \&:
is not set in the message, add it with given is not set in the message, add it with given
.Ar value . .Ar value .
.It Cm "/" Ns Ar headers Ns Cm "/" Ns Ic c Ns Cm "/" Ns Ar value Ns Cm "/" .It Cm \&/ Ns Ar headers Ns Cm \&/ Ns Ic c Ns Cm \&/ Ns Ar value Ns Cm \&/
Change colon-separated headers matching the regular expression Change colon-separated headers matching the regular expression
.Ar headers , .Ar headers ,
with implicit anchoring to the header name, with implicit anchoring to the header name,
to the value given in to the value given in
.Ar value . .Ar value .
.It Cm "/" Ns Ar headers Ns Cm "/" Ns Ic d .It Cm \&/ Ns Ar headers Ns Cm \&/ Ns Ic d
Delete colon-separated headers matching the regular expression Delete colon-separated headers matching the regular expression
.Ar headers , .Ar headers ,
with implicit anchoring to the header name. with implicit anchoring to the header name.
Use explicit Use explicit
.Sq Li ".*" .Sq Li \&.*
to match arbitrary strings at the beginning or end of the headers. to match arbitrary strings at the beginning or end of the headers.
.Pp .Pp
For example, For example,
@ -75,7 +75,7 @@ will delete the headers
.Sq Li "To:" , .Sq Li "To:" ,
and and
.Sq Li "Cc:" . .Sq Li "Cc:" .
.It Oo Cm "/" Ns Ar headers Ns Cm "/" Oc Ns Ic s Ns Cm "/" Ns Ar regex Ns Cm "/" Ns Ar replacement Ns Cm "/" Ns Op Ar flags .It Oo Cm \&/ Ns Ar headers Ns Cm \&/ Oc Ns Ic s Ns Cm \&/ Ns Ar regex Ns Cm \&/ Ns Ar replacement Ns Cm \&/ Ns Op Ar flags
Substitute matches of the POSIX Basic Regular Expression Substitute matches of the POSIX Basic Regular Expression
.Ar regex .Ar regex
in headers matching the POSIX Basic Regular Expression in headers matching the POSIX Basic Regular Expression
@ -85,10 +85,10 @@ with implicit anchoring to the header name
with the string with the string
.Ar replacement , .Ar replacement ,
expanding expanding
.Sq Li "&" .Sq Cm \&&
to the matched string, to the matched string,
and and
.Sq Li "\\" Ns Ar N .Sq Cm \e Ns Ar N
to the to the
.Ar N Ns .Ar N Ns
th th

Loading…
Cancel
Save