mblaze/man/mmsg.7

105 lines
2.1 KiB
Groff
Raw Normal View History

2016-07-22 19:36:46 +00:00
.Dd July 22, 2016
2016-07-22 19:43:03 +00:00
.Dt MMSG 7
2016-07-22 19:36:46 +00:00
.Os
.Sh NAME
.Nm mmsg
2016-08-01 17:33:25 +00:00
.Nd mblaze message argument syntax
2016-07-22 19:36:46 +00:00
.Sh DESCRIPTION
This document outlines the message syntax used by many
of the tools in the
.Xr mblaze 7
message system.
2016-07-22 19:36:46 +00:00
.Pp
In general, you can always specify a filename as a message,
2016-07-22 19:36:46 +00:00
if it contains a
.Sq Li \&/
character.
(Use
2016-07-22 19:36:46 +00:00
.Sq Li \&./
to prefix messages in the current directory.)
You can also specify a Maildir folder, which will be expanded
to all messages in the
.Pa cur/
directory.
2016-07-22 19:36:46 +00:00
.Pp
Sequences have the format
.Sq Ar start Ns Cm \&: Ns Ar stop ,
2016-07-22 19:36:46 +00:00
where
.Ar start
and
.Ar stop
are one-based indexes into the sequence.
Negative numbers count from the end.
If
.Ar start
is the empty string,
.Li 1
will be used instead.
If
.Ar stop
is the empty string,
.Li \&-1
will be used instead.
Thus,
.Sq Cm \&:
2016-07-22 19:36:46 +00:00
represents the whole sequence.
If the sequence does not contain a
.Sq Cm \&: ,
2016-07-22 19:36:46 +00:00
it is considered to be a single message, equivalent to the range
.Sq Ar start Ns Cm \&: Ns Ar start
2016-07-22 19:36:46 +00:00
of size one.
2017-07-02 16:54:25 +00:00
The special notation
.Sq Ar start Ns Cm \&:+ Ns Ar n ,
selects
.Ar start
and the next
.Ar n
messages.
2016-07-22 19:36:46 +00:00
.Pp
2016-08-05 18:05:24 +00:00
If the sequence is threaded, the following
syntax may be used:
.Sq Ar msg Ns Cm \&=
2016-08-05 18:05:24 +00:00
refers to the whole thread that contains
.Ar msg .
.Sq Ar msg Ns Cm \&^
2016-08-05 18:05:24 +00:00
refers to the parent of the message
.Ar msg
and may be repeated to refer to grandparents.
.Sq Ar msg Ns Cm \&_
2016-08-05 18:05:24 +00:00
refers to the subthread headed by
.Ar msg
(i.e. all messages below, with more indentation).
2016-08-05 18:05:24 +00:00
.Pp
The following special shortcuts may be used:
2016-07-22 19:36:46 +00:00
.Bl -tag -width 3n
.It Sq Li \&.
refers to the current message.
Additionally, the syntax
.Sq Li \&.+ Ns Ar N
and
.Sq Li \&.- Ns Ar N
can be used to refer to messages relative to the current message.
.It Sq Li \&+
refers to the next message (like
.Sq Li \&.+1 ) .
.It Sq Li \&-
refers to the previous message (like
.Sq Li \&.-1 ) .
.It Sq Li \&$
refers to the last message (like
.Sq Li -1 ) .
2017-07-02 16:54:25 +00:00
.It Sq Li \&^
refers to the current parent message (like
.Sq Li \&.^ ) .
.It Sq Li \&=
refers to the current thread (like
.Sq Li \&.= ) .
.It Sq Li \&_
refers to the current subthread (like
.Sq Li \&._ ) .
2016-07-22 19:36:46 +00:00
.El
.Sh SEE ALSO
.Xr mblaze 7
2016-07-22 19:36:46 +00:00
.Sh AUTHORS
2017-01-21 16:17:12 +00:00
.An Leah Neukirchen Aq Mt leah@vuxu.org