git.notmuchmail.org Git - notmuch/blob - docs/source/notmuch.rst

   1 The notmuch 'binary'
   2 ====================
   3
   4 The cnotmuch module provides *notmuch*, a python reimplementation of the standard notmuch binary for two purposes: first, to allow running the standard notmuch testsuite over the cnotmuch bindings (for correctness and performance testing) and second, to give some examples as to how to use cnotmuch. 'Notmuch' provides a command line interface to your mail database.
   5
   6 A standard install via `easy_install cnotmuch` will not install the notmuch binary, however it is available in the `cnotmuch source code repository <http://bitbucket.org/spaetz/cnotmuch/src/>`_.
   7
   8
   9 It is invoked with the following pattern: `notmuch <command> [args...]`.
  10
  11 Where <command> and [args...] are as follows:
  12
  13   **setup**     Interactively setup notmuch for first use.
  14                 This has not yet been implemented, and will probably not be
  15                 implemented unless someone puts in the effort.
  16
  17   **new**       [--verbose]
  18                 Find and import new messages to the notmuch database.
  19
  20                 This has not been implemented yet. We cheat by calling
  21                 the regular "notmuch" binary (which must be in your path
  22                 somewhere).
  23
  24   **search** [options...] <search-terms> [...]  Search for messages matching the given search terms.
  25
  26                 This has been implemented but for the `--format` and
  27                 `--sort` options.
  28
  29   **show**      <search-terms> [...]
  30                 Show all messages matching the search terms.
  31
  32                 This has been partially implemented, we show a stub for each
  33                 found message, but do not output the full message body yet.
  34
  35   **count**     <search-terms> [...]
  36                 Count messages matching the search terms.
  37
  38                 This has been fully implemented.
  39
  40   **reply**     [options...] <search-terms> [...]
  41                 Construct a reply template for a set of messages.
  42
  43                 This has not been implemented yet.
  44
  45   **tag**       +<tag>|-<tag> [...] [--] <search-terms> [...]
  46                 Add/remove tags for all messages matching the search terms.
  47
  48                 This has been fully implemented.
  49
  50   **dump**      [<filename>]
  51                 Create a plain-text dump of the tags for each message.
  52
  53                 This has been fully implemented.
  54   **restore**   <filename>
  55                 Restore the tags from the given dump file (see 'dump').
  56
  57                 This has been fully implemented.
  58
  59   **search-tags**       [<search-terms> [...] ]
  60                 List all tags found in the database or matching messages.
  61
  62                 This has been fully implemented.
  63
  64   **help**      [<command>]
  65                 This message, or more detailed help for the named command.
  66
  67                 The 'help' page has been implemented, help for single
  68                 commands are missing though. Patches are welcome.