* many: small cosmetic / documentation updates

This commit is contained in:
Dirk-Jan C. Binnema
2010-08-23 08:23:58 +03:00
parent 43b1c0fcf1
commit 1b75323e1c
6 changed files with 36 additions and 22 deletions

View File

@ -1,5 +1,4 @@
#compdef mu #compdef mu
#-*-mode:sh-*-
## Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> ## Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
## ##
@ -74,3 +73,7 @@ _mu() {
_mu "$@" _mu "$@"
# Local variables:
# mode: sh
# End:

View File

@ -20,7 +20,7 @@ be found, from the database. Note that this is done automatically when running
.SH ENVIRONMENT .SH ENVIRONMENT
Like \fBmu index\fR, \fBmu cleanup\fR uses \fBMAILDIR\fR to find the user's Like \fBmu index\fR, \fBmu cleanup\fR uses \fBMAILDIR\fR to find the user's
Maildir if it has not been specified explicitly Maildir if it has not been specified explicitly with
\fB\-\-maildir\fR=\fI<maildir>\fR. If MAILDIR is not set, \fBmu cleanup\fR will \fB\-\-maildir\fR=\fI<maildir>\fR. If MAILDIR is not set, \fBmu cleanup\fR will
try \fI~/Maildir\fR. try \fI~/Maildir\fR.
. .

View File

@ -166,10 +166,11 @@ To store these files elsewhere from their default location, one can use the
.SH ENVIRONMENT .SH ENVIRONMENT
As mentioned, \fBmu index\fR uses \fBMAILDIR\fR to find the user's Maildir if \fBmu index\fR uses \fBMAILDIR\fR to find the user's Maildir if it has not
it has not been specified explicitly \fB\-\-maildir\fR=\fI<maildir>\fR. If been specified explicitly with \fB\-\-maildir\fR=\fI<maildir>\fR. If MAILDIR
MAILDIR is not set, \fBmu index\fR will try \fI~/Maildir\fR. is not set, \fBmu index\fR will try \fI~/Maildir\fR.
. .
.SH BUGS .SH BUGS
There probably are some; please report bugs when you find them: There probably are some; please report bugs when you find them:

View File

@ -16,6 +16,8 @@ mu \- index and search e-mail messages stored in Maildirs
.B mu mkdir [options] <dir> [<dirs>] .B mu mkdir [options] <dir> [<dirs>]
.B mu extract [options] <file> [<parts>]
.B mu [options] .B mu [options]
.SH DESCRIPTION .SH DESCRIPTION
@ -68,9 +70,20 @@ for creating Maildirs. See
.BR mu-mkdir(1) .BR mu-mkdir(1)
\. \.
.TP .TP
The various commands are discussed in their separate manpages; here the \fBextract\fR
general options are discussed. for extract MIME-parts (such as attachments) from messages. See
.BR mu-extract(1)
\.
Subcommands \findex\fR, \ffind\fR and \cleanup\fR work with the database,
while the other ones work on invidual mail files. Hence, running \fview\fR,
\fBmkdir\fR and \fBextract\fR does not require the mu database.
.TP
The various commands are discussed in more detail in their own separate
man-pages; here the general options are discussed.
.SH GENERAL OPTIONS .SH GENERAL OPTIONS
@ -113,12 +126,6 @@ list the various command line options, while
\fB\-\-help\-index\fR, \fB\-\-help\-find\fR and \fB\-\-help\-all\fR list only \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. the options for one command, or all of the commands.
.SH ENVIRONMENT
As mentioned, \fBmu index\fR uses \fBMAILDIR\fR to find the user's Maildir if
it has not been specified explicitly \fB\-\-maildir\fR=\fI<maildir>\fR. If
MAILDIR is not set, \fBmu index\fR will try \fI~/Maildir\fR.
.
.SH BUGS .SH BUGS
There probably are some; please report bugs when you find them: There probably are some; please report bugs when you find them:
@ -131,7 +138,13 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO" .SH "SEE ALSO"
.BR mu-index(1) .BR mu-index(1)
.BR mu-find(1)
.BR mu-mkdir(1)
.BR mu-view(1)
.BR mu-cleanup(1) .BR mu-cleanup(1)
.BR mu-find(1)
.BR mu-mkdir(1)
.BR mu-view(1)
.BR mu-extract(1)

View File

@ -79,10 +79,7 @@ show_version (void)
"mu (mail indexer / searcher version) " VERSION "\n\n" "mu (mail indexer / searcher version) " VERSION "\n\n"
"Copyright (C) 2008-2010 Dirk-Jan C. Binnema\n" "Copyright (C) 2008-2010 Dirk-Jan C. Binnema\n"
"License GPLv3+: GNU GPL version 3 or later " "License GPLv3+: GNU GPL version 3 or later "
"<http://gnu.org/licenses/gpl.html>.\n\n" "<http://gnu.org/licenses/gpl.html>.";
"This is free software: you are free to change "
"and redistribute it.\n"
"There is NO WARRANTY, to the extent permitted by law.";
g_print ("%s\n", msg); g_print ("%s\n", msg);

View File

@ -1,5 +1,5 @@
/* /*
** Copyright (C) 2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> ** Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
** **
** This program is free software; you can redistribute it and/or modify it ** This program is free software; you can redistribute it and/or modify it
** under the terms of the GNU General Public License as published by the ** under the terms of the GNU General Public License as published by the