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'option' <name> <value>:: 39 Set the transport helper option <name> to <value>. Outputs a 40 single line containing one of 'ok' (option successfully set), 41 'unsupported' (option not recognized) or 'error <msg>' 42 (option <name> is supported but <value> is not correct 43 for it). Options should be set before other commands, 44 and may how those commands behave. 45+ 46Supported if the helper has the "option" capability. 47 48'fetch' <sha1> <name>:: 49 Fetches the given object, writing the necessary objects 50 to the database. Fetch commands are sent in a batch, one 51 per line, and the batch is terminated with a blank line. 52 Outputs a single blank line when all fetch commands in the 53 same batch are complete. Only objects which were reported 54 in the ref list with a sha1 may be fetched this way. 55+ 56Optionally may output a 'lock <file>' line indicating a file under 57GIT_DIR/objects/pack which is keeping a pack until refs can be 58suitably updated. 59+ 60Supported if the helper has the "fetch" capability. 61 62If a fatal error occurs, the program writes the error message to 63stderr and exits. The caller should expect that a suitable error 64message has been printed if the child closes the connection without 65completing a valid response for the current command. 66 67Additional commands may be supported, as may be determined from 68capabilities reported by the helper. 69 70CAPABILITIES 71------------ 72 73'fetch':: 74 This helper supports the 'fetch' command. 75 76'option':: 77 This helper supports the option command. 78 79REF LIST ATTRIBUTES 80------------------- 81 82None are defined yet, but the caller must accept any which are supplied. 83 84OPTIONS 85------- 86'option verbosity' <N>:: 87 Change the level of messages displayed by the helper. 88 When N is 0 the end-user has asked the process to be 89 quiet, and the helper should produce only error output. 90 N of 1 is the default level of verbosity, higher values 91 of N correspond to the number of -v flags passed on the 92 command line. 93 94'option progress' \{'true'|'false'\}:: 95 Enable (or disable) progress messages displayed by the 96 transport helper during a command. 97 98'option depth' <depth>:: 99 Deepen the history of a shallow repository. 100 101'option followtags' \{'true'|'false'\}:: 102 If enabled the helper should automatically fetch annotated 103 tag objects if the object the tag points at was transferred 104 during the fetch command. If the tag is not fetched by 105 the helper a second fetch command will usually be sent to 106 ask for the tag specifically. Some helpers may be able to 107 use this option to avoid a second network connection. 108 109Documentation 110------------- 111Documentation by Daniel Barkalow. 112 113GIT 114--- 115Part of the linkgit:git[1] suite