man: document insert --folder option
authorPeter Wang <novalazy@gmail.com>
Sun, 23 Jun 2013 04:24:01 +0000 (14:24 +1000)
committerDavid Bremner <bremner@debian.org>
Mon, 1 Jul 2013 15:22:57 +0000 (12:22 -0300)
Add documentation for notmuch insert --folder option.

man/man1/notmuch-insert.1

index fbf83e03c7f722e9002449bd281cfb687e17642c..e85fef8a5d1635410e4bd8f6328d09512bb2701d 100644 (file)
@@ -4,6 +4,7 @@ notmuch-insert \- add a message to the maildir and notmuch database
 .SH SYNOPSIS
 
 .B notmuch insert
+.RI "[" options "]"
 .RI "[ +<" tag> "|\-<" tag "> ... ]"
 
 .SH DESCRIPTION
@@ -28,6 +29,19 @@ If the new message is a duplicate of an existing message in the database
 (it has same Message-ID), it will be added to the maildir folder and
 notmuch database, but the tags will not be changed.
 
+Option arguments must appear before any tag operation arguments.
+Supported options for
+.B insert
+include
+.RS 4
+.TP 4
+.BI "--folder=<" folder ">"
+
+Deliver the message to the specified folder,
+relative to the top-level directory given by the value of
+\fBdatabase.path\fR.
+The default is to deliver to the top-level directory.
+
 .RE
 .SH EXIT STATUS