X-Git-Url: https://git.cworth.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-git.rst;h=6a2d7fcd9b03b314edf4f950c2e2a68945a5c51d;hp=86f246b67d2a4e0b92b488322f2563624f20c97d;hb=8ed68c1bbe8c1b7bb69d7bea1e0c8919bfcb0d0a;hpb=e50a413906b9fadf93b7801c4758b48792bb348f diff --git a/doc/man1/notmuch-git.rst b/doc/man1/notmuch-git.rst index 86f246b6..6a2d7fcd 100644 --- a/doc/man1/notmuch-git.rst +++ b/doc/man1/notmuch-git.rst @@ -7,7 +7,9 @@ notmuch-git SYNOPSIS ======== -**notmuch** **git** [-h] [-C *repo*] [-p *prefix*] [-v] [-l *log level*] *subcommand* +**notmuch** **git** [-h] [-N] [-C *repo*] [-p *prefix*] [-v] [-l *log level*] *subcommand* + +**nmbug** [-h] [-C *repo*] [-p *prefix*] [-v] [-l *log level*] *subcommand* DESCRIPTION =========== @@ -25,12 +27,17 @@ Supported options for `notmuch git` include show help message and exit +.. option:: -N, --nmbug + + Set defaults for :option:`--tag-prefix` and :option:`--git-dir` suitable for the + :any:`notmuch` bug tracker + .. option:: -C , --git-dir Operate on git repository *repo*. See :ref:`repo_location` for defaults. -.. option:: -p , --tag-prefix +.. option:: -p , --tag-prefix Operate only on tags with prefix *prefix*. See :ref:`prefix_val` for defaults. @@ -239,6 +246,10 @@ value to locate the git repository. - Environment variable :envvar:`NOTMUCH_GIT_DIR`. +- If invoked as `nmbug` or with the :option:`--nmbug` option, + :code:`$HOME/.nmbug`; otherwise + :code:`$XDG_DATA_HOME/notmuch/$NOTMUCH_PROFILE/git`. + .. _prefix_val: PREFIX VALUE @@ -251,9 +262,15 @@ value to define the tag prefix. - Environment variable :envvar:`NOTMUCH_GIT_PREFIX`. +- If invoked as `nmbug` or with the :option:`--nmbug` option, + :code:`notmuch::`, otherwise the empty string. + ENVIRONMENT =========== +Variable :envvar:`NOTMUCH_PROFILE` influences :ref:`repo_location`. +If it is unset, 'default' is assumed. + .. envvar:: NOTMUCH_GIT_DIR Default location of git repository. Overriden by :option:`--git-dir`.