From: Junio C Hamano Date: Sat, 20 Jan 2007 02:23:07 +0000 (+0000) Subject: Autogenerated man pages for v1.5.0-rc1-g6f71 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=ef7c91a433ada017454656b1cfbdcf83d7868fa6;p=git.git Autogenerated man pages for v1.5.0-rc1-g6f71 --- diff --git a/man1/git-fetch-pack.1 b/man1/git-fetch-pack.1 index f84e8c52e..5d6e370f1 100644 --- a/man1/git-fetch-pack.1 +++ b/man1/git-fetch-pack.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-FETCH\-PACK" "1" "01/17/2007" "" "" +.TH "GIT\-FETCH\-PACK" "1" "01/20/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -10,7 +10,7 @@ .SH "NAME" git\-fetch\-pack \- Receive missing objects from another repository .SH "SYNOPSIS" -\fIgit\-fetch\-pack\fR [\-q] [\-k] [\-\-exec=] [:] [\&...] +\fIgit\-fetch\-pack\fR [\-\-all] [\-\-quiet|\-q] [\-\-keep|\-k] [\-\-thin] [\-\-exec=] [\-\-depth=] [\-v] [:] [\&...] .SH "DESCRIPTION" Usually you would want to use \fBgit\-fetch\fR(1) which is a higher level wrapper of this command instead. @@ -19,15 +19,27 @@ Invokes \fIgit\-upload\-pack\fR on a potentially remote repository, and asks it This command degenerates to download everything to complete the asked refs from the remote side when the local side does not have a common ancestor commit. .SH "OPTIONS" .TP -\-q +\-\-all +Fetch all remote refs. +.TP +\-\-quiet, \\\-q Pass \fI\-q\fR flag to \fIgit\-unpack\-objects\fR; this makes the cloning process less verbose. .TP -\-k +\-\-keep, \\\-k Do not invoke \fIgit\-unpack\-objects\fR on received data, but create a single packfile out of it instead, and store it in the object database. If provided twice then the pack is locked against repacking. .TP +\-\-thin +Spend extra cycles to minimize the number of objects to be sent. Use it on slower connection. +.TP \-\-exec= Use this to specify the path to \fIgit\-upload\-pack\fR on the remote side, if is not found on your $PATH. Installations of sshd ignores the user's environment setup scripts for login shells (e.g. .bash_profile) and your privately installed git may not be found on the system default $PATH. Another workaround suggested is to set up your $PATH in ".bashrc", but this flag is for people who do not want to pay the overhead for non\-interactive shells by having a lean .bashrc file (they set most of the things up in .bash_profile). .TP +\-\-depth= +Limit fetching to ancestor\-chains not longer than n. +.TP +\\\-v +Run verbosely. +.TP A remote host that houses the repository. When this part is specified, \fIgit\-upload\-pack\fR is invoked via ssh. .TP diff --git a/man1/git-push.1 b/man1/git-push.1 index a9a5e70c3..d6c11ffce 100644 --- a/man1/git-push.1 +++ b/man1/git-push.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-PUSH" "1" "01/16/2007" "" "" +.TH "GIT\-PUSH" "1" "01/20/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -10,7 +10,7 @@ .SH "NAME" git\-push \- Update remote refs along with associated objects .SH "SYNOPSIS" -\fIgit\-push\fR [\-\-all] [\-\-tags] [\-\-exec=] [\-\-repo=all] [\-f | \-\-force] [\-v] [ \&...] +\fIgit\-push\fR [\-\-all] [\-\-tags] [\-\-receive\-pack=] [\-\-repo=all] [\-f | \-\-force] [\-v] [ \&...] .SH "DESCRIPTION" Updates remote refs using local refs, while sending objects necessary to complete the given refs. @@ -41,9 +41,12 @@ Instead of naming each ref to push, specifies that all refs be pushed. \-\-tags All refs under $GIT_DIR/refs/tags are pushed, in addition to refspecs explicitly listed on the command line. .TP -\-\-exec +\-\-receive\-pack= Path to the \fIgit\-receive\-pack\fR program on the remote end. Sometimes useful when pushing to a remote repository over ssh, and you do not have the program in a directory on the default $PATH. .TP +\-\-exec= +Same as \-\-receive\-pack=. +.TP \-f, \-\-force Usually, the command refuses to update a remote ref that is not a descendant of the local ref used to overwrite it. This flag disables the check. This can cause the remote repository to lose commits; use it with care. .TP diff --git a/man1/git-repo-config.1 b/man1/git-repo-config.1 index 88d9bfd01..3fcc7d5d5 100644 --- a/man1/git-repo-config.1 +++ b/man1/git-repo-config.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-REPO\-CONFIG" "1" "01/19/2007" "" "" +.TH "GIT\-REPO\-CONFIG" "1" "01/20/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -380,6 +380,9 @@ The default set of "refspec" for \fBgit\-fetch\fR(1). See \fBgit\-fetch\fR(1). remote..push The default set of "refspec" for \fBgit\-push\fR(1). See \fBgit\-push\fR(1). .TP +remote..receivepack +The default program to execute on the remote side when pulling. See option \-\-exec of \fBgit\-push\fR(1). +.TP repack.usedeltabaseoffset Allow \fBgit\-repack\fR(1) to create packs that uses delta\-base offset. Defaults to false. .TP diff --git a/man1/git-send-pack.1 b/man1/git-send-pack.1 index c12899219..308cd2e26 100644 --- a/man1/git-send-pack.1 +++ b/man1/git-send-pack.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-SEND\-PACK" "1" "01/19/2007" "" "" +.TH "GIT\-SEND\-PACK" "1" "01/20/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -10,22 +10,31 @@ .SH "NAME" git\-send\-pack \- Push objects over git protocol to another reposiotory .SH "SYNOPSIS" -\fIgit\-send\-pack\fR [\-\-all] [\-\-force] [\-\-exec=] [:] [\&...] +\fIgit\-send\-pack\fR [\-\-all] [\-\-force] [\-\-receive\-pack=] [\-\-verbose] [\-\-thin] [:] [\&...] .SH "DESCRIPTION" Usually you would want to use \fBgit\-push\fR(1) which is a higher level wrapper of this command instead. Invokes \fIgit\-receive\-pack\fR on a possibly remote repository, and updates it from the current repository, sending named refs. .SH "OPTIONS" .TP -\-\-exec= +\-\-receive\-pack= Path to the \fIgit\-receive\-pack\fR program on the remote end. Sometimes useful when pushing to a remote repository over ssh, and you do not have the program in a directory on the default $PATH. .TP +\-\-exec= +Same as \-\-receive\-pack=. +.TP \-\-all Instead of explicitly specifying which refs to update, update all refs that locally exist. .TP \-\-force Usually, the command refuses to update a remote ref that is not an ancestor of the local ref used to overwrite it. This flag disables the check. What this means is that the remote repository can lose commits; use it with care. .TP +\-\-verbose +Run verbosely. +.TP +\-\-thin +Spend extra cycles to minimize the number of objects to be sent. Use it on slower connection. +.TP A remote host to house the repository. When this part is specified, \fIgit\-receive\-pack\fR is invoked via ssh. .TP diff --git a/man7/git.7 b/man7/git.7 index 7f3f6a564..9ac9a09df 100644 --- a/man7/git.7 +++ b/man7/git.7 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT" "7" "01/19/2007" "" "" +.TH "GIT" "7" "01/20/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -58,9 +58,6 @@ Add file contents to the changeset to be committed next. \fBgit\-am\fR(1) Apply a series of patches from a mailbox. .TP -\fBgit\-applymbox\fR(1) -Apply a series of patches in a mailbox. -.TP \fBgit\-archive\fR(1) Creates an archive of files from a named tree. .TP @@ -85,6 +82,9 @@ Clones a repository into a new directory. \fBgit\-commit\fR(1) Record changes to the repository. .TP +\fBgit\-describe\fR(1) +Show the most recent tag that is reachable from a commit. +.TP \fBgit\-diff\fR(1) Show changes between commits, commit and working tree, etc. .TP @@ -94,27 +94,27 @@ Download objects and refs from another repository. \fBgit\-format\-patch\fR(1) Prepare patches for e\-mail submission. .TP +\fBgit\-gc\fR(1) +Cleanup unnecessary files and optimize the local repository. +.TP \fBgit\-grep\fR(1) Print lines matching a pattern. .TP +\fBgit\-init\fR(1) +Create an empty git repository or reinitialize an existing one. +.TP \fBgitk\fR(1) The git repository browser. .TP \fBgit\-log\fR(1) Show commit logs. .TP -\fBgit\-ls\-remote\fR(1) -List references in a remote repository. -.TP \fBgit\-merge\fR(1) Join two or more development histories together. .TP \fBgit\-mv\fR(1) Move or rename a file, a directory, or a symlink. .TP -\fBgit\-pack\-refs\fR(1) -Pack heads and tags for efficient repository access. -.TP \fBgit\-pull\fR(1) Fetch from and merge with another repository or a local branch. .TP @@ -124,12 +124,6 @@ Update remote refs along with associated objects. \fBgit\-rebase\fR(1) Forward\-port local commits to the updated upstream head. .TP -\fBgit\-repack\fR(1) -Pack unpacked objects in a repository. -.TP -\fBgit\-rerere\fR(1) -Reuse recorded resolution of conflicted merges. -.TP \fBgit\-reset\fR(1) Reset current HEAD to the specified state. .TP @@ -148,126 +142,69 @@ Summarize \fIgit log\fR output. \fBgit\-show\fR(1) Show various types of objects. .TP -\fBgit\-show\-branch\fR(1) -Show branches and their commits. -.TP \fBgit\-status\fR(1) Show the working tree status. .TP -\fBgit\-verify\-tag\fR(1) -Check the GPG signature of tag. -.TP -\fBgit\-whatchanged\fR(1) -Show logs with difference each commit introduces. +\fBgit\-tag\fR(1) +Create or verify a tag object signed with GPG. .SS "Ancillary Commands" Manipulators: .TP -\fBgit\-applypatch\fR(1) -Apply one patch extracted from an e\-mail. -.TP -\fBgit\-archimport\fR(1) -Import an Arch repository into git. -.TP \fBgit\-convert\-objects\fR(1) Converts old\-style git repository. .TP -\fBgit\-cvsexportcommit\fR(1) -Export a single commit to a CVS checkout. -.TP -\fBgit\-cvsimport\fR(1) -Salvage your data out of another SCM people love to hate. -.TP -\fBgit\-cvsserver\fR(1) -A CVS server emulator for git. -.TP -\fBgit\-gc\fR(1) -Cleanup unnecessary files and optimize the local repository. -.TP \fBgit\-lost\-found\fR(1) Recover lost refs that luckily have not yet been pruned. .TP -\fBgit\-merge\-one\-file\fR(1) -The standard helper program to use with git\-merge\-index. +\fBgit\-pack\-refs\fR(1) +Pack heads and tags for efficient repository access. .TP \fBgit\-prune\fR(1) Prunes all unreachable objects from the object database. .TP -\fBgit\-quiltimport\fR(1) -Applies a quilt patchset onto the current branch. -.TP \fBgit\-reflog\fR(1) Manage reflog information. .TP \fBgit\-relink\fR(1) Hardlink common objects in local repositories. .TP -\fBgit\-sh\-setup\fR(1) -Common git shell script setup code. -.TP -\fBgit\-svn\fR(1) -Bidirectional operation between a single Subversion branch and git. -.TP -\fBgit\-svnimport\fR(1) -Import a SVN repository into git. -.TP -\fBgit\-symbolic\-ref\fR(1) -Read and modify symbolic refs. -.TP -\fBgit\-tag\fR(1) -Create or verify a tag object signed with GPG. +\fBgit\-repack\fR(1) +Pack unpacked objects in a repository. .TP -\fBgit\-update\-ref\fR(1) -Update the object name stored in a ref safely. +\fBgit\-repo\-config\fR(1) +Get and set repository or global options. Interrogators: .TP \fBgit\-annotate\fR(1) Annotate file lines with commit info. .TP +\fBgit\-applymbox\fR(1) +Apply a series of patches in a mailbox. +.TP \fBgit\-blame\fR(1) Show what revision and author last modified each line of a file. .TP -\fBgit\-check\-ref\-format\fR(1) -Make sure ref name is well formed. -.TP \fBgit\-cherry\fR(1) Find commits not merged upstream. .TP \fBgit\-count\-objects\fR(1) Count unpacked number of objects and their disk consumption. .TP -\fBgit\-daemon\fR(1) -A really simple server for git repositories. -.TP -\fBgit\-fmt\-merge\-msg\fR(1) -Produce a merge commit message. +\fBgit\-fsck\-objects\fR(1) +Verifies the connectivity and validity of the objects in the database. .TP \fBgit\-get\-tar\-commit\-id\fR(1) Extract commit ID from an archive created using git\-tar\-tree. .TP -\fBgit\-imap\-send\fR(1) -Dump a mailbox from stdin into an imap folder. -.TP \fBgit\-instaweb\fR(1) Instantly browse your working repository in gitweb. .TP -\fBgit\-mailinfo\fR(1) -Extracts patch and authorship from a single e\-mail message. -.TP -\fBgit\-mailsplit\fR(1) -Simple UNIX mbox splitter program. -.TP \fBgit\-merge\-tree\fR(1) Show three\-way merge without touching index. .TP -\fBgit\-parse\-remote\fR(1) -Routines to help parsing remote repository access parameters. -.TP -\fBgit\-patch\-id\fR(1) -Compute unique ID for a patch. -.TP -\fBgit\-request\-pull\fR(1) -Generates a summary of pending changes. +\fBgit\-rerere\fR(1) +Reuse recorded resolution of conflicted merges. .TP \fBgit\-rev\-parse\fR(1) Pick out and massage parameters. @@ -275,18 +212,52 @@ Pick out and massage parameters. \fBgit\-runstatus\fR(1) A helper for git\-status and git\-commit. .TP +\fBgit\-show\-branch\fR(1) +Show branches and their commits. +.TP +\fBgit\-verify\-tag\fR(1) +Check the GPG signature of tag. +.TP +\fBgit\-whatchanged\fR(1) +Show logs with difference each commit introduces. +.SS "Interacting with Others" +These commands are to interact with foreign SCM and with other people via patch over e\-mail. +.TP +\fBgit\-archimport\fR(1) +Import an Arch repository into git. +.TP +\fBgit\-cvsexportcommit\fR(1) +Export a single commit to a CVS checkout. +.TP +\fBgit\-cvsimport\fR(1) +Salvage your data out of another SCM people love to hate. +.TP +\fBgit\-cvsserver\fR(1) +A CVS server emulator for git. +.TP +\fBgit\-imap\-send\fR(1) +Dump a mailbox from stdin into an imap folder. +.TP +\fBgit\-quiltimport\fR(1) +Applies a quilt patchset onto the current branch. +.TP +\fBgit\-request\-pull\fR(1) +Generates a summary of pending changes. +.TP \fBgit\-send\-email\fR(1) Send a collection of patches as emails. .TP -\fBgit\-stripspace\fR(1) -Filter out empty lines. +\fBgit\-svn\fR(1) +Bidirectional operation between a single Subversion branch and git. .TP -\fBgit\-symbolic\-ref\fR(1) -Read and modify symbolic refs. +\fBgit\-svnimport\fR(1) +Import a SVN repository into git. .SH "LOW\-LEVEL COMMANDS (PLUMBING)" Although git includes its own porcelain layer, its low\-level commands are sufficient to support development of alternative porcelains. Developers of such porcelains might start by reading about \fBgit\-update\-index\fR(1) and \fBgit\-read\-tree\fR(1). -We divide the low\-level commands into commands that manipulate objects (in the repository, index, and working tree), commands that interrogate and compare objects, and commands that move objects and references between repositories. +The interface (input, output, set of options and the semantics) to these low\-level commands are meant to be a lot more stable than Porcelain level commands, because these commands are primarily for scripted use. The interface to Porcelain commands on the other hand are subject to change in order to improve the end user experience. + +The following description divides the low\-level commands into commands that manipulate objects (in the repository, index, and working tree), commands that interrogate and compare objects, and commands that move objects and references between repositories. .SS "Manipulation commands" .TP \fBgit\-apply\fR(1) @@ -304,9 +275,6 @@ Compute object ID and optionally creates a blob from a file. \fBgit\-index\-pack\fR(1) Build pack index file for an existing packed archive. .TP -\fBgit\-init\fR(1) -Create an empty git repository or reinitialize an existing one. -.TP \fBgit\-merge\-file\fR(1) Run a three\-way file merge. .TP @@ -328,8 +296,8 @@ Remove extra objects that are already in pack files. \fBgit\-read\-tree\fR(1) Reads tree information into the index. .TP -\fBgit\-repo\-config\fR(1) -Get and set repository or global options. +\fBgit\-symbolic\-ref\fR(1) +Read and modify symbolic refs. .TP \fBgit\-unpack\-objects\fR(1) Unpack objects from a packed archive. @@ -337,6 +305,9 @@ Unpack objects from a packed archive. \fBgit\-update\-index\fR(1) Register file contents in the working tree to the index. .TP +\fBgit\-update\-ref\fR(1) +Update the object name stored in a ref safely. +.TP \fBgit\-write\-tree\fR(1) Create a tree object from the current index. .SS "Interrogation commands" @@ -344,9 +315,6 @@ Create a tree object from the current index. \fBgit\-cat\-file\fR(1) Provide content or type/size information for repository objects. .TP -\fBgit\-describe\fR(1) -Show the most recent tag that is reachable from a commit. -.TP \fBgit\-diff\-files\fR(1) Compares files in the working tree and the index. .TP @@ -362,12 +330,12 @@ Compares the content and mode of blobs found via two tree objects. \fBgit\-for\-each\-ref\fR(1) Output information on each ref. .TP -\fBgit\-fsck\-objects\fR(1) -Verifies the connectivity and validity of the objects in the database. -.TP \fBgit\-ls\-files\fR(1) Show information about files in the index and the working tree. .TP +\fBgit\-ls\-remote\fR(1) +List references in a remote repository. +.TP \fBgit\-ls\-tree\fR(1) List the contents of a tree object. .TP @@ -404,30 +372,18 @@ Validate packed git archive files. In general, the interrogate commands do not touch the files in the working tree. .SS "Synching repositories" .TP +\fBgit\-daemon\fR(1) +A really simple server for git repositories. +.TP \fBgit\-fetch\-pack\fR(1) Receive missing objects from another repository. .TP -\fBgit\-http\-fetch\fR(1) -Download from a remote git repository via HTTP. -.TP -\fBgit\-http\-push\fR(1) -Push objects over HTTP/DAV to another repository. -.TP \fBgit\-local\-fetch\fR(1) Duplicate another git repository on a local system. .TP -\fBgit\-peek\-remote\fR(1) -List the references in a remote repository. -.TP -\fBgit\-receive\-pack\fR(1) -Receive what is pushed into the repository. -.TP \fBgit\-send\-pack\fR(1) Push objects over git protocol to another reposiotory. .TP -\fBgit\-shell\fR(1) -Restricted login shell for GIT\-only SSH access. -.TP \fBgit\-ssh\-fetch\fR(1) Fetch from a remote repository over ssh connection. .TP @@ -436,12 +392,61 @@ Push to a remote repository over ssh connection. .TP \fBgit\-update\-server\-info\fR(1) Update auxiliary info file to help dumb servers. + +The following are helper programs used by the above; end users typically do not use them directly. +.TP +\fBgit\-http\-fetch\fR(1) +Download from a remote git repository via HTTP. +.TP +\fBgit\-http\-push\fR(1) +Push objects over HTTP/DAV to another repository. +.TP +\fBgit\-parse\-remote\fR(1) +Routines to help parsing remote repository access parameters. +.TP +\fBgit\-receive\-pack\fR(1) +Receive what is pushed into the repository. +.TP +\fBgit\-shell\fR(1) +Restricted login shell for GIT\-only SSH access. .TP \fBgit\-upload\-archive\fR(1) Send archive back to git\-archive. .TP \fBgit\-upload\-pack\fR(1) Send objects packed back to git\-fetch\-pack. +.SS "Internal helper commands" +These are internal helper commands used by other commands; end users typically do not use them directly. +.TP +\fBgit\-applypatch\fR(1) +Apply one patch extracted from an e\-mail. +.TP +\fBgit\-check\-ref\-format\fR(1) +Make sure ref name is well formed. +.TP +\fBgit\-fmt\-merge\-msg\fR(1) +Produce a merge commit message. +.TP +\fBgit\-mailinfo\fR(1) +Extracts patch and authorship from a single e\-mail message. +.TP +\fBgit\-mailsplit\fR(1) +Simple UNIX mbox splitter program. +.TP +\fBgit\-merge\-one\-file\fR(1) +The standard helper program to use with git\-merge\-index. +.TP +\fBgit\-patch\-id\fR(1) +Compute unique ID for a patch. +.TP +\fBgit\-peek\-remote\fR(1) +List the references in a remote repository. +.TP +\fBgit\-sh\-setup\fR(1) +Common git shell script setup code. +.TP +\fBgit\-stripspace\fR(1) +Filter out empty lines. .SH "CONFIGURATION MECHANISM" Starting from 0.99.9 (actually mid 0.99.8.GIT), .git/config file is used to hold per\-repository configuration options. It is a simple text file modeled after .ini format familiar to some people. Here is an example: .sp