diff options
| author | Tomi Ollila <tomi.ollila@iki.fi> | 2012-06-22 10:08:09 +0300 |
|---|---|---|
| committer | Tomi Ollila <tomi.ollila@iki.fi> | 2012-06-22 10:08:09 +0300 |
| commit | 01b1bc7553d0b0ebf35ac3016c83240b4151ad59 (patch) | |
| tree | 67d51436a1f50383a1f870fa12a16f7433f53c63 | |
| parent | c2a1babf958cb98d7c16b0d901d94beeec20ff10 (diff) | |
manpages/ for quality control. manpages.mdwn todo
| -rw-r--r-- | manpages/notmuch-1.mdwn | 159 | ||||
| -rw-r--r-- | manpages/notmuch-config-1.mdwn | 167 | ||||
| -rw-r--r-- | manpages/notmuch-count-1.mdwn | 77 | ||||
| -rw-r--r-- | manpages/notmuch-dump-1.mdwn | 52 | ||||
| -rw-r--r-- | manpages/notmuch-hooks-5.mdwn | 62 | ||||
| -rw-r--r-- | manpages/notmuch-new-1.mdwn | 73 | ||||
| -rw-r--r-- | manpages/notmuch-reply-1.mdwn | 128 | ||||
| -rw-r--r-- | manpages/notmuch-restore-1.mdwn | 58 | ||||
| -rw-r--r-- | manpages/notmuch-search-1.mdwn | 163 | ||||
| -rw-r--r-- | manpages/notmuch-search-terms-7.mdwn | 179 | ||||
| -rw-r--r-- | manpages/notmuch-show-1.mdwn | 199 | ||||
| -rw-r--r-- | manpages/notmuch-tag-1.mdwn | 53 |
12 files changed, 1370 insertions, 0 deletions
diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn new file mode 100644 index 0000000..9049af6 --- /dev/null +++ b/manpages/notmuch-1.mdwn @@ -0,0 +1,159 @@ +<h1>NOTMUCH(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch - thread-based email index, search, and tagging +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <u>command</u> [<u>args</u> ...] +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Notmuch is a command-line based program for indexing, searching, read- + ing, and tagging large collections of email messages. +</pre> + +<pre> + This page describes how to get started using notmuch from the command + line, and gives a brief overview of the commands available. For more + information on e.g. <b>notmuch</b> <b>show</b> consult the <b>notmuch-รค-show</b>(1) man + page, also accessible via <b>notmuch</b> <b>help</b> <b>show</b> +</pre> + +<pre> + The quickest way to get started with Notmuch is to simply invoke the + <b>notmuch</b> command with no arguments, which will interactively guide you + through the process of indexing your mail. +</pre> + +<h2>NOTE</h2> + +<pre> + While the command-line program <b>notmuch</b> provides powerful functionality, + it does not provide the most convenient interface for that functional- + ity. More sophisticated interfaces are expected to be built on top of + either the command-line interface, or more likely, on top of the not- + much library interface. See http://notmuchmail.org for more about + alternate interfaces to notmuch. The emacs-based interface to notmuch + (available under <b>emacs/</b> in the Notmuch source distribution) is probably + the most widely used at this time. +</pre> + +<h2>COMMANDS</h2> + +<h3>SETUP</h3> + +<pre> + The <b>notmuch</b> <b>setup</b> command is used to configure Notmuch for first use, + (or to reconfigure it later). +</pre> + +<pre> + The setup command will prompt for your full name, your primary email + address, any alternate email addresses you use, and the directory con- + taining your email archives. Your answers will be written to a configu- + ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config . + This configuration file will be created with descriptive comments, mak- + ing it easy to edit by hand later to change the configuration. Or you + can run <b>notmuch</b> <b>setup</b> again to change the configuration. +</pre> + +<pre> + The mail directory you specify can contain any number of sub-directo- + ries and should primarily contain only files with individual email mes- + sages (eg. maildir or mh archives are perfect). If there are other, + non-email files (such as indexes maintained by other email programs) + then notmuch will do its best to detect those and ignore them. +</pre> + +<pre> + Mail storage that uses mbox format, (where one mbox file contains many + messages), will not work with notmuch. If that's how your mail is cur- + rently stored, it is recommended you first convert it to maildir format + with a utility such as mb2md before running <b>notmuch</b> <b>setup</b> <b>.</b> +</pre> + +<pre> + Invoking <b>notmuch</b> with no command argument will run <b>setup</b> if the setup + command has not previously been completed. +</pre> + +<h3>OTHER COMMANDS</h3> + +<pre> + Several of the notmuch commands accept search terms with a common syn- + tax. See notmuch-search-terms(7) for more details on the supported syn- + tax. +</pre> + +<pre> + The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the email data- + base. +</pre> + +<pre> + The <b>reply</b> command is useful for preparing a template for an email + reply. +</pre> + +<pre> + The <b>tag</b> command is the only command available for manipulating database + contents. +</pre> + +<pre> + The <b>dump</b> and <b>restore</b> commands can be used to create a textual dump of + email tags for backup purposes, and to restore from that dump. +</pre> + +<pre> + The <b>config</b> command can be used to get or set settings int the notmuch + configuration file. +</pre> + +<h2>ENVIRONMENT</h2> + +<pre> + The following environment variables can be used to control the behavior + of notmuch. +</pre> + +<pre> + <b>NOTMUCH</b>_<b>CONFIG</b> + Specifies the location of the notmuch configuration file. Not- + much will use ${HOME}/.notmuch-config if this variable is not + set. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>notmuch-hooks</b>(5), + <b>notmuch-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), <b>notmuch-</b> + <b>search</b>(1), <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<pre> + The notmuch website: <b>http://notmuchmail.org</b> +</pre> + +<h2>CONTACT</h2> + +<pre> + Feel free to send questions, comments, or kudos to the notmuch mailing + list <notmuch@notmuchmail.org> . Subscription is not required before + posting, but is available from the notmuchmail.org website. +</pre> + +<pre> + Real-time interaction with the Notmuch community is available via IRC + (server: irc.freenode.net, channel: #notmuch). +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn new file mode 100644 index 0000000..6fb6325 --- /dev/null +++ b/manpages/notmuch-config-1.mdwn @@ -0,0 +1,167 @@ +<h1>NOTMUCH-CONFIG(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-config - Access notmuch configuration file. +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>config</b> <b>get</b> <<u>section</u>>.<<u>item</u>> +</pre> + +<pre> + <b>notmuch</b> <b>config</b> <b>set</b> <<u>section</u>>.<<u>item</u>> [<u>value</u> ...] +</pre> + +<pre> + <b>notmuch</b> <b>config</b> <b>list</b> +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + The <b>config</b> command can be used to get or set settings in the notmuch + configuration file. +</pre> + +<pre> + <b>get</b> The value of the specified configuration item is printed to + stdout. If the item has multiple values (it is a list), each + value is separated by a newline character. +</pre> + +<pre> + <b>set</b> The specified configuration item is set to the given value. To + specify a multiple-value item (a list), provide each value as a + separate command-line argument. +</pre> + +<pre> + If no values are provided, the specified configuration item + will be removed from the configuration file. +</pre> + +<pre> + <b>list</b> + Every configuration item is printed to stdout, each on a sepa- + rate line of the form: +</pre> + +<pre> + <u>section</u>.<u>item</u>=<u>value</u> +</pre> + +<pre> + No additional whitespace surrounds the dot or equals sign char- + acters. In a multiple-value item (a list), the values are sepa- + rated by semicolon characters. +</pre> + +<pre> + The available configuration items are described below. +</pre> + +<pre> + <b>database.path</b> + The top-level directory where your mail currently exists and to + where mail will be delivered in the future. Files should be + individual email messages. Notmuch will store its database + within a sub-directory of the path configured here named <b>.not-</b> + <b>much</b>. +</pre> + +<pre> + <b>user.name</b> + Your full name. +</pre> + +<pre> + <b>user.primary</b>_<b>email</b> + Your primary email address. +</pre> + +<pre> + <b>user.other</b>_<b>email</b> + A list of other email addresses at which you receive email. +</pre> + +<pre> + <b>new.tags</b> + A list of tags that will be added to all messages incorporated + by <b>notmuch</b> <b>new</b>. +</pre> + +<pre> + <b>new.ignore</b> + A list of file and directory names, without path, that will not + be searched for messages by <b>notmuch</b> <b>new</b>. All the files and + directories matching any of the names specified here will be + ignored, regardless of the location in the mail store directory + hierarchy. +</pre> + +<pre> + <b>search.exclude</b>_<b>tags</b> + A list of tags that will be excluded from search results by + default. Using an excluded tag in a query will override that + exclusion. +</pre> + +<pre> + <b>maildir.synchronize</b>_<b>flags</b> + If true, then the following maildir flags (in message file- + names) will be synchronized with the corresponding notmuch + tags: +</pre> + +<pre> + Flag Tag + ---- ------- + D draft + F flagged + P passed + R replied + S unread (added when 'S' flag is not present) +</pre> + +<pre> + The <b>notmuch</b> <b>new</b> command will notice flag changes in filenames + and update tags, while the <b>notmuch</b> <b>tag</b> and <b>notmuch</b> <b>restore</b> com- + mands will notice tag changes and update flags in filenames. +</pre> + +<pre> + If there have been any changes in the maildir (new messages + added, old ones removed or renamed, maildir flags changed, + etc.), it is advisable to run <b>notmuch</b> <b>new</b> before <b>notmuch</b> <b>tag</b> or + <b>notmuch</b> <b>restore</b> commands to ensure the tag changes are properly + synchronized to the maildir flags, as the commands expect the + database and maildir to be in sync. +</pre> + +<h2>ENVIRONMENT</h2> + +<pre> + The following environment variables can be used to control the behavior + of notmuch. +</pre> + +<pre> + <b>NOTMUCH</b>_<b>CONFIG</b> + Specifies the location of the notmuch configuration file. Not- + much will use ${HOME}/.notmuch-config if this variable is not + set. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>notmuch-hooks</b>(5), <b>not-</b> + <b>much-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), <b>notmuch-search</b>(1), + <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn new file mode 100644 index 0000000..d789c8a --- /dev/null +++ b/manpages/notmuch-count-1.mdwn @@ -0,0 +1,77 @@ +<h1>NOTMUCH-COUNT(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-count - Count messages matching the given search terms. +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>count</b> [<u>options</u>... ] <<u>search-term</u>>... +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Count messages matching the search terms. +</pre> + +<pre> + The number of matching messages (or threads) is output to stdout. +</pre> + +<pre> + With no search terms, a count of all messages (or threads) in the data- + base will be displayed. +</pre> + +<pre> + See <b>notmuch-search-terms</b>(7) for details of the supported syntax for + <search-terms>. +</pre> + +<pre> + Supported options for <b>count</b> include +</pre> + +<pre> + <b>--output=(messages|threads)</b> +</pre> + +<pre> + <b>messages</b> +</pre> + +<pre> + Output the number of matching messages. This is the + default. +</pre> + +<pre> + <b>threads</b> +</pre> + +<pre> + Output the number of matching threads. +</pre> + +<pre> + <b>--exclude=(true|false)</b> +</pre> + +<pre> + Specify whether to omit messages matching search.tag_exclude + from the count (the default) or not. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-dump</b>(1), <b>notmuch-hooks</b>(5), <b>not-</b> + <b>much-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), <b>notmuch-search</b>(1), + <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn new file mode 100644 index 0000000..c95db8e --- /dev/null +++ b/manpages/notmuch-dump-1.mdwn @@ -0,0 +1,52 @@ +<h1>NOTMUCH-DUMP(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-dump - Creates a plain-text dump of the tags of each message. +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>dump</b> [ <<u>filename</u>> ] [--] [ <<u>search-term</u>>...] +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Dump tags for messages matching the given search terms. +</pre> + +<pre> + Output is to the given filename, if any, or to stdout. Note that using + the filename argument is deprecated. +</pre> + +<pre> + These tags are the only data in the notmuch database that can't be + recreated from the messages themselves. The output of notmuch dump is + therefore the only critical thing to backup (and much more friendly to + incremental backup than the native database files.) +</pre> + +<pre> + With no search terms, a dump of all messages in the database will be + generated. A "--" argument instructs notmuch that the remaining argu- + ments are search terms. +</pre> + +<pre> + See <b>notmuch-search-terms</b>(7) for details of the supported syntax for + <search-terms>. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-hooks</b>(5), <b>not-</b> + <b>much-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), <b>notmuch-search</b>(1), + <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn new file mode 100644 index 0000000..d027353 --- /dev/null +++ b/manpages/notmuch-hooks-5.mdwn @@ -0,0 +1,62 @@ +<h1>NOTMUCH-HOOKS(5)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-hooks - hooks for notmuch +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + $DATABASEDIR/.notmuch/hooks/* +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Hooks are scripts (or arbitrary executables or symlinks to such) that + notmuch invokes before and after certain actions. These scripts reside + in the .notmuch/hooks directory within the database directory and must + have executable permissions. +</pre> + +<pre> + The currently available hooks are described below. +</pre> + +<pre> + <b>pre-new</b> + This hook is invoked by the <b>new</b> command before scanning or + importing new messages into the database. If this hook exits + with a non-zero status, notmuch will abort further processing + of the <b>new</b> command. +</pre> + +<pre> + Typically this hook is used for fetching or delivering new mail + to be imported into the database. +</pre> + +<pre> + <b>post-new</b> + This hook is invoked by the <b>new</b> command after new messages have + been imported into the database and initial tags have been + applied. The hook will not be run if there have been any errors + during the scan or import. +</pre> + +<pre> + Typically this hook is used to perform additional query-based + tagging on the imported messages. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>not-</b> + <b>much-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), <b>notmuch-search</b>(1), + <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn new file mode 100644 index 0000000..f0f279b --- /dev/null +++ b/manpages/notmuch-new-1.mdwn @@ -0,0 +1,73 @@ +<h1>NOTMUCH-NEW(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-new - Incorporate new mail into the notmuch database. +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>new</b> [<b>--no-hooks</b>] +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Find and import any new messages to the database. +</pre> + +<pre> + The <b>new</b> command scans all sub-directories of the database, performing + full-text indexing on new messages that are found. Each new message + will automatically be tagged with both the <b>inbox</b> and <b>unread</b> tags. +</pre> + +<pre> + You should run <b>notmuch</b> <b>new</b> once after first running <b>notmuch</b> <b>setup</b> to + create the initial database. The first run may take a long time if you + have a significant amount of mail (several hundred thousand messages or + more). Subsequently, you should run <b>notmuch</b> <b>new</b> whenever new mail is + delivered and you wish to incorporate it into the database. These sub- + sequent runs will be much quicker than the initial run. +</pre> + +<pre> + Invoking <b>notmuch</b> with no command argument will run <b>new</b> if <b>notmuch</b> <b>setup</b> + has previously been completed, but <b>notmuch</b> <b>new</b> has not previously been + run. +</pre> + +<pre> + <b>notmuch</b> <b>new</b> updates tags according to maildir flag changes if the + <b>maildir.synchronize</b>_<b>flags</b> configuration option is enabled. See <b>notmuch-</b> + <b>config</b>(1) for details. +</pre> + +<pre> + The <b>new</b> command supports hooks. See <b>notmuch-hooks(5)</b> for more details + on hooks. +</pre> + +<pre> + Supported options for <b>new</b> include +</pre> + +<pre> + <b>--no-hooks</b> +</pre> + +<pre> + Prevents hooks from being run. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>not-</b> + <b>much-hooks</b>(5), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), <b>notmuch-search</b>(1), + <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn new file mode 100644 index 0000000..941dd43 --- /dev/null +++ b/manpages/notmuch-reply-1.mdwn @@ -0,0 +1,128 @@ +<h1>NOTMUCH-REPLY(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-reply - Constructs a reply template for a set of messages. +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>reply</b> [<u>options</u>...] <<u>search-term</u>>... +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Constructs a reply template for a set of messages. +</pre> + +<pre> + To make replying to email easier, <b>notmuch</b> <b>reply</b> takes an existing set + of messages and constructs a suitable mail template. The Reply-to: + header (if any, otherwise From:) is used for the To: address. Unless + <b>--reply-to=sender</b> is specified, values from the To: and Cc: headers are + copied, but not including any of the current user's email addresses (as + configured in primary_mail or other_email in the .notmuch-config file) + in the recipient list. +</pre> + +<pre> + It also builds a suitable new subject, including Re: at the front (if + not already present), and adding the message IDs of the messages being + replied to to the References list and setting the In-Reply-To: field + correctly. +</pre> + +<pre> + Finally, the original contents of the emails are quoted by prefixing + each line with '> ' and included in the body. +</pre> + +<pre> + The resulting message template is output to stdout. +</pre> + +<pre> + Supported options for <b>reply</b> include +</pre> + +<pre> + <b>--format=</b>(<b>default</b>|<b>json</b>|<b>headers-only</b>) +</pre> + +<pre> + <b>default</b> + Includes subject and quoted message body. +</pre> + +<pre> + <b>json</b> + Produces JSON output containing headers for a reply mes- + sage and the contents of the original message. This out- + put can be used by a client to create a reply message + intelligently. +</pre> + +<pre> + <b>headers-only</b> + Only produces In-Reply-To, References, To, Cc, and Bcc + headers. +</pre> + +<pre> + <b>--reply-to=</b>(<b>all</b>|<b>sender</b>) +</pre> + +<pre> + <b>all</b> (default) + Replies to all addresses. +</pre> + +<pre> + <b>sender</b> + Replies only to the sender. If replying to user's own + message (Reply-to: or From: header is one of the user's + configured email addresses), try To:, Cc:, and Bcc: + headers in this order, and copy values from the first + that contains something other than only the user's + addresses. +</pre> + +<pre> + <b>--decrypt</b> +</pre> + +<pre> + Decrypt any MIME encrypted parts found in the selected con- + tent (ie. "multipart/encrypted" parts). Status of the + decryption will be reported (currently only supported with + --format=json) and the multipart/encrypted part will be + replaced by the decrypted content. +</pre> + +<pre> + See <b>notmuch-search-terms</b>(7) for details of the supported syntax for + <search-terms>. +</pre> + +<pre> + Note: It is most common to use <b>notmuch</b> <b>reply</b> with a search string + matching a single message, (such as id:<message-id>), but it can be + useful to reply to several messages at once. For example, when a series + of patches are sent in a single thread, replying to the entire thread + allows for the reply to comment on issues found in multiple patches. + The default format supports replying to multiple messages at once, but + the JSON format does not. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>not-</b> + <b>much-hooks</b>(5), <b>notmuch-new</b>(1), <b>notmuch-restore</b>(1), <b>notmuch-search</b>(1), + <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn new file mode 100644 index 0000000..f6646fc --- /dev/null +++ b/manpages/notmuch-restore-1.mdwn @@ -0,0 +1,58 @@ +<h1>NOTMUCH-RESTORE(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-restore - Restores the tags from the given file (see notmuch + dump). +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>restore</b> [<b>--accumulate</b>] [ <<u>filename</u>> ] +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Restores the tags from the given file (see <b>notmuch</b> <b>dump</b>). +</pre> + +<pre> + The input is read from the given filename, if any, or from stdin. +</pre> + +<pre> + Note: The dump file format is specifically chosen to be compatible with + the format of files produced by sup-dump. So if you've previously been + using sup for mail, then the <b>notmuch</b> <b>restore</b> command provides you a way + to import all of your tags (or labels as sup calls them). +</pre> + +<pre> + The --accumulate switch causes the union of the existing and new tags + to be applied, instead of replacing each message's tags as they are + read in from the dump file. +</pre> + +<pre> + See <b>notmuch-search-terms</b>(7) for details of the supported syntax for + <search-terms>. +</pre> + +<pre> + <b>notmuch</b> <b>restore</b> updates the maildir flags according to tag changes if + the <b>maildir.synchronize</b>_<b>flags</b> configuration option is enabled. See <b>not-</b> + <b>much-config</b>(1) for details. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>not-</b> + <b>much-hooks</b>(5), <b>notmuch-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-search</b>(1), + <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn new file mode 100644 index 0000000..95eead4 --- /dev/null +++ b/manpages/notmuch-search-1.mdwn @@ -0,0 +1,163 @@ +<h1>NOTMUCH-SEARCH(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-search - Search for messages matching the given search terms. +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>search</b> [<u>options</u>...] <<u>search-term</u>>... +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Search for messages matching the given search terms, and display as + results the threads containing the matched messages. +</pre> + +<pre> + The output consists of one line per thread, giving a thread ID, the + date of the newest (or oldest, depending on the sort option) matched + message in the thread, the number of matched messages and total mes- + sages in the thread, the names of all participants in the thread, and + the subject of the newest (or oldest) message. +</pre> + +<pre> + See <b>notmuch-search-terms</b>(7) for details of the supported syntax for + <search-terms>. +</pre> + +<pre> + Supported options for <b>search</b> include +</pre> + +<pre> + <b>--format=</b>(<b>json</b>|<b>text</b>) +</pre> + +<pre> + Presents the results in either JSON or plain-text (default). +</pre> + +<pre> + <b>--output=(summary|threads|messages|files|tags)</b> +</pre> + +<pre> + <b>summary</b> +</pre> + +<pre> + Output a summary of each thread with any message matching + the search terms. The summary includes the thread ID, date, + the number of messages in the thread (both the number + matched and the total number), the authors of the thread + and the subject. +</pre> + +<pre> + <b>threads</b> +</pre> + +<pre> + Output the thread IDs of all threads with any message + matching the search terms, either one per line (--for- + mat=text) or as a JSON array (--format=json). +</pre> + +<pre> + <b>messages</b> +</pre> + +<pre> + Output the message IDs of all messages matching the search + terms, either one per line (--format=text) or as a JSON + array (--format=json). +</pre> + +<pre> + <b>files</b> +</pre> + +<pre> + Output the filenames of all messages matching the search + terms, either one per line (--format=text) or as a JSON + array (--format=json). +</pre> + +<pre> + <b>tags</b> +</pre> + +<pre> + Output all tags that appear on any message matching the + search terms, either one per line (--format=text) or as a + JSON array (--format=json). +</pre> + +<pre> + <b>--sort=</b>(<b>newest-first</b>|<b>oldest-first</b>) +</pre> + +<pre> + This option can be used to present results in either chronolog- + ical order (<b>oldest-first</b>) or reverse chronological order (<b>new-</b> + <b>est-first</b>). +</pre> + +<pre> + Note: The thread order will be distinct between these two + options (beyond being simply reversed). When sorting by <b>old-</b> + <b>est-first</b> the threads will be sorted by the oldest message in + each thread, but when sorting by <b>newest-first</b> the threads will + be sorted by the newest message in each thread. +</pre> + +<pre> + By default, results will be displayed in reverse chronological + order, (that is, the newest results will be displayed first). +</pre> + +<pre> + <b>--offset=[-]N</b> +</pre> + +<pre> + Skip displaying the first N results. With the leading '-', + start at the Nth result from the end. +</pre> + +<pre> + <b>--limit=N</b> +</pre> + +<pre> + Limit the number of displayed results to N. +</pre> + +<pre> + <b>--exclude=(true|false|flag)</b> +</pre> + +<pre> + Specify whether to omit messages matching search.tag_exclude + from the search results (the default) or not. The extra option + <b>flag</b> only has an effect when <b>--output=summary</b> In this case all + matching threads are returned but the "match count" is the num- + ber of matching non-excluded messages in the thread. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>not-</b> + <b>much-hooks</b>(5), <b>notmuch-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), + <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn new file mode 100644 index 0000000..5e0ffa9 --- /dev/null +++ b/manpages/notmuch-search-terms-7.mdwn @@ -0,0 +1,179 @@ +<h1>NOTMUCH-SEARCH-TERMS(7)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-search-terms - Syntax for notmuch queries +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>count</b> [<u>options...</u>] <<u>search-term</u>>... +</pre> + +<pre> + <b>notmuch</b> <b>dump</b> [ <<u>filename</u>> ] [--] [ <<u>search-term</u>>...] +</pre> + +<pre> + <b>notmuch</b> <b>search</b> [<u>options</u>...] <<u>search-term</u>>... +</pre> + +<pre> + <b>notmuch</b> <b>show</b> [<u>options</u>...] <<u>search-term</u>>... +</pre> + +<pre> + <b>notmuch</b> <b>tag</b> +<<u>tag></u>|-<<u>tag</u>> [...] [--] <<u>search-term</u>>... +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Several notmuch commands accept a common syntax for search terms. +</pre> + +<pre> + The search terms can consist of free-form text (and quoted phrases) + which will match all messages that contain all of the given + terms/phrases in the body, the subject, or any of the sender or recipi- + ent headers. +</pre> + +<pre> + As a special case, a search string consisting of exactly a single + asterisk ("*") will match all messages. +</pre> + +<pre> + In addition to free text, the following prefixes can be used to force + terms to match against specific portions of an email, (where <brackets> + indicate user-supplied values): +</pre> + +<pre> + from:<name-or-address> +</pre> + +<pre> + to:<name-or-address> +</pre> + +<pre> + subject:<word-or-quoted-phrase> +</pre> + +<pre> + attachment:<word> +</pre> + +<pre> + tag:<tag> (or is:<tag>) +</pre> + +<pre> + id:<message-id> +</pre> + +<pre> + thread:<thread-id> +</pre> + +<pre> + folder:<directory-path> +</pre> + +<pre> + The <b>from:</b> prefix is used to match the name or address of the sender of + an email message. +</pre> + +<pre> + The <b>to:</b> prefix is used to match the names or addresses of any recipient + of an email message, (whether To, Cc, or Bcc). +</pre> + +<pre> + Any term prefixed with <b>subject:</b> will match only text from the subject + of an email. Searching for a phrase in the subject is supported by + including quotation marks around the phrase, immediately following <b>sub-</b> + <b>ject:</b>. +</pre> + +<pre> + The <b>attachment:</b> prefix can be used to search for specific filenames (or + extensions) of attachments to email messages. +</pre> + +<pre> + For <b>tag:</b> and <b>is:</b> valid tag values include <b>inbox</b> and <b>unread</b> by default + for new messages added by <b>notmuch</b> <b>new</b> as well as any other tag values + added manually with <b>notmuch</b> <b>tag</b>. +</pre> + +<pre> + For <b>id:</b>, message ID values are the literal contents of the Message-ID: + header of email messages, but without the '<', '>' delimiters. +</pre> + +<pre> + The <b>thread:</b> prefix can be used with the thread ID values that are gen- + erated internally by notmuch (and do not appear in email messages). + These thread ID values can be seen in the first column of output from + <b>notmuch</b> <b>search</b> +</pre> + +<pre> + The <b>folder:</b> prefix can be used to search for email message files that + are contained within particular directories within the mail store. Only + the directory components below the top-level mail database path are + available to be searched. +</pre> + +<pre> + In addition to individual terms, multiple terms can be combined with + Boolean operators ( <b>and</b>, <b>or</b>, <b>not</b> , etc.). Each term in the query will + be implicitly connected by a logical AND if no explicit operator is + provided, (except that terms with a common prefix will be implicitly + combined with OR until we get Xapian defect #402 fixed). +</pre> + +<pre> + Parentheses can also be used to control the combination of the Boolean + operators, but will have to be protected from interpretation by the + shell, (such as by putting quotation marks around any parenthesized + expression). +</pre> + +<pre> + Finally, results can be restricted to only messages within a particular + time range, (based on the Date: header) with a syntax of: +</pre> + +<pre> + <initial-timestamp>..<final-timestamp> +</pre> + +<pre> + Each timestamp is a number representing the number of seconds since + 1970-01-01 00:00:00 UTC. This is not the most convenient means of + expressing date ranges, but until notmuch is fixed to accept a more + convenient form, one can use the date program to construct timestamps. + For example, with the bash shell the following syntax would specify a + date range to return messages from 2009-10-01 until the current time: +</pre> + +<pre> + $(date +%s -d 2009-10-01)..$(date +%s) +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>not-</b> + <b>much-hooks</b>(5), <b>notmuch-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), + <b>notmuch-search</b>(1), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn new file mode 100644 index 0000000..362c288 --- /dev/null +++ b/manpages/notmuch-show-1.mdwn @@ -0,0 +1,199 @@ +<h1>NOTMUCH-SHOW(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-show - Show messages matching the given search terms. +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>show</b> [<u>options</u>...] <<u>search-term</u>>... +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Shows all messages matching the search terms. +</pre> + +<pre> + See <b>notmuch-search-terms</b>(7) for details of the supported syntax for + <search-terms>. +</pre> + +<pre> + The messages will be grouped and sorted based on the threading (all + replies to a particular message will appear immediately after that mes- + sage in date order). The output is not indented by default, but depth + tags are printed so that proper indentation can be performed by a post- + processor (such as the emacs interface to notmuch). +</pre> + +<pre> + Supported options for <b>show</b> include +</pre> + +<pre> + <b>--entire-thread</b> +</pre> + +<pre> + By default only those messages that match the search terms will + be displayed. With this option, all messages in the same thread + as any matched message will be displayed. +</pre> + +<pre> + <b>--format=(text|json|mbox|raw)</b> +</pre> + +<pre> + <b>text</b> (default for messages) +</pre> + +<pre> + The default plain-text format has all text-content MIME + parts decoded. Various components in the output, (<b>message</b>, + <b>header</b>, <b>body</b>, <b>attachment</b>, and MIME <b>part</b>), will be delimited + by easily-parsed markers. Each marker consists of a Con- + trol-L character (ASCII decimal 12), the name of the + marker, and then either an opening or closing brace, ('{' + or '}'), to either open or close the component. For a mul- + tipart MIME message, these parts will be nested. +</pre> + +<pre> + <b>json</b> +</pre> + +<pre> + The output is formatted with Javascript Object Notation + (JSON). This format is more robust than the text format for + automated processing. The nested structure of multipart + MIME messages is reflected in nested JSON output. JSON out- + put always includes all messages in a matching thread; in + effect <b>--format=json</b> implies <b>--entire-thread</b> +</pre> + +<pre> + <b>mbox</b> +</pre> + +<pre> + All matching messages are output in the traditional, Unix + mbox format with each message being prefixed by a line + beginning with "From " and a blank line separating each + message. Lines in the message content beginning with "From + " (preceded by zero or more '>' characters) have an addi- + tional '>' character added. This reversible escaping is + termed "mboxrd" format and described in detail here: +</pre> + +<pre> + http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html +</pre> + +<pre> + <b>raw</b> (default for a single part, see --part) +</pre> + +<pre> + For a message or an attached message part, the original, + raw content of the email message is output. Consumers of + this format should expect to implement MIME decoding and + similar functions. +</pre> + +<pre> + For a single part (--part) the raw part content is output + after performing any necessary MIME decoding. Note that + messages with a simple body still have two parts: part 0 is + the whole message and part 1 is the body. +</pre> + +<pre> + For a multipart part, the part headers and body (including + all child parts) is output. +</pre> + +<pre> + The raw format must only be used with search terms matching + single message. +</pre> + +<pre> + <b>--part=N</b> +</pre> + +<pre> + Output the single decoded MIME part N of a single message. The + search terms must match only a single message. Message parts + are numbered in a depth-first walk of the message MIME struc- + ture, and are identified in the 'json' or 'text' output for- + mats. +</pre> + +<pre> + <b>--verify</b> +</pre> + +<pre> + Compute and report the validity of any MIME cryptographic sig- + natures found in the selected content (ie. "multipart/signed" + parts). Status of the signature will be reported (currently on- + ly supported with --format=json), and the multipart/signed part + will be replaced by the signed data. +</pre> + +<pre> + <b>--decrypt</b> +</pre> + +<pre> + Decrypt any MIME encrypted parts found in the selected content + (ie. "multipart/encrypted" parts). Status of the decryption + will be reported (currently only supported with --format=json) + and the multipart/encrypted part will be replaced by the de- + crypted content. Implies --verify. +</pre> + +<pre> + <b>--exclude=(true|false)</b> +</pre> + +<pre> + Specify whether to omit threads only matching search.tag_ex- + clude from the search results (the default) or not. In either + case the excluded message will be marked with the exclude flag + (except when output=mbox when there is nowhere to put the + flag). +</pre> + +<pre> + If --entire-thread is specified then complete threads are re- + turned regardless (with the excluded flag being set when appro- + priate) but threads that only match in an excluded message are + not returned when <b>--exclude=true.</b> +</pre> + +<pre> + The default is <b>--exclude=true.</b> +</pre> + +<pre> + A common use of <b>notmuch</b> <b>show</b> is to display a single thread of email + messages. For this, use a search term of "thread:<thread-id>" as can be + seen in the first column of output from the <b>notmuch</b> <b>search</b> command. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>not-</b> + <b>much-hooks</b>(5), <b>notmuch-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), + <b>notmuch-search</b>(1), <b>notmuch-search-terms</b>(7), <b>notmuch-tag</b>(1) +</pre> + +<h1>Notmuch 0.13.2</h1> diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn new file mode 100644 index 0000000..1e5fa16 --- /dev/null +++ b/manpages/notmuch-tag-1.mdwn @@ -0,0 +1,53 @@ +<h1>NOTMUCH-TAG(1)</h1> + +<h2>NAME</h2> + +<pre> + notmuch-tag - Add/remove tags for all messages matching the search + terms. +</pre> + +<h2>SYNOPSIS</h2> + +<pre> + <b>notmuch</b> <b>tag</b> +<<u>tag></u>|-<<u>tag</u>> [...] [--] <<u>search-term</u>>... +</pre> + +<h2>DESCRIPTION</h2> + +<pre> + Add/remove tags for all messages matching the search terms. +</pre> + +<pre> + See <b>notmuch-search-terms</b>(7) for details of the supported syntax for + <search-terms>. +</pre> + +<pre> + Tags prefixed by '+' are added while those prefixed by '-' are removed. + For each message, tag removal is performed before tag addition. +</pre> + +<pre> + The beginning of <search-terms> is recognized by the first argument + that begins with neither '+' nor '-'. Support for an initial search + term beginning with '+' or '-' is provided by allowing the user to + specify a "--" argument to separate the tags from the search terms. +</pre> + +<pre> + <b>notmuch</b> <b>tag</b> updates the maildir flags according to tag changes if the + <b>maildir.synchronize</b>_<b>flags</b> configuration option is enabled. See <b>notmuch-</b> + <b>config</b>(1) for details. +</pre> + +<h2>SEE ALSO</h2> + +<pre> + <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>not-</b> + <b>much-hooks</b>(5), <b>notmuch-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), + <b>notmuch-search</b>(1), <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), +</pre> + +<h1>Notmuch 0.13.2</h1> |
