From 82db172e4043ac99939cc44f90d751298701ae57 Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Tue, 30 Nov 2010 08:31:59 +0200 Subject: [PATCH] * update man pages --- man/mu-mkdir.1 | 20 +++++++++----------- man/mu-view.1 | 14 ++++++-------- man/mu.1 | 42 ++++++++++++++++++++++-------------------- man/mug.1 | 16 ++++++++-------- 4 files changed, 45 insertions(+), 47 deletions(-) diff --git a/man/mu-mkdir.1 b/man/mu-mkdir.1 index 3c0dd319..2f3948d1 100644 --- a/man/mu-mkdir.1 +++ b/man/mu-mkdir.1 @@ -1,4 +1,4 @@ -.TH MU MKDIR 1 "September 2010" "User Manuals" +.TH MU MKDIR 1 "November 2010" "User Manuals" .SH NAME @@ -10,30 +10,28 @@ mu mkdir\- create a new Maildir .SH DESCRIPTION -\fBmu mkdir\fR is the \fBmu\fR sub-command for creating Maildirs. It does not -depend on the mu database. - -With the \fBmkdir\fR command, you can create new Maildirs with permissions -0755. For example, +\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, .nf mu mkdir tom dick harry .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 -remove any parts that were created. +If creation fails for whatever reason, \fBno\fR attempt is made to remove any +parts that were created. This is for safety reasons. .SH OPTIONS .TP \fB\-\-mode\fR= -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 -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 .SH AUTHOR diff --git a/man/mu-view.1 b/man/mu-view.1 index e693c69a..68b2ecf2 100644 --- a/man/mu-view.1 +++ b/man/mu-view.1 @@ -1,4 +1,4 @@ -.TH MU VIEW 1 "September 2010" "User Manuals" +.TH MU VIEW 1 "November 2010" "User Manuals" .SH NAME @@ -10,11 +10,9 @@ mu view\- display an e-mail message file .SH DESCRIPTION -\fBmu view\fR is the \fBmu\fR sub-command for displaying an e-mail message -file. It works on message files and does not require the message to be indexed -in the mu database with -.BR mu-index(1) -\. +\fBview\fR is the \fBmu\fR 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 mu database. The command shows some common headers (From:, To:, Cc:, Subject: and Date:) 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 \fB\-k\fR, \fB\-\-summary\-len\fR=\fI\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'. .SH BUGS @@ -37,4 +35,4 @@ Dirk-Jan C. Binnema .SH "SEE ALSO" -.BR mu(1) +.BR mu(1) mu-index(1) diff --git a/man/mu.1 b/man/mu.1 index dc665a30..3339d399 100644 --- a/man/mu.1 +++ b/man/mu.1 @@ -1,8 +1,9 @@ -.TH MU 1 "October 2010" "User Manuals" +.TH MU 1 "November 2010" "User Manuals" .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 @@ -22,21 +23,23 @@ mu \- index and search e-mail messages stored in Maildirs .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 -scanning a Maildir directory tree and analyzing the e-mail messages found. The -results of this analysis are stored in a database, which can then be queried. +\fBmu\fRs main function is to enable searching of e-mail messages. It does so +by scanning a Maildir directory tree and analyzing the e-mail messages found +('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 viewing messages, extracting attachments and creating maildirs. -\fBmu\fR can be used from the command line or can be integrated with e-mail -clients. +\fBmu\fR can be used from the command line or can be integrated with various +e-mail clients. 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 @@ -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, 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, 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 -not running. Note, with the debug option, the log file can grow rather -quickly. See the note on logging below. +not running. When running with \fB--debug\fR option, the log file can grow +rather quickly. See the note on logging below. .TP \fB\-q\fR, \fB\-\-quiet\fR @@ -119,19 +122,18 @@ use this option when using \fBmu\fR from scripts etc. .TP \fB\-\-log-stderr\fR -causes \fBmu\fR not to output all log messages -to standard error, in addition to sending them to the log file. +causes \fBmu\fR to \fBnot\fR output log messages to standard error, in +addition to sending them to the log file. .TP \fB\-v\fR, \fB\-\-version\fR -outputs the \fBmu\fR-version and copyright -information. +prints \fBmu\fR version and copyright information. .TP \fB\-h\fR, \fB\-\-help\fR -list the various command line options, while -\fB\-\-help\-index\fR, \fB\-\-help\-find\fR and \fB\-\-help\-all\fR list only -the options for one command, or all of the commands. +lists the various command line options, while \fB\-\-help\-index\fR, +\fB\-\-help\-find\fR and \fB\-\-help\-all\fR list only the options for +respectively the specified command or for all commands. .SH BUGS Please report bugs if you find them: diff --git a/man/mug.1 b/man/mug.1 index 2e2fbf8d..daf3871f 100644 --- a/man/mug.1 +++ b/man/mug.1 @@ -2,7 +2,7 @@ .SH NAME -mug \- a graphical user-interface for \fBmu\fR mail searches +mug \- a graphical user interface for \fBmu\fR mail searches .SH SYNOPSIS @@ -11,19 +11,19 @@ mug \- a graphical user-interface for \fBmu\fR mail searches .SH DESCRIPTION \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 -toy-demonstration of the mu-framework, but can nevertheless be quite useful. +for the actual searches and a GTK+ user-interface. \fBmug\fR is considered +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 toolbar. .SH OPTIONS .TP -\fB\-\-muhome\fR -causes \fBmug\fR to use an alternative directory to read its -database and logs. By default, \fI~/.mu\fR is used. +\fB\-\-muhome\fR 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. .SH BUGS Please report bugs if you find them: @@ -35,4 +35,4 @@ Dirk-Jan C. Binnema .SH "SEE ALSO" -.BR mu(1) +.BR mu(1) mu-bookmarks(5)