.. _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)`