* add 'mu add' and 'mu remove' commands for adding, removing messages from the database

2011-08-03 23:00:48 +03:00
parent ef086db2a7
commit 82be4974b7
6 changed files with 243 additions and 71 deletions
--- a/man/mu-add.1
+++ b/man/mu-add.1
@ -0,0 +1,48 @@
+.TH MU ADD 1 "August 2011" "User Manuals"
+
+.SH NAME 
+
+mu add\-  add one or more messages to the database 
+
+.SH SYNOPSIS
+
+.B mu add <file> [<files>]
+
+.SH DESCRIPTION
+
+\fBmu add\fR adds specific files to the database. Each of the files must be
+specified with an absolute path.
+
+.SH OPTIONS
+
+\fBmu add\fR does not have its own options, but the general options for
+determining the location of the database (\fI--muhome\fR) are available. See
+\fBmu-index(1)\fR for more information.
+
+.SH RETURN VALUE
+
+\fBmu add\fR returns 0 upon success; in general, the following error codes are
+returned:
+
+.nf
+| code | meaning                           |
+|------+-----------------------------------|
+|    0 | ok                                |
+|    1 | general error                     |
+|    5 | some database update error        |
+.fi
+
+.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(1)
+.BR mu-index(1)
+.BR mu-remove(1)
--- a/man/mu-remove.1
+++ b/man/mu-remove.1
@ -0,0 +1,48 @@
+.TH MU REMOVE 1 "August 2011" "User Manuals"
+
+.SH NAME 
+
+mu remove\-  remove one or more messages to the database 
+
+.SH SYNOPSIS
+
+.B mu remove <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).
+
+.SH OPTIONS
+
+\fBmu remove\fR does not have its own options, but the general options for
+determining the location of the database (\fI--muhome\fR) are available. See
+\fBmu-index(1)\fR for more information.
+
+.SH RETURN VALUE
+
+\fBmu remove\fR returns 0 upon success; in general, the following error codes are
+returned:
+
+.nf
+| code | meaning                           |
+|------+-----------------------------------|
+|    0 | ok                                |
+|    1 | general error                     |
+|    5 | some database update error        |
+.fi
+
+.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(1)
+.BR mu-index(1)
+.BR mu-add(1)