git.cworth.org Git - obsolete/notmuch-wiki/blob - manpages/notmuch-tag-1.mdwn

   1 <h1>NOTMUCH-TAG(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch-tag  -  add/remove  tags  for  all messages matching the search
   6        terms
   7 </pre>
   8
   9 <h2>SYNOPSIS</h2>
  10 <pre>
  11        <b>notmuch</b> <b>tag</b> +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; [...] [--] &lt;<u>search-term</u>&gt; [...]
  12
  13        <b>notmuch</b> <b>tag</b> --batch [ --input=&lt;<u>filename</u>&gt; ]
  14 </pre>
  15
  16 <h2>DESCRIPTION</h2>
  17 <pre>
  18        Add/remove tags for all messages matching the search terms.
  19
  20        See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of  the  supported  syntax  for
  21        &lt;<u>search-term</u>&gt;.
  22
  23        Tags prefixed by &apos;+&apos; are added while those prefixed by &apos;-&apos; are removed.
  24        For each message, tag changes are applied in the order they  appear  on
  25        the command line.
  26
  27        The  beginning  of the search terms is recognized by the first argument
  28        that begins with neither &apos;+&apos; nor &apos;-&apos;. Support  for  an  initial  search
  29        term  beginning  with  &apos;+&apos;  or  &apos;-&apos; is provided by allowing the user to
  30        specify a &quot;--&quot; argument to separate the tags from the search terms.
  31
  32        <b>notmuch</b> <b>tag</b> updates the maildir flags according to tag changes  if  the
  33        <b>maildir.synchronize</b>_<b>flags</b> configuration option is enabled. See <a href='../notmuch-config-1/'>notmuch-</a>
  34        <a href='../notmuch-config-1/'>config</a>(1) for details.
  35
  36        Supported options for <b>tag</b> include
  37
  38            <b>--batch</b>
  39
  40                Read batch tagging operations from a file (stdin  by  default).
  41                This  is  more efficient than repeated <b>notmuch</b> <b>tag</b> invocations.
  42                See <b>TAG</b> <b>FILE</b> <b>FORMAT</b> below for the input format. This option  is
  43                not compatible with specifying tagging on the command line.
  44
  45            <b>--input=</b>&lt;filename&gt;
  46
  47                Read  input  from  given  file,  instead of from stdin. Implies
  48                <b>--batch</b>.
  49 </pre>
  50
  51 <h2>TAG FILE FORMAT</h2>
  52 <pre>
  53        The input must consist of lines of the format:
  54
  55        +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; [...] [--] &lt;<u>query</u>&gt;
  56
  57        Each line is interpreted similarly to <b>notmuch</b> <b>tag</b>  command  line  argu-
  58        ments. The delimiter is one or more spaces &apos; &apos;. Any characters in &lt;<u>tag</u>&gt;
  59        <b>may</b> be hex-encoded with %NN where NN is the hexadecimal  value  of  the
  60        character.  To hex-encode a character with a multi-byte UTF-8 encoding,
  61        hex-encode each byte.  Any spaces in &lt;tag&gt; <b>must</b> be hex-encoded as  %20.
  62        Any characters that are not part of &lt;<u>tag</u>&gt; <b>must</b> <b>not</b> be hex-encoded.
  63
  64        In  the future tag:&quot;tag with spaces&quot; style quoting may be supported for
  65        &lt;<u>tag</u>&gt; as well; for this reason all double  quote  characters  in  &lt;<u>tag</u>&gt;
  66        <b>should</b> be hex-encoded.
  67
  68        The  &lt;<u>query</u>&gt;  should be quoted using Xapian boolean term quoting rules:
  69        if a term contains whitespace or a close paren or starts with a  double
  70        quote,  it must be enclosed in double quotes (not including any prefix)
  71        and double quotes inside the term must be doubled (see below for  exam-
  72        ples).
  73
  74        Leading and trailing space &apos; &apos; is ignored. Empty lines and lines begin-
  75        ning with &apos;#&apos; are ignored.
  76 </pre>
  77
  78 <h3> &nbsp; EXAMPLE</h3>
  79 <pre>
  80        The following shows a valid input to batch tagging. Note that only  the
  81        isolated  &apos;*&apos;  acts as a wildcard. Also note the two different quotings
  82        of the tag <b>space</b> <b>in</b> <b>tags</b>
  83               +winner *
  84               +foo::bar%25 -- (One and Two) or (One and tag:winner)
  85               +found::it -- tag:foo::bar%
  86               # ignore this line and the next
  87
  88               +space%20in%20tags -- Two
  89               # add tag &apos;(tags)&apos;, among other stunts.
  90               +crazy{ +(tags) +&amp;are +#possible -- tag:&quot;space in tags&quot;
  91               +match*crazy -- tag:crazy{
  92               +some_tag -- id:&quot;this is &quot;&quot;nauty)&quot;&quot;&quot;
  93 </pre>
  94
  95 <h2>SEE ALSO</h2>
  96 <pre>
  97        <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>
  98        <a href='../notmuch-hooks-5/'>much-hooks</a>(5),  <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),
  99        <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1),
 100 </pre>
 101
 102 <h2>Notmuch 0.15.2</h2>