diff --git a/man/mu-add.1 b/man/mu-add.1 index f86b28a6..b3def667 100644 --- a/man/mu-add.1 +++ b/man/mu-add.1 @@ -10,8 +10,8 @@ mu add\- add one or more messages to the database .SH DESCRIPTION -\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. +\fBmu add\fR is the command to add specific message files to the +database. Each file must be specified with an absolute path. .SH OPTIONS diff --git a/man/mu-bookmarks.5 b/man/mu-bookmarks.5 index bfa8d7ab..252fe05c 100644 --- a/man/mu-bookmarks.5 +++ b/man/mu-bookmarks.5 @@ -7,7 +7,7 @@ bookmarks \- file with bookmarks (shortcuts) for mu search expressions .SH DESCRIPTION Bookmarks are named shortcuts for search queries. They allow using a -convenient name for often-used queries. The bookmarks are are also visible as +convenient name for often-used queries. The bookmarks are also visible as shortcuts in the mu experimental user interfaces, \fImug\fR and \fImug2\fR. \fBmu\fR supports bookmarks stored in a file called \fBbookmarks\fR in the mu diff --git a/man/mu-cfind.1 b/man/mu-cfind.1 index b11d6d34..68e8a6fb 100644 --- a/man/mu-cfind.1 +++ b/man/mu-cfind.1 @@ -38,8 +38,8 @@ would find all contacts with a gmail-address, while lists all contacts with Mary in either name or e-mail address. -If you do not specify any search expression, \fBmu cfind\fR returns the full -list of contacts. Note, \fBmu cfind\fR uses does not directly use the +If you do not specify a search expression, \fBmu cfind\fR returns the full +list of contacts. Note, \fBmu cfind\fR does not use the database, but uses a cache file with e-mail addresses, which is populated during the indexing process. @@ -91,8 +91,7 @@ could specify .SH RETURN VALUE \fBmu cfind\fR returns 0 upon successful completion -- that is, at least one -contact was found. Anything else leads to a non-zero return value, for -example: +contact was found. Anything else leads to a non-zero return value: .nf | code | meaning | diff --git a/man/mu-extract.1 b/man/mu-extract.1 index b7dbb04a..a9777e03 100644 --- a/man/mu-extract.1 +++ b/man/mu-extract.1 @@ -17,7 +17,7 @@ attachments) from mail messages. The sub-command works on message files, and does not require the message to be indexed in the database. -For attachments, the file name used when saving it, is the name of the +For attachments, the file name used when saving it is the name of the attachment in the message. If there is no such name, or when saving non-attachment MIME-parts, a name is derived from the message-id of the message. @@ -44,7 +44,7 @@ save all non-multipart MIME-parts. .TP \fB\-\-parts\fR= only consider the following numbered parts -(comma-separated list).The numbers for the parts can be seen from running +(comma-separated list). The numbers for the parts can be seen from running \fBmu extract\fR without any options but only the message file. .TP @@ -60,7 +60,7 @@ allowed. .TP \fB\-\-play\fR Try to 'play' (open) the attachment with the default application for the particular file type. On MacOS, this uses the \fBopen\fR -program, on other platforms is uses \fBxdg-open\fR. You can choose a different +program, on other platforms it uses \fBxdg-open\fR. You can choose a different program by setting the \fBMU_PLAY_PROGRAM\fR environment variable. .SH EXAMPLES @@ -81,7 +81,7 @@ To extract all files ending in '.jpg' (case-insensitive): $ mu extract msgfile '.*\.jpg' .fi -To extract an mp3-file, and play it in the the default mp3-playing application. +To extract an mp3-file, and play it in the default mp3-playing application: .nf $ mu extract --play msgfile 'whoopsididitagain.mp3' .fi diff --git a/man/mu-help.1 b/man/mu-help.1 index 3d971789..e5589b0c 100644 --- a/man/mu-help.1 +++ b/man/mu-help.1 @@ -11,7 +11,7 @@ commands. .SH DESCRIPTION -\fBmu help\fR is a \fBmu\fR provides help information about mu commands. +\fBmu help\fR provides help information about mu commands. .SH BUGS diff --git a/man/mu-index.1 b/man/mu-index.1 index 7377d374..678a477f 100644 --- a/man/mu-index.1 +++ b/man/mu-index.1 @@ -19,7 +19,7 @@ queried using .B index understands Maildirs as defined by Daniel Bernstein for qmail(7). In addition, it understands recursive Maildirs (Maildirs within Maildirs), Maildir++. It -can also deal with VFAT-based Maildirs which use '!' as the seperators instead +can also deal with VFAT-based Maildirs which use '!' as the separators instead of ':' as used by \fITinymail\fR/\fIModest\fR and some other e-mail programs. E-mail messages which are not stored in something resembling a maildir @@ -40,7 +40,7 @@ some maildirs that never change. Note that you can still search for these messages, this only affects updating the database. The first run of \fBmu index\fR may take a few minutes if you have a lot of -mail (ten thousands of messages). Fortunately, such a full scan needs to be +mail (tens of thousands of messages). Fortunately, such a full scan needs to be done only once; after that it suffices to index the changes, which goes much faster. See the 'Note on performance' below for more information. @@ -49,9 +49,9 @@ from the database for which there is no longer a corresponding file in the Maildir. If you do not want this, you can use \fB\-n\fR, \fB\-\-nocleanup\fR. When \fBmu index\fR catches one of the signals \fBSIGINT\fR, \fBSIGHUP\fR or -\fBSIGTERM\fR (e.g,, when you press Ctrl-C during the indexing process), it +\fBSIGTERM\fR (e.g., when you press Ctrl-C during the indexing process), it tries to shutdown gracefully; it tries to save and commit data, and close the -database etc. If it receives another signal (e.g,, when pressing Ctrl-C once +database etc. If it receives another signal (e.g., when pressing Ctrl-C once more), \fBmu index\fR will terminate immediately. .SH OPTIONS @@ -71,7 +71,7 @@ starts searching at \fI\fR. By default, \fBmu\fR uses whatever the specifies that some e-mail address is 'my-address' (\fB\-\-my-address\fR can be used multiple times). This is used by \fBmu cfind\fR -- any e-mail address found in the address fields of a message which also has -\fI\fR in one of its address fields, is considered a +\fI\fR in one of its address fields is considered a \fIpersonal\fR e-mail address. This allows you, for example, to filter out (\fBmu cfind --personal\fR) addresses which were merely seen in mailing list messages. @@ -113,14 +113,14 @@ increase this. Note that the reason for having a maximum size is that big message require big memory allocations, which may lead to problems. .B NOTE: -It is not recommended tot mix maildirs and sub-maildirs within the hierarchy +It is not recommended to mix maildirs and sub-maildirs within the hierarchy in the same database; for example, it's better not to index both with \fB\-\-maildir\fR=~/MyMaildir and \fB\-\-maildir\fR=~/MyMaildir/foo, as this -may lead to unexpected results when searching with the the 'maildir:' search +may lead to unexpected results when searching with the 'maildir:' search parameter (see below). .SS A note on performance (i) -As a non-scientific benchmark, a simple test on the authors machine (a +As a non-scientific benchmark, a simple test on the author's machine (a Thinkpad X61s laptop using Linux 2.6.35 and an ext3 file system) with no existing database, and a maildir with 27273 messages: @@ -141,7 +141,7 @@ already, goes much faster: .fi (more than 56818 messages per second) -Note that each of test flushes the caches first; a more common use case might +Note that each test flushes the caches first; a more common use case might be to run \fBmu index\fR when new mail has arrived; the cache may stay quite 'warm' in that case: @@ -207,7 +207,7 @@ been specified explicitly with \fB\-\-maildir\fR=\fI\fR. If .SH RETURN VALUE \fBmu index\fR return 0 upon successful completion, and any other number -greater than 2 signals an error, for example: +greater than 0 signals an error: .nf | code | meaning | diff --git a/man/mu-script.1 b/man/mu-script.1 index e0b0a5df..db065d31 100644 --- a/man/mu-script.1 +++ b/man/mu-script.1 @@ -58,7 +58,7 @@ code when this is not the case. .SH FILES -You can make your own Scheme scripts accessible throught \fBmu script\fR by +You can make your own Scheme scripts accessible through \fBmu script\fR by putting them in \fI/scripts\fR (which is typically \fI~/.mu/scripts\fR). It is a good idea to document it using some special comments in the source code: diff --git a/man/mu-server.1 b/man/mu-server.1 index f11c5eb4..ec74c89e 100644 --- a/man/mu-server.1 +++ b/man/mu-server.1 @@ -79,7 +79,7 @@ Messages of type 'new' don't use the docid: parameter, the other ones do. The is an s-expression describing the attachments to include in the message; this currently only applies to message we are -forwarding. This s-exprssion looks like: +forwarding. This s-expression looks like: .nf (:file-name :mime-type :disposition ) diff --git a/man/mu-verify.1 b/man/mu-verify.1 index 89f111c6..412dfe0e 100644 --- a/man/mu-verify.1 +++ b/man/mu-verify.1 @@ -48,7 +48,7 @@ To display information about all the signatures: If you only want to use the exit code, you can use: .nf - $ mu verify --verbose msgfile + $ mu verify --quiet msgfile .fi which does not give any output. diff --git a/man/mu-view.1 b/man/mu-view.1 index 64d95ab1..62992071 100644 --- a/man/mu-view.1 +++ b/man/mu-view.1 @@ -26,14 +26,14 @@ instead of displaying the full message, output a summary based upon the first \fI\fR lines of the message. \fB\-\-terminate\fR -terminate messages with a \\f (\fIform-feed\fR) characters when displaying +terminate messages with \\f (\fIform-feed\fR) characters when displaying them. This is useful when you want to further process them. \fB\-\-decrypt\fR attempt to decrypt encrypted message bodies. This is only possible if \fBmu\fR -was built with crypto-support. Users are strongle recommended to use +was built with crypto-support. Users are strongly recommended to use \fBgpg-agent\fR; however, if needed, \fBmu\fR will request the user password -from the consol +from the console. .SH BUGS diff --git a/man/mu.1 b/man/mu.1 index 082c0145..10569486 100644 --- a/man/mu.1 +++ b/man/mu.1 @@ -49,7 +49,7 @@ view a specific message \fBmu\fR is a set of tools for dealing with Maildirs and the e-mail messages in them. -\fBmu\fRs main function is to enable searching of e-mail messages. It does so +\fBmu\fR's main function is to enable searching of e-mail messages. It does so by periodically 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. @@ -62,8 +62,8 @@ and exporting contact information. e-mail clients. This manpage gives a general overview of the available commands -(\fBindex\fR, \fBfind\fR, etc.); each of the \fBmu\fR commands has its -own man-page as well. +(\fBindex\fR, \fBfind\fR, etc.); each \fBmu\fR command has its own +man-page as well. .SH COMMANDS @@ -113,7 +113,7 @@ for extract MIME-parts (such as attachments) from messages. See Some \fBmu\fR sub-commands support colorized output. If you don't want this, you can use the \fI--nocolor\fR/ option to disable it. Even then, colors will -only shown when output goes to a sufficiently capable terminal (this roughly +only be shown when output goes to a sufficiently capable terminal (this roughly mirrors the \fI--color=auto\fR of the GNU-version of the \fBls\fR-command). Instead of the \fI--color\fR/, you can also set the \fBMU_NOCOLOR\fR @@ -143,7 +143,7 @@ For \fBfind\fR the output is encoded according the locale for .SH DATABASE AND FILE Commands \fBmu index\fR and \fBfind\fR and \fBcfind\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 \fBview\fR, \fBmkdir\fR and \fBextract\fR does not require the mu database. The various commands are discussed in more detail in their own separate @@ -151,7 +151,7 @@ man-pages; here the general options are discussed. .SH OPTIONS -\fBmu\fR offers a number of general options that apply to all commands, +\fBmu\fR offers several general options that apply to all commands, including \fBmu\fR without any command. .TP @@ -163,7 +163,7 @@ store and read its database and logs. By default, \fI~/.mu\fR is used. \fB\-d\fR, \fB\-\-debug\fR 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 +the log file, \fI~/.mu/log/mu.log\fR. It can safely be deleted when \fBmu\fR is not running. When running with \fB--debug\fR option, the log file can grow rather quickly. See the note on logging below. @@ -193,7 +193,7 @@ respectively the specified command or for all commands. .SH ERROR CODES The various mu subcommands typically exit with 0 (zero) upon success, and -non-zero when some error occured. The table lists the various error codes. +non-zero when some error occurred. The table lists the various error codes. .nf exit code | error