From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 248E5431FB6 for ; Wed, 25 Jul 2012 06:44:42 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: -0.799 X-Spam-Level: X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 54vC6sM2tbHi for ; Wed, 25 Jul 2012 06:44:41 -0700 (PDT) Received: from mail-pb0-f53.google.com (mail-pb0-f53.google.com [209.85.160.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id 2110A429E2F for ; Wed, 25 Jul 2012 06:44:36 -0700 (PDT) Received: by mail-pb0-f53.google.com with SMTP id rr13so1767731pbb.26 for ; Wed, 25 Jul 2012 06:44:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=w4tmVfn9nhdL3T0f36rW7la6AxHiLOHFHdG9Xn8G3e0=; b=hXRa1BDLHbfvaEC1cQT1z9fAsFXcycu+VbXfaF1Y2EpCtaRj96TPfvNLS8VVaC2VHE dyggRzB10ZnzSWAt3UKLBAtjOm0CcTIREhS02B/x8QJs+RSamHmIQTtd7wjUsQgfs3u2 /BFL7nkkuBUEeQLoqG1PeN0ALFEpMlbfP7DL/eZEi782+yfrzsX1vKyD55Z7kGS0f/P5 RNvw2l/VkR/D6N4HeKBL3bSLBGTjC3C74UyMkKuETXyTidrMMOZ9yI374Sl0SkAPCcXZ jEJvRk80AKFVrqAT0ILgbGNwFyNW+NBwd/gLa9oy1fNTsr92U/bFP+pN9Ys6A0csBcvB MJ/A== Received: by 10.68.232.197 with SMTP id tq5mr53461113pbc.53.1343223875934; Wed, 25 Jul 2012 06:44:35 -0700 (PDT) Received: from localhost (215.42.233.220.static.exetel.com.au. [220.233.42.215]) by mx.google.com with ESMTPS id ov8sm3212359pbb.2.2012.07.25.06.44.33 (version=TLSv1/SSLv3 cipher=OTHER); Wed, 25 Jul 2012 06:44:35 -0700 (PDT) From: Peter Wang 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> X-Mailer: git-send-email 1.7.4.4 In-Reply-To: <1343223767-9812-1-git-send-email-novalazy@gmail.com> References: <1343223767-9812-1-git-send-email-novalazy@gmail.com> X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 25 Jul 2012 13:44:42 -0000 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