Autogenerated man pages for v1.4.2-g7bbf
authorJunio C Hamano <junio@hera.kernel.org>
Thu, 7 Sep 2006 11:44:12 +0000 (11:44 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Thu, 7 Sep 2006 11:44:12 +0000 (11:44 +0000)
man1/git-daemon.1

index 740a1dd862f8cf1b6f8c5ce038806412c0d9317f..a681ecd6cb5e44448eefbdb75f0b829c809a93cc 100755 (executable)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "GIT-DAEMON" 1 "" "" ""
-.SH NAME
-git-daemon \- A really simple server for git repositories
+.\" ** You probably do not want to edit this file directly **
+.\" 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" "09/07/2006" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+git\-daemon \- A really simple server for git repositories
 .SH "SYNOPSIS"
-
+.sp
 .nf
 \fIgit\-daemon\fR [\-\-verbose] [\-\-syslog] [\-\-inetd | \-\-port=n] [\-\-export\-all]
              [\-\-timeout=n] [\-\-init\-timeout=n] [\-\-strict\-paths]
              [\-\-base\-path=path] [\-\-user\-path | \-\-user\-path=path]
+             [\-\-enable=service] [\-\-disable=service]
+             [\-\-allow\-override=service] [\-\-forbid\-override=service]
              [\-\-reuseaddr] [\-\-detach] [\-\-pid\-file=file]
-             [\-\-user=user [\-\-group=group]] [directory...]
+             [\-\-user=user [\-\-group=group]] [directory\&...]
 .fi
-
 .SH "DESCRIPTION"
-
-
-A really simple TCP git daemon that normally listens on port "DEFAULT_GIT_PORT" aka 9418\&. It waits for a connection, and will just execute "git\-upload\-pack" when it gets one\&.
-
-
-It's careful in that there's a magic request\-line that gives the command and what directory to upload, and it verifies that the directory is OK\&.
-
-
-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\&.
-
-
-This is ideally suited for read\-only updates, i\&.e\&., pulling from git repositories\&.
-
+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
 .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\&.
-
+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
 \-\-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\&.
-
+Have the server run as an inetd service. Implies \-\-syslog.
 .TP
 \-\-port
-Listen on an alternative port\&.
-
+Listen on an alternative port.
 .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)\&.
-
+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).
 .TP
 \-\-timeout
-Timeout for specific client sub\-requests\&. This includes the time it takes for the server to process the sub\-request and time spent waiting for next client's request\&.
-
+Timeout for specific client sub\-requests. This includes the time it takes for the server to process the sub\-request and time spent waiting for next client's request.
 .TP
 \-\-syslog
-Log to syslog instead of stderr\&. Note that this option does not imply \-\-verbose, thus by default only error conditions will be logged\&.
-
+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\&.
-
+Log details about the incoming connections and requested files.
 .TP
 \-\-reuseaddr
-Use SO_REUSEADDR when binding the listening socket\&. This allows the server to restart without waiting for old connections to time out\&.
-
+Use SO_REUSEADDR when binding the listening socket. This allows the server to restart without waiting for old connections to time out.
 .TP
 \-\-detach
-Detach from the shell\&. Implies \-\-syslog\&.
-
+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\&.
-
-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.
+.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.
+.TP
+\-\-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/forbid overriding the site\-wide default with per repository configuration. By default, all the services are overridable.
 .TP
 <directory>
-A directory to add to the whitelist of allowed directories\&. Unless \-\-strict\-paths is specified this will also include subdirectories of each named directory\&.
-
+A directory to add to the whitelist of allowed directories. Unless \-\-strict\-paths is specified this will also include subdirectories of each named directory.
+.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.
 .SH "AUTHOR"
-
-
-Written by Linus Torvalds <torvalds@osdl\&.org>, YOSHIFUJI Hideaki <yoshfuji@linux\-ipv6\&.org> and the git\-list <git@vger\&.kernel\&.org>
-
+Written by Linus Torvalds <torvalds@osdl.org>, YOSHIFUJI Hideaki <yoshfuji@linux\-ipv6.org> and the git\-list <git@vger.kernel.org>
+.sp
 .SH "DOCUMENTATION"
-
-
-Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
-
+Documentation by Junio C Hamano and the git\-list <git@vger.kernel.org>.
+.sp
 .SH "GIT"
-
-
 Part of the \fBgit\fR(7) suite
-
+.sp