git.cworth.org Git - 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> [options ...] +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; [--] &lt;<u>search-term</u>&gt; ...
  12
  13        <b>notmuch</b> <b>tag</b> <b>--batch</b> [--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/'>not‐</a>
  34        <a href='../notmuch-config-1/'>much-config</a>(1) for details.
  35
  36        Supported options for <b>tag</b> include
  37
  38           <b>--remove-all</b>
  39                  Remove all tags from each message matching the  search  terms
  40                  before  applying  the  tag  changes  appearing on the command
  41                  line.  This means setting the tags of  each  message  to  the
  42                  tags  to be added. If there are no tags to be added, the mes‐
  43                  sages will have no tags.
  44
  45           <b>--batch</b>
  46                  Read batch tagging operations from a file (stdin by default).
  47                  This is more efficient than repeated <b>notmuch</b> <b>tag</b> invocations.
  48                  See <u>TAG</u> <u>FILE</u> <u>FORMAT</u> below for the input format.  This  option
  49                  is  not  compatible  with  specifying  tagging on the command
  50                  line.
  51
  52           <b>--input=&lt;filename&gt;</b>
  53                  Read input from given file, instead of  from  stdin.  Implies
  54                  <b>--batch</b>.
  55 </pre>
  56
  57 <h2>TAG FILE FORMAT</h2>
  58 <pre>
  59        The input must consist of lines of the format:
  60
  61        +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; [...] [--] &lt;<u>query</u>&gt;
  62
  63        Each  line  is  interpreted similarly to <b>notmuch</b> <b>tag</b> command line argu‐
  64        ments. The delimiter is one or more spaces &apos; &apos;. Any characters in &lt;<u>tag</u>&gt;
  65        <b>may</b>  be  hex-encoded  with %NN where NN is the hexadecimal value of the
  66        character. To hex-encode a character with a multi-byte UTF-8  encoding,
  67        hex-encode  each  byte. Any spaces in &lt;tag&gt; <b>must</b> be hex-encoded as %20.
  68        Any characters that are not part of &lt;<u>tag</u>&gt; <b>must</b> <b>not</b> be hex-encoded.
  69
  70        In the future tag:&quot;tag with spaces&quot; style quoting may be supported  for
  71        &lt;<u>tag</u>&gt;  as  well;  for  this reason all double quote characters in &lt;<u>tag</u>&gt;
  72        <b>should</b> be hex-encoded.
  73
  74        The &lt;<u>query</u>&gt; should be quoted using Xapian boolean term  quoting  rules:
  75        if  a term contains whitespace or a close paren or starts with a double
  76        quote, it must be enclosed in double quotes (not including any  prefix)
  77        and  double quotes inside the term must be doubled (see below for exam‐
  78        ples).
  79
  80        Leading and trailing space &apos; &apos; is ignored. Empty lines and lines begin‐
  81        ning with &apos;#&apos; are ignored.
  82 </pre>
  83
  84 <h3> &nbsp; EXAMPLE</h3>
  85 <pre>
  86        The  following shows a valid input to batch tagging. Note that only the
  87        isolated &apos;*&apos; acts as a wildcard. Also note the two  different  quotings
  88        of the tag <b>space</b> <b>in</b> <b>tags</b>
  89
  90           +winner *
  91           +foo::bar%25 -- (One and Two) or (One and tag:winner)
  92           +found::it -- tag:foo::bar%
  93           # ignore this line and the next
  94
  95           +space%20in%20tags -- Two
  96           # add tag &apos;(tags)&apos;, among other stunts.
  97           +crazy{ +(tags) +&amp;are +#possible\ -- tag:&quot;space in tags&quot;
  98           +match*crazy -- tag:crazy{
  99           +some_tag -- id:&quot;this is &quot;&quot;nauty)&quot;&quot;&quot;
 100 </pre>
 101
 102 <h2>SEE ALSO</h2>
 103 <pre>
 104        <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>
 105        <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),
 106        <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-show-1/'>not‐</a>
 107        <a href='../notmuch-show-1/'>much-show</a>(1),
 108 </pre>
 109
 110 <h2>AUTHOR</h2>
 111 <pre>
 112        Carl Worth and many others
 113 </pre>
 114
 115 <h2>COPYRIGHT</h2>
 116 <pre>
 117        2014, Carl Worth and many others
 118 </pre>
 119
 120 <h2>0.20.1</h2>