emacs
/
mu
mirror of https://github.com/djcb/mu.git
1
0
Fork 0
Code Issues Releases Wiki Activity

* update manpage, add mu-help manpage

This commit is contained in:
djcb 2012-07-19 20:44:49 +03:00
parent dde3f09c76
commit e621fadf30
10 changed files with 81 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
man/Makefile.am
View File

@ -23,6 +23,7 @@ dist_man_MANS = \
mu-easy.1 \
mu-extract.1 \
mu-find.1 \
mu-help.1 \
mu-index.1 \
mu-mkdir.1 \
mu-remove.1 \

10
man/mu-add.1
View File

@ -1,8 +1,8 @@
.TH MU ADD 1 "October 2011" "User Manuals"
.TH MU ADD 1 "July 2012" "User Manuals"
.SH NAME
.SH NAME
mu add\- add one or more messages to the database
mu add\- add one or more messages to the database
.SH SYNOPSIS
@ -10,8 +10,8 @@ mu add\- add one or more messages to the database
.SH DESCRIPTION
\fBmu add\fR adds specific files to the database. Each of the files must be
specified with an absolute path.
\fBmu add\fR is the command to add specific measage files to the
database. Each of the files must be specified with an absolute path.
.SH OPTIONS

16
man/mu-cfind.1
View File

@ -1,9 +1,9 @@
.TH MU CFIND 1 "June 2012" "User Manuals"
.TH MU CFIND 1 "July 2012" "User Manuals"
.SH NAME
mu cfind \- find contacts in the \fBmu\fR database and export them for use in
other programs.
\fBmu cfind\fR is the \fBmu\fR command to find contacts in the \fBmu\fR
database and export them for use in other programs.
.SH SYNOPSIS
@ -19,9 +19,9 @@ other programs.
.SH SEARCHING CONTACTS
When you index your messages (see \fBmu index\fR), \fBmu\fR creates a list of
unique e-mail addresses found and the accompanying name. In case the same
e-mail address is used with different names, the most recent non-empty name is
used.
unique e-mail addresses found and the accompanying name, and caches this
list. In case the same e-mail address is used with different names, the most
recent non-empty name is used.
\fBmu cfind\fR starts a search for contacts that match a \fIregular
expression\fR. For example:
@ -39,7 +39,9 @@ would find all contacts with a gmail-address, while
would find all contact with Mary in either name or e-mail address.
If you do not specify any search expression, \fBmu cfind\fR will return the
full list of contacts.
full list of contacts. Note, \fBmu cfind\fR uses does not directly use the
database, but uses a cache file with e-mail addresses that is populated during
the indexing process.
The regular expressions are Perl-compatible (as per the PCRE-library).

5
man/mu-extract.1
View File

@ -2,12 +2,13 @@
.SH NAME
mu extract\- display and save message parts (attachments), and open them with
other tools.
\fBmu extract\fR is the \fBmu\fR command to display and save message parts
(attachments), and open them with other tools.
.SH SYNOPSIS
.B mu extract [options] <file>
.B mu extract [options] <file> <pattern>
.SH DESCRIPTION

34
man/mu-help.1 Normal file
View File

@ -0,0 +1,34 @@
.TH MU HELP 1 "July 2012" "User Manuals"
.SH NAME
\fBmu help\fR is a \fBmu\fR command that gives help information about mu
commands.
.SH SYNOPSIS
.B mu help <command>
.SH DESCRIPTION
\fBmu help\fR is a \fBmu\fR provides help information about mu commands.
.SH BUGS
Please report bugs if you find them:
.BR http://code.google.com/p/mu0/issues/list
.SH AUTHOR
Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu-index(1)
.BR mu-find(1)
.BR mu-cfind(1)
.BR mu-mkdir(1)
.BR mu-view(1)
.BR mu-extract(1)
.BR mu-easy(1)
.BR mu-bookmarks(5)

14
man/mu-mkdir.1
View File

