Andrew's git / gitweb.git /
173ee232f2cd24231ab95e3337da555be27a4746
   1git-remote-helpers(1)
   2=====================
   3
   4NAME
   5----
   6git-remote-helpers - Helper programs for interoperation with remote git
   7
   8SYNOPSIS
   9--------
  10'git remote-<transport>' <remote>
  11
  12DESCRIPTION
  13-----------
  14
  15These programs are normally not used directly by end users, but are
  16invoked by various git programs that interact with remote repositories
  17when the repository they would operate on will be accessed using
  18transport code not linked into the main git binary. Various particular
  19helper programs will behave as documented here.
  20
  21COMMANDS
  22--------
  23
  24Commands are given by the caller on the helper's standard input, one per line.
  25
  26'capabilities'::
  27        Lists the capabilities of the helper, one per line, ending
  28        with a blank line.
  29
  30'list'::
  31        Lists the refs, one per line, in the format "<value> <name>
  32        [<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
  33        a symref, or "?" to indicate that the helper could not get the
  34        value of the ref. A space-separated list of attributes follows
  35        the name; unrecognized attributes are ignored. After the
  36        complete list, outputs a blank line.
  37
  38'fetch' <sha1> <name>::
  39        Fetches the given object, writing the necessary objects to the
  40        database. Outputs a blank line when the fetch is
  41        complete. Only objects which were reported in the ref list
  42        with a sha1 may be fetched this way.
  43+
  44Supported if the helper has the "fetch" capability.
  45
  46If a fatal error occurs, the program writes the error message to
  47stderr and exits. The caller should expect that a suitable error
  48message has been printed if the child closes the connection without
  49completing a valid response for the current command.
  50
  51Additional commands may be supported, as may be determined from
  52capabilities reported by the helper.
  53
  54CAPABILITIES
  55------------
  56
  57'fetch'::
  58        This helper supports the 'fetch' command.
  59
  60REF LIST ATTRIBUTES
  61-------------------
  62
  63None are defined yet, but the caller must accept any which are supplied.
  64
  65Documentation
  66-------------
  67Documentation by Daniel Barkalow.
  68
  69GIT
  70---
  71Part of the linkgit:git[1] suite