From: Peter Wang <novalazy@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH 14/18] man: document 'insert' command
Date: Wed, 25 Jul 2012 23:42:43 +1000
Message-Id: <1343223767-9812-14-git-send-email-novalazy@gmail.com>
In-Reply-To: <1343223767-9812-1-git-send-email-novalazy@gmail.com>
References: <1343223767-9812-1-git-send-email-novalazy@gmail.com>
Precedence: list

Add initial documentation for notmuch insert command.
---
 man/Makefile.local        |    1 +
 man/man1/notmuch-insert.1 |   50 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 51 insertions(+), 0 deletions(-)
 create mode 100644 man/man1/notmuch-insert.1

diff --git a/man/Makefile.local b/man/Makefile.local
index d43a949..f91bfd4 100644
--- a/man/Makefile.local
+++ b/man/Makefile.local
@@ -12,6 +12,7 @@ MAN1 := \
 	$(dir)/man1/notmuch-count.1 \
 	$(dir)/man1/notmuch-dump.1 \
 	$(dir)/man1/notmuch-restore.1 \
+	$(dir)/man1/notmuch-insert.1 \
 	$(dir)/man1/notmuch-new.1 \
 	$(dir)/man1/notmuch-reply.1 \
 	$(dir)/man1/notmuch-search.1 \
diff --git a/man/man1/notmuch-insert.1 b/man/man1/notmuch-insert.1
new file mode 100644
index 0000000..7d281b5
--- /dev/null
+++ b/man/man1/notmuch-insert.1
@@ -0,0 +1,50 @@
+.TH NOTMUCH-INSERT 1 2012-xx-xx "Notmuch 0.xx"
+.SH NAME
+notmuch-insert \- add a message to the maildir and notmuch database
+.SH SYNOPSIS
+
+.B notmuch insert
+.RI "[" options "]"
+.RI "--"
+.RI "[ +<" tag> "|\-<" tag "> ... ]"
+
+.SH DESCRIPTION
+
+.B notmuch insert
+reads a message from standard input and delivers it to the specified
+maildir folder, then incorporates the message into the notmuch
+database.  It is an alternative to using a separate tool to deliver
+the message then running
+.B notmuch new
+afterwards.
+
+The new message will be tagged with the tags specified by the
+.B new.tags
+configuration option.
+Additional tagging operations may be specified on the command-line.
+Tags prefixed by '+' are added while those prefixed by '\-' are
+removed.  notmuch will warn about ambiguous tag removal arguments
+which may be confused with option arguments.  It is recommended to use
+the option list terminator "--" to avoid ambiguity.
+
+Supported options for
+.B insert
+include
+.RS 4
+.TP 4
+.BI "--folder=<" folder ">"
+
+Deliver the message to the
+.RI Maildir/ folder
+directory, which must already exist.
+The default is to deliver to the top-level directory.
+
+.RE
+.RE
+.SH SEE ALSO
+
+\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
+\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-reply\fR(1),
+\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
+\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
+\fBnotmuch-tag\fR(1)
-- 
1.7.4.4