--- doc/conf.py | 4 ++ doc/index.rst | 1 + doc/man1/notmuch-git.rst | 106 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 111 insertions(+) create mode 100644 doc/man1/notmuch-git.rst
diff --git a/doc/conf.py b/doc/conf.py index e46e1d4e..da0635bb 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -123,6 +123,10 @@ man_pages = [ u'send mail with notmuch and emacs', [notmuch_authors], 1), + ('man1/notmuch-git', 'notmuch-git', + u'manage notmuch tags with git', + [notmuch_authors], 1), + ('man5/notmuch-hooks', 'notmuch-hooks', u'hooks for notmuch', [notmuch_authors], 5), diff --git a/doc/index.rst b/doc/index.rst index fbdcf779..c380ee1d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -15,6 +15,7 @@ Contents: man1/notmuch-dump notmuch-emacs man1/notmuch-emacs-mua + man1/notmuch-git man5/notmuch-hooks man1/notmuch-insert man1/notmuch-new diff --git a/doc/man1/notmuch-git.rst b/doc/man1/notmuch-git.rst new file mode 100644 index 00000000..4877f22d --- /dev/null +++ b/doc/man1/notmuch-git.rst @@ -0,0 +1,106 @@ +.. _notmuch-git(1): + +============ +notmuch-git +============ + +SYNOPSIS +======== + +**notmuch** **git** [-h] [-C REPO] [-p PREFIX] [-v] [-l *log level*] *subcommand* + +DESCRIPTION +=========== + +Manage notmuch tags with Git. + +Options +------- + +Supported options for **notmuch-git** include + +.. program:: notmuch-git + +.. option:: -h, --help + + show help message and exit + +.. option:: -C repo, --git-dir repo + + Operate on git repository *repo* + +.. option:: -p prefix, --tag-prefix prefix + + Operate only on tags with prefix *prefix* + +.. option:: -v, --version + + show notmuch-git's version number and exit + +.. option:: -l *level*, --log-level *level* {critical,error,warning,info,debug} + + Log verbosity. Defaults to 'warning'. + +Subcommands +----------- + +For help on a particular subcommand, run: 'notmuch-git ... <command> --help'. + +.. option:: archive [TREE-ISH] [ARG ...] + +Dump a tar archive of the current nmbug tag set using 'git archive'. + +For each tag *tag* for message with Message-Id *id* an empty file + + tags/encode(*id*)/encode(*tag*) + +is written to the output. + +The encoding preserves alphanumerics, and the characters +"+-_@=.:," (not the quotes). All other octets are replaced with +'%%' followed by a two digit hex number. + +positional arguments: + TREE-ISH The tree or commit to produce an archive for. Defaults to + 'HEAD'. + ARG Argument passed through to 'git archive'. Set anything before + <tree-ish>, see any:`git-archive(1)` for details. + +.. option:: checkout + +Update the notmuch database from Git. + +This is mainly useful to discard your changes in notmuch relative +to Git. +Create a local nmbug repository from a remote source. + +.. option:: clone repository + +This wraps 'git clone', adding some options to avoid creating a +working tree while preserving remote-tracking branches and +upstreams. + +positional arguments: + repository The (possibly remote) repository to clone from. See the URLS section of git-clone(1) for more information on specifying repositories. + + clone Create a local nmbug repository from a remote source. + commit Commit prefix-matching tags from the notmuch database to Git. + fetch Fetch changes from the remote repository. + help Show help for an nmbug command. + init Create an empty nmbug repository. + log A simple wrapper for 'git log'. + merge Merge changes from 'reference' into HEAD and load the result into notmuch. + pull Pull (merge) remote repository changes to notmuch. + push Push the local nmbug Git state to a remote repository. + status Show pending updates in notmuch or git repo. + + + + +SEE ALSO +======== + +:any:`notmuch(1)`, +:any:`notmuch-dump(1)`, +:any:`notmuch-restore(1)`, +:any:`notmuch-tag(1)` -- 2.35.2 _______________________________________________ notmuch mailing list -- notmuch@notmuchmail.org To unsubscribe send an email to notmuch-le...@notmuchmail.org