]> git.cworth.org Git - notmuch-wiki/blobdiff - manpages/notmuch-show-1.mdwn
manpages updates for release 0.27
[notmuch-wiki] / manpages / notmuch-show-1.mdwn
index 4902b5acffdd090b0c3609e4fec8c0f43980d4dc..39f18455ed3b7317d28420f2b82ada0d36047f65 100644 (file)
               supported with --format=json and --format=sexp), and the  multi‐
               part/signed part will be replaced by the signed data.
 
-       <b>--decrypt=(false|auto|true)</b>
+       <b>--decrypt=(false|auto|true|stash)</b>
               If  <b>true</b>, decrypt any MIME encrypted parts found in the selected
               content  (i.e.  &quot;multipart/encrypted&quot;  parts).  Status  of   the
               decryption  will  be  reported  (currently  only  supported with
               the  multipart/encrypted  part will be replaced by the decrypted
               content.
 
-              If <b>auto</b>, and a session key is already  known  for  the  message,
-              then  it  will  be decrypted, but notmuch will not try to access
+              <b>stash</b> behaves like <b>true</b>, but upon successful decryption it  will
+              also  stash the message&apos;s session key in the database, and index
+              the cleartext of the message, enabling automatic  decryption  in
+              the future.
+
+              If  <b>auto</b>,  and  a  session key is already known for the message,
+              then it will be decrypted, but notmuch will not  try  to  access
               the user&apos;s keys.
 
               Use <b>false</b> to avoid even automatic decryption.
 
-              Non-automatic decryption expects a functioning  <b>gpg-agent</b>(1)  to
-              provide any needed credentials. Without one, the decryption will
+              Non-automatic  decryption  (<b>stash</b>  or  <b>true</b>, in the absence of a
+              stashed session key) expects a functioning <b>gpg-agent</b>(1) to  pro‐
+              vide  any  needed  credentials. Without one, the decryption will
               fail.
 
-              Note: <b>true</b> implies --verify.
+              Note: setting either <b>true</b> or <b>stash</b> here implies <b>--verify</b>.
+
+              Here is a table that summarizes each of these policies:
+
+                       ┌──────────────┬───────┬──────┬──────┬───────┐
+                       │              │ false │ auto │ true │ stash │
+                       ├──────────────┼───────┼──────┼──────┼───────┤
+                       │Show  cleart‐ │       │ X    │ X    │ X     │
+                       │ext  if  ses‐ │       │      │      │       │
+                       │sion  key  is │       │      │      │       │
+                       │already known │       │      │      │       │
+                       ├──────────────┼───────┼──────┼──────┼───────┤
+                       │Use    secret │       │      │ X    │ X     │
+                       │keys to  show │       │      │      │       │
+                       │cleartext     │       │      │      │       │
+                       ├──────────────┼───────┼──────┼──────┼───────┤
+                       │Stash     any │       │      │      │ X     │
+                       │newly  recov‐ │       │      │      │       │
+                       │ered  session │       │      │      │       │
+                       │keys,   rein‐ │       │      │      │       │
+                       │dexing   mes‐ │       │      │      │       │
+                       │sage if found │       │      │      │       │
+                       └──────────────┴───────┴──────┴──────┴───────┘
+
+              Note: <b>--decrypt=stash</b> requires write  access  to  the  database.
+              Otherwise, <b>notmuch</b> <b>show</b> operates entirely in read-only mode.
 
               Default: <b>auto</b>
 
        <b>--exclude=(true|false)</b>
               Specify whether to omit threads only matching search.tag_exclude
               from the search results (the default) or not. In either case the
-              excluded message will be marked with the  exclude  flag  (except
+              excluded  message  will  be marked with the exclude flag (except
               when output=mbox when there is nowhere to put the flag).
 
               If  --entire-thread  is  specified  then  complete  threads  are
-              returned regardless (with  the  excluded  flag  being  set  when
-              appropriate)  but threads that only match in an excluded message
+              returned  regardless  (with  the  excluded  flag  being set when
+              appropriate) but threads that only match in an excluded  message
               are not returned when <b>--exclude=true.</b>
 
               The default is <b>--exclude=true.</b>
 
        <b>--body=(true|false)</b>
-              If true (the default) <b>notmuch</b> <b>show</b> includes the  bodies  of  the
-              messages   in   the   output;  if  false,  bodies  are  omitted.
-              <b>--body=false</b> is only implemented for the json and  sexp  formats
+              If  true  (the  default) <b>notmuch</b> <b>show</b> includes the bodies of the
+              messages  in  the  output;  if  false,   bodies   are   omitted.
+              <b>--body=false</b>  is  only implemented for the json and sexp formats
               and it is incompatible with <b>--part</b> <b>&gt;</b> <b>0.</b>
 
               This is useful if the caller only needs the headers as body-less
               output is much faster and substantially smaller.
 
        <b>--include-html</b>
-              Include &quot;text/html&quot; parts as part of the output (currently  only
-              supported  with  --format=json  and  --format=sexp). By default,
-              unless  <b>--part=N</b>  is  used  to  select  a   specific   part   or
+              Include  &quot;text/html&quot; parts as part of the output (currently only
+              supported with --format=json  and  --format=sexp).  By  default,
+              unless   <b>--part=N</b>   is   used  to  select  a  specific  part  or
               <b>--include-html</b> is used to include all &quot;text/html&quot; parts, no part
               with content type &quot;text/html&quot; is included in the output.
 
-       A common use of <b>notmuch</b> <b>show</b> is to display a  single  thread  of  email
+       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 &quot;thread:&lt;thread-id&gt;&quot; 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>
-       <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>not‐</a>
-       <a href='../notmuch-hooks-5/'>much-hooks</a>(5),   <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+       <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not‐</a>
+       <a href='../notmuch-hooks-5/'>much-hooks</a>(5),  <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),   <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
        <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),  <a href='../notmuch-search-1/'>notmuch-search</a>(1),  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-tag-1/'>not‐</a>
        <a href='../notmuch-tag-1/'>much-tag</a>(1)
 </pre>
        2009-2018, Carl Worth and many others
 </pre>
 
-<h2>0.26</h2>
+<h2>0.27</h2>