@ -1,8 +1,8 @@
.TH MU MKDIR 1 "May 2011" "User Manuals"
.TH MU MKDIR 1 "July 2012" "User Manuals"
.SH NAME
.SH NAME
mu mkdir\- create a new Maildir
mu mkdir\- create a new Maildir
.SH SYNOPSIS
@ -10,7 +10,7 @@ mu mkdir\- create a new Maildir
.SH DESCRIPTION
\fBmu mkdir\fR is the \fBmu\fR sub-command for creating Maildirs. It does
\fBmu mkdir\fR is the \fBmu\fR command for creating Maildirs. It does
\fBnot\fR use the mu database. With the \fBmkdir\fR command, you can create
new Maildirs with permissions 0755. For example,
@ -18,10 +18,10 @@ new Maildirs with permissions 0755. For example,
mu mkdir tom dick harry
.fi
creates three Maildirs, \fItom\fR, \fIdick\fR and \fIharry\fR.
creates three maildirs, \fItom\fR, \fIdick\fR and \fIharry\fR.
If creation fails for whatever reason, \fBno\fR attempt is made to remove any
parts that were created. This is for safety reasons.
If creation fails for any reason, \fBno\fR attempt is made to remove any parts
that were created. This is for safety reasons.
.SH OPTIONS

11
man/mu-remove.1
View File

@ -1,17 +1,18 @@
.TH MU REMOVE 1 "October 2011" "User Manuals"
.TH MU REMOVE 1 "July 2012" "User Manuals"
.SH NAME
.SH NAME
mu remove\- remove one or more messages to the database
\fBmu remove\fR is the \fBmu\R command to remove messages from the database.
.SH SYNOPSIS
.B mu remove <file> [<files>]
.B mu remove [options] <file> [<files>]
.SH DESCRIPTION
\fBmu remove\fR removes specific messages from the database, each of them
specified by their filename. The files do not have to exist (anymore).
specified by their filename. The files do not have to exist in the file
system.
.SH OPTIONS

14
man/mu-server.1
View File

@ -1,15 +1,19 @@
.TH MU-SERVER 1 "June 2012" "User Manuals"
.TH MU-SERVER 1 "July 2012" "User Manuals"
.SH NAME
mu server \- the mu backend for the mu4e e-mail client
.SH SYNOPSIS
.B mu server [options]
.SH DESCRIPTION
\fBmu server\fR starts a simple shell in which can manipulate the mu
database. The output of the commands is terms of Lisp symbolic expressions
(s-exps). \fBmu server\fR is not meant for use by humans; instead, it is
designed specifically for the \fBmu4e\fR e-mail client.
\fBmu server\fR starts a simple shell in which one can query and manipulate
the mu database. The output of the commands is terms of Lisp symbolic
expressions (s-exps). \fBmu server\fR is not meant for use by humans; instead,
it is designed specifically for the \fBmu4e\fR e-mail client.
In this man-page, we document the commands \fBmu server\fR accepts, as well as
their responses. In general, the commands sent to the server are of the form

8
man/mu-verify.1
View File

@ -10,10 +10,10 @@ mu verify\- verify message signatures and display information about them
.SH DESCRIPTION
\fBmu verify\fR is the \fBmu\fR sub-command for verify the message signatures
(such as PGP/GPG signatures) and displaying information about them. The
sub-command works on message files, and does not require the message to be
indexed in the database.
\fBmu verify\fR is the \fBmu\fR command for verifying message signatures (such
as PGP/GPG signatures) and displaying information about them. The sub-command
works on message files, and does not require the message to be indexed in the
database.
\fBmu verify\fR depends on \fBgpg\fR, and uses the one it finds in your
\fBPATH\fR. If you want to use another one, you need to set \fBMU_GPG_PATH\fB

6
man/mu-view.1
View File

@ -10,9 +10,9 @@ mu view\- display an e-mail message file
.SH DESCRIPTION
\fBview\fR is the \fBmu\fR sub-command for displaying an e-mail message
file. It works on message files and does \fInot\fR require the message to be
indexed in the database.
\fBmu view\fR is the \fBmu\fR command for displaying e-mail message files. It
works on message files and does \fInot\fR require the message to be indexed in
the database.
The command shows some common headers (From:, To:, Cc:, Bcc:, Subject: and
Date:), the list of attachments and the plain-text body of the message (if