git.notmuchmail.org Git - notmuch/blob - devel/nmbug/doc/man1/notmuch-report.1.rst

   1 ==============
   2 notmuch-report
   3 ==============
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch-report** [options ...]
   9
  10 DESCRIPTION
  11 ===========
  12
  13 Generate HTML or plain-text reports showing query results.
  14
  15 OPTIONS
  16 =======
  17
  18   ``-h``, ``--help``
  19
  20     Show a help message, including a list of available options, and
  21     exit.
  22
  23   ``--text``
  24     Output plain text instead of HTML.
  25
  26   ``--config`` <PATH>
  27     Load config from given file.  The format is described in
  28     **notmuch-report.json(5)**.  If this option is not set,
  29     **notmuch-report** loads the config from the Git repository at
  30     ``NMBGIT``.  See :ref:`NMBGIT <NMBGIT>` for details.
  31
  32   ``--list-views``
  33     List available views (by title) and exit.
  34
  35   ``--get-query`` <VIEW>
  36     Print the configured query for view matching the given title.
  37
  38 ENVIRONMENT
  39 ===========
  40
  41 .. _NMBGIT:
  42
  43   ``NMBGIT``
  44     If ``--config PATH`` is not set, **notmuch-report** will attempt
  45     to load a config file named ``notmuch-report.json`` from the
  46     ``config`` branch of the ``NMBGIT`` repository (defaulting to
  47     ``~/.nmbug``).
  48
  49 SEE ALSO
  50 ========
  51
  52 **notmuch(1)**, **notmuch-report.json(5)**, **notmuch-search(1)**,
  53  **notmuch-tag(1)**
  54