Autogenerated man pages for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
[git.git] / man1 / git-daemon.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-DAEMON" 1 "" "" ""
21 .SH NAME
22 git-daemon \- A really simple server for git repositories.
23 .SH "SYNOPSIS"
24
25
26 git\-daemon [\-\-verbose] [\-\-syslog] [\-\-inetd | \-\-port=n] [\-\-export\-all] [\-\-timeout=n] [\-\-init\-timeout=n] [\-\-strict\-paths] [directory...]
27
28 .SH "DESCRIPTION"
29
30
31 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\&.
32
33
34 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\&.
35
36
37 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 \-\-export\-all parameter is specified)\&. If you pass some directory paths as git\-daemon arguments, you can further restrict the offers to a whitelist comprising of those\&.
38
39
40 This is ideally suited for read\-only updates, ie pulling from git repositories\&.
41
42 .SH "OPTIONS"
43
44 .TP
45 \-\-strict\-paths
46 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\&.
47
48 .TP
49 \-\-export\-all
50 Allow pulling from all directories that look like GIT repositories (have the objects and refs subdirectories), even if they do not have the git\-daemon\-export\-ok file\&.
51
52 .TP
53 \-\-inetd
54 Have the server run as an inetd service\&. Implies \-\-syslog\&.
55
56 .TP
57 \-\-port
58 Listen on an alternative port\&.
59
60 .TP
61 \-\-init\-timeout
62 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)\&.
63
64 .TP
65 \-\-timeout
66 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\&.
67
68 .TP
69 \-\-syslog
70 Log to syslog instead of stderr\&. Note that this option does not imply \-\-verbose, thus by default only error conditions will be logged\&.
71
72 .TP
73 \-\-verbose
74 Log details about the incoming connections and requested files\&.
75
76 .TP
77 <directory>
78 A directory to add to the whitelist of allowed directories\&. Unless \-\-strict\-paths is specified this will also include subdirectories of each named directory\&.
79
80 .SH "AUTHOR"
81
82
83 Written by Linus Torvalds <torvalds@osdl\&.org>, YOSHIFUJI Hideaki <yoshfuji@linux\-ipv6\&.org> and the git\-list <git@vger\&.kernel\&.org>
84
85 .SH "DOCUMENTATION"
86
87
88 Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
89
90 .SH "GIT"
91
92
93 Part of the \fBgit\fR(7) suite
94