* update man pages

This commit is contained in:
Dirk-Jan C. Binnema
2010-11-30 08:31:59 +02:00
parent ec8bd8445f
commit 82db172e40
4 changed files with 45 additions and 47 deletions

View File

@ -1,4 +1,4 @@
.TH MU MKDIR 1 "September 2010" "User Manuals" .TH MU MKDIR 1 "November 2010" "User Manuals"
.SH NAME .SH NAME
@ -10,30 +10,28 @@ mu mkdir\- create a new Maildir
.SH DESCRIPTION .SH DESCRIPTION
\fBmu mkdir\fR is the \fBmu\fR sub-command for creating Maildirs. It does not \fBmu mkdir\fR is the \fBmu\fR command for creating Maildirs. It does
depend on the mu database. \fBnot\fR use the mu database. With the \fBmkdir\fR command, you can create
new Maildirs with permissions 0755. For example,
With the \fBmkdir\fR command, you can create new Maildirs with permissions
0755. For example,
.nf .nf
mu mkdir tom dick harry mu mkdir tom dick harry
.fi .fi
will create three Maildirs \fItom\fR, \fIdick\fR and \fIharry\fR. will create three Maildirs, \fItom\fR, \fIdick\fR and \fIharry\fR.
If the creation somehow fails, for safety reasons, \fBno\fR attempt is made to If creation fails for whatever reason, \fBno\fR attempt is made to remove any
remove any parts that were created. parts that were created. This is for safety reasons.
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-mode\fR=<mode> \fB\-\-mode\fR=<mode>
set the file access mode for the new maildir as in chmod(1) set the file access mode for the new maildir(s) as in \fBchmod(1)\fR.
.SH BUGS .SH BUGS
There probably are some; please report bugs when you find them: Please report bugs if you find them:
.BR http://code.google.com/p/mu0/issues/list .BR http://code.google.com/p/mu0/issues/list
.SH AUTHOR .SH AUTHOR

View File

@ -1,4 +1,4 @@
.TH MU VIEW 1 "September 2010" "User Manuals" .TH MU VIEW 1 "November 2010" "User Manuals"
.SH NAME .SH NAME
@ -10,11 +10,9 @@ mu view\- display an e-mail message file
.SH DESCRIPTION .SH DESCRIPTION
\fBmu view\fR is the \fBmu\fR sub-command for displaying an e-mail message \fBview\fR is the \fBmu\fR command for displaying an e-mail message file. It
file. It works on message files and does not require the message to be indexed works on message files and does \fInot\fR require the message to be indexed in
in the mu database with the mu database.
.BR mu-index(1)
\.
The command shows some common headers (From:, To:, Cc:, Subject: and Date:) The command shows some common headers (From:, To:, Cc:, Subject: and Date:)
and the plain-text body of the message, if there is any. and the plain-text body of the message, if there is any.
@ -23,7 +21,7 @@ and the plain-text body of the message, if there is any.
.TP .TP
\fB\-k\fR, \fB\-\-summary\-len\fR=\fI<len>\fR \fB\-k\fR, \fB\-\-summary\-len\fR=\fI<len>\fR
instead of the full message, output a summary based on up to \fI\len\fR lines instead of the full message, output a summary based on up to \fIlen\fR lines
of the message. The default is 0, which means 'show full body'. of the message. The default is 0, which means 'show full body'.
.SH BUGS .SH BUGS
@ -37,4 +35,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO" .SH "SEE ALSO"
.BR mu(1) .BR mu(1) mu-index(1)

View File

