X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=1919176e79ca52aa64e3113bace55b7a5c671263;hp=3ec9c55c0d453fa0a2e97ab175cbeb0ec8221feb;hb=6dcb7592e32ed5140ea0c0357ce78d6a37af6066;hpb=9f0accb6aa1be3aa3a00e564b1091f875cf45e80 diff --git a/notmuch.1 b/notmuch.1 index 3ec9c55c..1919176e 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -150,6 +150,46 @@ include Presents the results in either JSON or plain-text (default). .RE + +.RS 4 +.TP 4 +.B \-\-output=(summary|threads|messages|tags) + +.RS 4 +.TP 4 +.B summary + +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. +.RE +.RS 4 +.TP 4 +.B threads + +Output the thread IDs of all threads with any message matching the +search terms, either one per line (--format=text) or as a JSON array +(--format=json). +.RE +.RS 4 +.TP 4 +.B messages + +Output the message IDs of all messages matching the search terms, +either one per line (--format=text) or as a JSON array +(--format=json). +.RE +.RS 4 +.TP 4 +.B tags + +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). +.RE +.RE + .RS 4 .TP 4 .BR \-\-sort= ( newest\-first | oldest\-first ) @@ -214,7 +254,6 @@ will be delimited by easily-parsed markers. Each marker consists of a Control-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. - .RE .RS 4 .TP 4 @@ -240,7 +279,6 @@ beginning with "From " (preceded by zero or more '>' characters) have an additional '>' character added. This reversible escaping is termed "mboxrd" format and described in detail here: http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html - .RE A common use of .B notmuch show @@ -404,6 +442,44 @@ See the section below for details of the supported syntax for . .RE +The +.B config +command can be used to get or set settings int the notmuch +configuration file. + +.RS 4 +.TP 4 +.BR "config get "
. + +The value of the specified configuration item is printed to stdout. If +the item has multiple values, each value is separated by a newline +character. + +Available configuration items include at least + + database.path + + user.name + + user.primary_email + + user.other_email + + new.tags +.RE + +.RS 4 +.TP 4 +.BR "config set "
. " [values ...]" + +The specified configuration item is set to the given value. To +specify a multiple-value item, provide each value as a separate +command-line argument. + +If no values are provided, the specified configuration item will be +removed from the configuration file. +.RE + .SH SEARCH SYNTAX Several notmuch commands accept a common syntax for search terms.