X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=2df320d8657c2cedb22c0fb6502c5a95451a696c;hp=282ad9896bc6a64004f0c4b16fed2e15ba00b48a;hb=c963098e2890922ffcf0991466ba66f724e2dfa4;hpb=3a9c3ec9e719f0e5adefe0ceafffeb34c7a3917e diff --git a/notmuch.1 b/notmuch.1 index 282ad989..2df320d8 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -146,6 +146,12 @@ Supported options for include .RS 4 .TP 4 +.BR \-\-format= ( json | text ) + +Presents the results in either JSON or plain-text (default). +.RE +.RS 4 +.TP 4 .BR \-\-sort= ( newest\-first | oldest\-first ) This option can be used to present results in either chronological order @@ -194,7 +200,14 @@ matched message will be displayed. .RE .RS 4 -The output format is plain-text, with all text-content MIME parts +.TP 4 +.B \-\-format=(json|text) + +.RS 4 +.TP 4 +.B text + +The default plain-text format has text-content MIME parts decoded. Various components in the output, .RB ( message ", " header ", " body ", " attachment ", and MIME " part ), will be delimited by easily-parsed markers. Each marker consists of a @@ -202,6 +215,18 @@ 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 +.B json + +Format output as Javascript Object Notation (JSON). JSON output always +includes all messages in a matching thread; in effect +.B \-\-format=json +implies +.B \-\-entire\-thread + +.RE A common use of .B notmuch show is to display a single thread of email messages. For this, use a @@ -424,6 +449,13 @@ specify a date range to return messages from 2009-10-01 until the current time: $(date +%s -d 2009-10-01)..$(date +%s) +.SH ENVIRONMENT +The following environment variables can be used to control the +behavior of notmuch. +.TP +.B NOTMUCH_CONFIG +Specifies the location of the notmuch configuration file. Notmuch will +use ${HOME}/.notmuch-config if this variable is not set. .SH SEE ALSO The emacs-based interface to notmuch (available as .B notmuch.el