From cab5e778bc732cd01a4e8450320e70569f5bcfc6 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 25 Jan 2007 02:24:24 +0000 Subject: [PATCH] Autogenerated man pages for v1.5.0-rc2-g19605 --- man1/git-commit.1 | 6 +-- man1/git-daemon.1 | 112 +++++++++-------------------------------- man1/git-fetch-pack.1 | 9 ++-- man1/git-peek-remote.1 | 9 ++-- man1/git-repo-config.1 | 4 +- man1/git-rev-list.1 | 4 +- man1/git-show-branch.1 | 6 +-- man7/git.7 | 2 +- 8 files changed, 47 insertions(+), 105 deletions(-) diff --git a/man1/git-commit.1 b/man1/git-commit.1 index c60cedc8f..ef890c5f7 100644 --- a/man1/git-commit.1 +++ b/man1/git-commit.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\-COMMIT" "1" "01/19/2007" "" "" +.TH "GIT\-COMMIT" "1" "01/25/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -12,8 +12,8 @@ git\-commit \- Record changes to the repository .SH "SYNOPSIS" .sp .nf -\fIgit\-commit\fR [\-a] [\-s] [\-v] [(\-c | \-C) | \-F | \-m ] - [\-\-no\-verify] [\-\-amend] [\-e] [\-\-author ] +\fIgit\-commit\fR [\-a] [\-s] [\-v] [(\-c | \-C) | \-F | \-m | + \-\-amend] [\-\-no\-verify] [\-e] [\-\-author ] [\-\-] [[\-i | \-o ]\&...] .fi .SH "DESCRIPTION" diff --git a/man1/git-daemon.1 b/man1/git-daemon.1 index 84836e69c..b72e44614 100644 --- a/man1/git-daemon.1 +++ b/man1/git-daemon.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\-DAEMON" "1" "10/27/2006" "" "" +.TH "GIT\-DAEMON" "1" "01/25/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -24,53 +24,36 @@ git\-daemon \- A really simple server for git repositories .fi .SH "DESCRIPTION" A really simple TCP git daemon that normally listens on port "DEFAULT_GIT_PORT" aka 9418. It waits for a connection asking for a service, and will serve that service if it is enabled. -.sp + It verifies that the directory has the magic file "git\-daemon\-export\-ok", and it will refuse to export any git directory that hasn't explicitly been marked for export this way (unless the \fI\-\-export\-all\fR parameter is specified). If you pass some directory paths as \fIgit\-daemon\fR arguments, you can further restrict the offers to a whitelist comprising of those. -.sp + By default, only upload\-pack service is enabled, which serves git\-fetch\-pack and git\-peek\-remote clients that are invoked from git\-fetch, git\-ls\-remote, and git\-clone. -.sp + This is ideally suited for read\-only updates, i.e., pulling from git repositories. -.sp + An upload\-archive also exists to serve git\-archive. -.sp .SH "OPTIONS" .TP \-\-strict\-paths Match paths exactly (i.e. don't allow "/foo/repo" when the real path is "/foo/repo.git" or "/foo/repo/.git") and don't do user\-relative paths. git\-daemon will refuse to start when this option is enabled and no whitelist is specified. .TP \-\-base\-path -Remap all the path requests as relative to the given path. This is sort of "GIT root" \- if you run git\-daemon with -\fI\-\-base\-path=/srv/git\fR -on example.com, then if you later try to pull -\fIgit://example.com/hello.git\fR, -git\-daemon -will interpret the path as -\fI/srv/git/hello.git\fR. +Remap all the path requests as relative to the given path. This is sort of "GIT root" \- if you run git\-daemon with \fI\-\-base\-path=/srv/git\fR on example.com, then if you later try to pull \fIgit://example.com/hello.git\fR, git\-daemon will interpret the path as \fI/srv/git/hello.git\fR. .TP \-\-interpolated\-path=pathtemplate To support virtual hosting, an interpolated path template can be used to dynamically construct alternate paths. The template supports %H for the target hostname as supplied by the client but converted to all lowercase, %CH for the canonical hostname, %IP for the server's IP address, %P for the port number, and %D for the absolute path of the named repository. After interpolation, the path is validated against the directory whitelist. .TP \-\-export\-all -Allow pulling from all directories that look like GIT repositories (have the -\fIobjects\fR -and -\fIrefs\fR -subdirectories), even if they do not have the -\fIgit\-daemon\-export\-ok\fR -file. +Allow pulling from all directories that look like GIT repositories (have the \fIobjects\fR and \fIrefs\fR subdirectories), even if they do not have the \fIgit\-daemon\-export\-ok\fR file. .TP \-\-inetd Have the server run as an inetd service. Implies \-\-syslog. Incompatible with \-\-port, \-\-listen, \-\-user and \-\-group options. .TP \-\-listen=host_or_ipaddr -Listen on an a specific IP address or hostname. IP addresses can be either an IPv4 address or an IPV6 address if supported. If IPv6 is not supported, then \-\-listen=hostname is also not supported and \-\-listen must be given an IPv4 address. Incompatible with -\fI\-\-inetd\fR -option. +Listen on an a specific IP address or hostname. IP addresses can be either an IPv4 address or an IPV6 address if supported. If IPv6 is not supported, then \-\-listen=hostname is also not supported and \-\-listen must be given an IPv4 address. Incompatible with \fI\-\-inetd\fR option. .TP \-\-port=n -Listen on an alternative port. Incompatible with -\fI\-\-inetd\fR -option. +Listen on an alternative port. Incompatible with \fI\-\-inetd\fR option. .TP \-\-init\-timeout Timeout between the moment the connection is established and the client request is received (typically a rather low value, since that should be basically immediate). @@ -82,15 +65,7 @@ Timeout for specific client sub\-requests. This includes the time it takes for t Log to syslog instead of stderr. Note that this option does not imply \-\-verbose, thus by default only error conditions will be logged. .TP \-\-user\-path, \-\-user\-path=path -Allow ~user notation to be used in requests. When specified with no parameter, requests to git://host/~alice/foo is taken as a request to access -\fIfoo\fR -repository in the home directory of user -alice. If -\-\-user\-path=path -is specified, the same request is taken as a request to access -path/foo -repository in the home directory of user -alice. +Allow ~user notation to be used in requests. When specified with no parameter, requests to git://host/~alice/foo is taken as a request to access \fIfoo\fR repository in the home directory of user alice. If \-\-user\-path=path is specified, the same request is taken as a request to access path/foo repository in the home directory of user alice. .TP \-\-verbose Log details about the incoming connections and requested files. @@ -102,28 +77,17 @@ Use SO_REUSEADDR when binding the listening socket. This allows the server to re Detach from the shell. Implies \-\-syslog. .TP \-\-pid\-file=file -Save the process id in -\fIfile\fR. +Save the process id in \fIfile\fR. .TP \-\-user=user, \-\-group=group -Change daemon's uid and gid before entering the service loop. When only -\-\-user -is given without -\-\-group, the primary group ID for the user is used. The values of the option are given to -getpwnam(3) -and -getgrnam(3) -and numeric IDs are not supported. -.sp -Giving these options is an error when used with -\-\-inetd; use the facility of inet daemon to achieve the same before spawning -git\-daemon -if needed. +Change daemon's uid and gid before entering the service loop. When only \-\-user is given without \-\-group, the primary group ID for the user is used. The values of the option are given to getpwnam(3) and getgrnam(3) and numeric IDs are not supported. + +Giving these options is an error when used with \-\-inetd; use the facility of inet daemon to achieve the same before spawning git\-daemon if needed. .TP -\-\-enable\-service, \-\-disable\-service +\-\-enable=service, \-\-disable=service Enable/disable the service site\-wide per default. Note that a service disabled site\-wide can still be enabled per repository if it is marked overridable and the repository enables the service with an configuration item. .TP -\-\-allow\-override, \-\-forbid\-override +\-\-allow\-override=service, \-\-forbid\-override=service Allow/forbid overriding the site\-wide default with per repository configuration. By default, all the services are overridable. .TP @@ -131,18 +95,10 @@ A directory to add to the whitelist of allowed directories. Unless \-\-strict\-p .SH "SERVICES" .TP upload\-pack -This serves -git\-fetch\-pack -and -git\-peek\-remote -clients. It is enabled by default, but a repository can disable it by setting -daemon.uploadpack -configuration item to -false. +This serves git\-fetch\-pack and git\-peek\-remote clients. It is enabled by default, but a repository can disable it by setting daemon.uploadpack configuration item to false. .TP upload\-archive -This serves -git\-archive \-\-remote. +This serves git\-archive \-\-remote. .SH "EXAMPLES" .TP We assume the following in /etc/services @@ -153,9 +109,7 @@ git 9418/tcp # Git Version Control System .fi .TP git\-daemon as inetd server -To set up -git\-daemon -as an inetd service that handles any repository under the whitelisted set of directories, /pub/foo and /pub/bar, place an entry like the following into /etc/inetd all on one line: +To set up git\-daemon as an inetd service that handles any repository under the whitelisted set of directories, /pub/foo and /pub/bar, place an entry like the following into /etc/inetd all on one line: .sp .nf git stream tcp nowait nobody /usr/bin/git\-daemon @@ -164,14 +118,7 @@ as an inetd service that handles any repository under the whitelisted set of dir .fi .TP git\-daemon as inetd server for virtual hosts -To set up -git\-daemon -as an inetd service that handles repositories for different virtual hosts, -www.example.com -and -www.example.org, place an entry like the following into -/etc/inetd -all on one line: +To set up git\-daemon as an inetd service that handles repositories for different virtual hosts, www.example.com and www.example.org, place an entry like the following into /etc/inetd all on one line: .sp .nf git stream tcp nowait nobody /usr/bin/git\-daemon @@ -181,17 +128,10 @@ all on one line: /pub/www.example.com/software /software .fi -In this example, the root\-level directory -/pub -will contain a subdirectory for each virtual host name supported. Further, both hosts advertise repositories simply as -git://www.example.com/software/repo.git. For pre\-1.4.0 clients, a symlink from -/software -into the appropriate default repository could be made as well. +In this example, the root\-level directory /pub will contain a subdirectory for each virtual host name supported. Further, both hosts advertise repositories simply as git://www.example.com/software/repo.git. For pre\-1.4.0 clients, a symlink from /software into the appropriate default repository could be made as well. .TP git\-daemon as regular daemon for virtual hosts -To set up -git\-daemon -as a regular, non\-inetd service that handles repositories for multiple virtual hosts based on their IP addresses, start the daemon like this: +To set up git\-daemon as a regular, non\-inetd service that handles repositories for multiple virtual hosts based on their IP addresses, start the daemon like this: .sp .nf git\-daemon \-\-verbose \-\-export\-all @@ -199,15 +139,11 @@ as a regular, non\-inetd service that handles repositories for multiple virtual /pub/192.168.1.200/software /pub/10.10.220.23/software .fi -In this example, the root\-level directory -/pub -will contain a subdirectory for each virtual host IP address supported. Repositories can still be accessed by hostname though, assuming they correspond to these IP addresses. +In this example, the root\-level directory /pub will contain a subdirectory for each virtual host IP address supported. Repositories can still be accessed by hostname though, assuming they correspond to these IP addresses. .SH "AUTHOR" Written by Linus Torvalds , YOSHIFUJI Hideaki and the git\-list -.sp .SH "DOCUMENTATION" Documentation by Junio C Hamano and the git\-list . -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp + diff --git a/man1/git-fetch-pack.1 b/man1/git-fetch-pack.1 index 5d6e370f1..241795faa 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/20/2007" "" "" +.TH "GIT\-FETCH\-PACK" "1" "01/25/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 [\-\-all] [\-\-quiet|\-q] [\-\-keep|\-k] [\-\-thin] [\-\-exec=] [\-\-depth=] [\-v] [:] [\&...] +\fIgit\-fetch\-pack\fR [\-\-all] [\-\-quiet|\-q] [\-\-keep|\-k] [\-\-thin] [\-\-upload\-pack=] [\-\-depth=] [\-v] [:] [\&...] .SH "DESCRIPTION" Usually you would want to use \fBgit\-fetch\fR(1) which is a higher level wrapper of this command instead. @@ -31,9 +31,12 @@ Do not invoke \fIgit\-unpack\-objects\fR on received data, but create a single p \-\-thin Spend extra cycles to minimize the number of objects to be sent. Use it on slower connection. .TP -\-\-exec= +\-\-upload\-pack= 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 +\-\-exec= +Same as \-\-upload\-pack=. +.TP \-\-depth= Limit fetching to ancestor\-chains not longer than n. .TP diff --git a/man1/git-peek-remote.1 b/man1/git-peek-remote.1 index f19502656..d772835a2 100644 --- a/man1/git-peek-remote.1 +++ b/man1/git-peek-remote.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\-PEEK\-REMOTE" "1" "01/19/2007" "" "" +.TH "GIT\-PEEK\-REMOTE" "1" "01/25/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -10,14 +10,17 @@ .SH "NAME" git\-peek\-remote \- List the references in a remote repository .SH "SYNOPSIS" -\fIgit\-peek\-remote\fR [\-\-exec=] [:] +\fIgit\-peek\-remote\fR [\-\-upload\-pack=] [:] .SH "DESCRIPTION" Lists the references the remote repository has, and optionally stores them in the local repository under the same name. .SH "OPTIONS" .TP -\-\-exec= +\-\-upload\-pack= Use this to specify the path to \fIgit\-upload\-pack\fR on the remote side, if it is not found on your $PATH. Some 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, but prefer having a lean .bashrc file (they set most of the things up in .bash_profile). .TP +\-\-exec= +Same \-\-upload\-pack=. +.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-repo-config.1 b/man1/git-repo-config.1 index 2819e317e..c91a52c28 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/23/2007" "" "" +.TH "GIT\-REPO\-CONFIG" "1" "01/25/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -197,7 +197,7 @@ Sections can be further divided into subsections. To begin a subsection put its .nf [section "subsection"] .fi -Subsection names can contain any characters (doublequote \fI"\fR, backslash \fI\\\fR and newline have to be entered escaped as \fI\\"\fR, \fI\\\\\fR and \fI\\n\fR, respecitvely) and are case sensitive. Section header cannot span multiple lines. Variables may belong directly to a section or to a given subsection. You can have [section] if you have [section "subsection"], but you don't need to. +Subsection names can contain any characters except newline (doublequote \fI"\fR and backslash have to be escaped as \fI\\"\fR and \fI\\\\\fR, respecitvely) and are case sensitive. Section header cannot span multiple lines. Variables may belong directly to a section or to a given subsection. You can have [section] if you have [section "subsection"], but you don't need to. There is also (case insensitive) alternative [section.subsection] syntax. In this syntax subsection names follow the same restrictions as for section name. diff --git a/man1/git-rev-list.1 b/man1/git-rev-list.1 index 589318bf5..e7eafa69f 100644 --- a/man1/git-rev-list.1 +++ b/man1/git-rev-list.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\-REV\-LIST" "1" "01/21/2007" "" "" +.TH "GIT\-REV\-LIST" "1" "01/25/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -221,7 +221,7 @@ Pretend as if all the refs in $GIT_DIR/refs/ are listed on the command line as \ \-\-stdin In addition to the \fI\fR listed on the command line, read them from the standard input. .TP -\-\-walk\-reflogs +\-g, \-\-walk\-reflogs Instead of walking the commit ancestry chain, walk reflog entries from the most recent one to older ones. When this option is used you cannot specify commits to exclude (that is, \fI^commit\fR, \fIcommit1..commit2\fR, nor \fIcommit1\&...commit2\fR notations cannot be used). With \fI\-\-pretty\fR format other than oneline (for obvious reasons), this causes the output to have two extra lines of information used in the output. When the starting commit is specified as instead. Under \fI\-\-pretty=oneline\fR, the commit message is prefixed with this information on the same line. .TP \-\-merge diff --git a/man1/git-show-branch.1 b/man1/git-show-branch.1 index cd616f93a..2dd9c5fbb 100644 --- a/man1/git-show-branch.1 +++ b/man1/git-show-branch.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\-SHOW\-BRANCH" "1" "01/21/2007" "" "" +.TH "GIT\-SHOW\-BRANCH" "1" "01/25/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -15,7 +15,7 @@ git\-show\-branch \- Show branches and their commits \fIgit\-show\-branch\fR [\-\-all] [\-\-remotes] [\-\-topo\-order] [\-\-current] [\-\-more= | \-\-list | \-\-independent | \-\-merge\-base] [\-\-no\-name | \-\-sha1\-name] [\-\-topics] [ | ]\&... -\fIgit\-show\-branch\fR \-\-reflog[=[,]] [\-\-list] +\fIgit\-show\-branch\fR (\-g|\-\-reflog)[=[,]] [\-\-list] .fi .SH "DESCRIPTION" Shows the commit ancestry graph starting from the commits named with s or s (or all refs under $GIT_DIR/refs/heads and/or $GIT_DIR/refs/tags) semi\-visually. @@ -68,7 +68,7 @@ Instead of naming the commits using the path to reach them from heads (e.g. "mas Shows only commits that are NOT on the first branch given. This helps track topic branches by hiding any commit that is already in the main line of development. When given "git show\-branch \-\-topics master topic1 topic2", this will show the revisions given by "git rev\-list ^master topic1 topic2" .TP \-\-reflog[=[,]] -Shows most recent ref\-log entries for the given ref. If is given, entries going back from that entry. can be specified as count or date +Shows most recent ref\-log entries for the given ref. If is given, entries going back from that entry. can be specified as count or date. \-g can be used as a short\-hand for this option. Note that \-\-more, \-\-list, \-\-independent and \-\-merge\-base options are mutually exclusive. .SH "OUTPUT" diff --git a/man7/git.7 b/man7/git.7 index 2bf708a20..eaf584870 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/22/2007" "" "" +.TH "GIT" "7" "01/25/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) -- 2.26.2