unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Mark Walters <markwalters1009@gmail.com>
To: Peter Wang <novalazy@gmail.com>, notmuch@notmuchmail.org
Subject: Re: [PATCH v2 19/20] man: document 'insert' command
Date: Sun, 25 Nov 2012 16:17:10 +0000	[thread overview]
Message-ID: <8738zxk67t.fsf@qmul.ac.uk> (raw)
In-Reply-To: <1353806206-29133-20-git-send-email-novalazy@gmail.com>

On Sun, 25 Nov 2012, Peter Wang <novalazy@gmail.com> wrote:
> Add initial documentation for notmuch insert command.
> ---
>  man/Makefile.local        |  1 +
>  man/man1/notmuch-insert.1 | 60 +++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 61 insertions(+)
>  create mode 100644 man/man1/notmuch-insert.1
>
> diff --git a/man/Makefile.local b/man/Makefile.local
> index 72e2a18..216aaa0 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..8b1c4e9
> --- /dev/null
> +++ b/man/man1/notmuch-insert.1
> @@ -0,0 +1,60 @@
> +.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 "[ +<" 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.

Is it worth emphasising that the command line tags are applied after the
new tags so can be used to remove the new tags?

Best wishes

Mark

> +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
> +
> +.RS 4
> +.TP 4
> +.B "--create-folder"
> +
> +Try to create the folder named by the
> +.B "--folder"
> +option, if it does not exist.
> +Otherwise the folder must already exist for mail
> +delivery to succeed.
> +
> +.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.12.1
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

  reply	other threads:[~2012-11-25 16:17 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-11-25  1:16 [PATCH v2 00/20] insert command Peter Wang
2012-11-25  1:16 ` [PATCH v2 01/20] tag: factor out tag operation parsing Peter Wang
2012-11-25 16:13   ` Mark Walters
2012-11-25  1:16 ` [PATCH v2 02/20] tag: make tag operation parser public Peter Wang
2012-11-25  1:16 ` [PATCH v2 03/20] cli: add stub for insert command Peter Wang
2012-11-25  1:16 ` [PATCH v2 04/20] insert: open Maildir tmp file Peter Wang
2012-11-25  1:16 ` [PATCH v2 05/20] insert: copy stdin to " Peter Wang
2012-11-26  9:39   ` Tomi Ollila
2012-11-26 12:05     ` Peter Wang
2012-11-25  1:16 ` [PATCH v2 06/20] insert: move file from Maildir tmp to new Peter Wang
2012-11-25  1:16 ` [PATCH v2 07/20] insert: add new message to database Peter Wang
2012-11-25  1:16 ` [PATCH v2 08/20] insert: support --folder option Peter Wang
2012-11-25  1:16 ` [PATCH v2 09/20] insert: prevent writes outside Maildir hierarchy Peter Wang
2012-11-25  1:16 ` [PATCH v2 10/20] insert: apply default tags to new message Peter Wang
2012-11-25  1:16 ` [PATCH v2 11/20] insert: parse command-line tag operations Peter Wang
2012-11-25  1:16 ` [PATCH v2 12/20] insert: apply " Peter Wang
2012-11-25  1:16 ` [PATCH v2 13/20] insert: add --create-folder option Peter Wang
2012-11-25  1:16 ` [PATCH v2 14/20] insert: fsync after writing tmp file Peter Wang
2012-11-25  1:16 ` [PATCH v2 15/20] insert: fsync new directory after rename Peter Wang
2012-11-25 16:15   ` Mark Walters
2012-11-25  1:16 ` [PATCH v2 16/20] insert: trap SIGINT and clean up Peter Wang
2012-11-25  1:16 ` [PATCH v2 17/20] insert: add copyright line from notmuch-deliver Peter Wang
2012-11-25  1:16 ` [PATCH v2 18/20] test: add tests for insert Peter Wang
2012-11-25 16:23   ` Mark Walters
2012-11-25  1:16 ` [PATCH v2 19/20] man: document 'insert' command Peter Wang
2012-11-25 16:17   ` Mark Walters [this message]
2012-11-25  1:16 ` [PATCH v2 20/20] man: reference notmuch-insert.1 Peter Wang
2012-11-25 16:11 ` [PATCH v2 00/20] insert command Mark Walters
2012-11-25 19:21 ` David Bremner
2012-11-26  2:42   ` Peter Wang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=8738zxk67t.fsf@qmul.ac.uk \
    --to=markwalters1009@gmail.com \
    --cc=notmuch@notmuchmail.org \
    --cc=novalazy@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).