@ -1,8 +1,9 @@
.TH MU 1 "October 2010" "User Manuals" .TH MU 1 "November 2010" "User Manuals"
.SH NAME .SH NAME
mu \- index and search e-mail messages stored in Maildirs mu \- a set of tools to deal with Maildirs; in particular to index and search
e-mail messages.
.SH SYNOPSIS .SH SYNOPSIS
@ -22,21 +23,23 @@ mu \- index and search e-mail messages stored in Maildirs
.SH DESCRIPTION .SH DESCRIPTION
\fBmu\fR is a set of tools for dealing with e-mail messages in Maildirs. \fBmu\fR is a set of tools for dealing with Maildirs and the e-mail messages
in them.
Its main function is enable searching of e-mail messages. It does so by \fBmu\fRs main function is to enable searching of e-mail messages. It does so
scanning a Maildir directory tree and analyzing the e-mail messages found. The by scanning a Maildir directory tree and analyzing the e-mail messages found
results of this analysis are stored in a database, which can then be queried. ('indexing'). The results of this analysis are stored in a database, which can
then be queried.
In addition to indexing and searching, \fBmu\fR also offers functionality for In addition to indexing and searching, \fBmu\fR also offers functionality for
viewing messages, extracting attachments and creating maildirs. viewing messages, extracting attachments and creating maildirs.
\fBmu\fR can be used from the command line or can be integrated with e-mail \fBmu\fR can be used from the command line or can be integrated with various
clients. e-mail clients.
This manpage gives a general overview of the available commands This manpage gives a general overview of the available commands
('index', 'find', etc.); for m (\fBindex\fR, \fBfind\fR, etc.); each of the \fBmu\fR commands has its
own man-page as well.
.SH COMMANDS .SH COMMANDS
@ -82,7 +85,7 @@ for extract MIME-parts (such as attachments) from messages. See
\. \.
.SH " " .SH COMMANDS
Commands \fBmu index\fR, \fBfind\fR and \fBcleanup\fR work with the database, Commands \fBmu index\fR, \fBfind\fR and \fBcleanup\fR work with the database,
while the other ones work on invidual mail files. Hence, running \fview\fR, while the other ones work on invidual mail files. Hence, running \fview\fR,
@ -106,8 +109,8 @@ store and read its database and logs. By default, \fI~/.mu\fR is used.
makes \fBmu\fR generate extra debug information, makes \fBmu\fR generate extra debug information,
useful for debugging the program itself. By default, debug information goes to useful for debugging the program itself. By default, debug information goes to
the log file, \fI~/.mu/mu.log\fR. It can safely be deleted when \fBmu\fR is the log file, \fI~/.mu/mu.log\fR. It can safely be deleted when \fBmu\fR is
not running. Note, with the debug option, the log file can grow rather not running. When running with \fB--debug\fR option, the log file can grow
quickly. See the note on logging below. rather quickly. See the note on logging below.
.TP .TP
\fB\-q\fR, \fB\-\-quiet\fR \fB\-q\fR, \fB\-\-quiet\fR
@ -119,19 +122,18 @@ use this option when using \fBmu\fR from scripts etc.
.TP .TP
\fB\-\-log-stderr\fR \fB\-\-log-stderr\fR
causes \fBmu\fR not to output all log messages causes \fBmu\fR to \fBnot\fR output log messages to standard error, in
to standard error, in addition to sending them to the log file. addition to sending them to the log file.
.TP .TP
\fB\-v\fR, \fB\-\-version\fR \fB\-v\fR, \fB\-\-version\fR
outputs the \fBmu\fR-version and copyright prints \fBmu\fR version and copyright information.
information.
.TP .TP
\fB\-h\fR, \fB\-\-help\fR \fB\-h\fR, \fB\-\-help\fR
list the various command line options, while lists the various command line options, while \fB\-\-help\-index\fR,
\fB\-\-help\-index\fR, \fB\-\-help\-find\fR and \fB\-\-help\-all\fR list only \fB\-\-help\-find\fR and \fB\-\-help\-all\fR list only the options for
the options for one command, or all of the commands. respectively the specified command or for all commands.
.SH BUGS .SH BUGS
Please report bugs if you find them: Please report bugs if you find them:

View File

@ -2,7 +2,7 @@
.SH NAME .SH NAME
mug \- a graphical user-interface for \fBmu\fR mail searches mug \- a graphical user interface for \fBmu\fR mail searches
.SH SYNOPSIS .SH SYNOPSIS
@ -11,19 +11,19 @@ mug \- a graphical user-interface for \fBmu\fR mail searches
.SH DESCRIPTION .SH DESCRIPTION
\fBmug\fR is a program for doing e-mail searches, using the \fBmu\fR-backend \fBmug\fR is a program for doing e-mail searches, using the \fBmu\fR-backend
for the actual searches, and a GTK+ user-interface. \fBmug\fR is only a little for the actual searches and a GTK+ user-interface. \fBmug\fR is considered
toy-demonstration of the mu-framework, but can nevertheless be quite useful. merely a toy-demonstration of the mu-framework, but can nevertheless be quite
useful.
When mug finds the \fIbookmarks\fR-file in the mu-home directory, the If \fBmug\fR finds the \fIbookmarks\fR-file in the mu-home directory, the
bookmarks from this file will be shown in mug as a list of buttons in the left bookmarks from this file will be shown in mug as a list of buttons in the left
toolbar. toolbar.
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-muhome\fR \fB\-\-muhome\fR causes \fBmug\fR to use an alternative directory to read its
causes \fBmug\fR to use an alternative directory to read its database and bookmarks and write its logs. By default, \fI~/.mu\fR is used.
database and logs. By default, \fI~/.mu\fR is used.
.SH BUGS .SH BUGS
Please report bugs if you find them: Please report bugs if you find them:
@ -35,4 +35,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO" .SH "SEE ALSO"
.BR mu(1) .BR mu(1) mu-bookmarks(5)