Merge http://www.kernel.org/pub/scm/gitk/gitk
[git/git.git] / Documentation / git-daemon.txt
1 git-daemon(1)
2 =============
3
4 NAME
5 ----
6 git-daemon - A really simple server for git repositories.
7
8 SYNOPSIS
9 --------
10 'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all]
11 [--timeout=n] [--init-timeout=n] [directory...]
12
13 DESCRIPTION
14 -----------
15 A really simple TCP git daemon that normally listens on port "DEFAULT_GIT_PORT"
16 aka 9418. It waits for a connection, and will just execute "git-upload-pack"
17 when it gets one.
18
19 It's careful in that there's a magic request-line that gives the command and
20 what directory to upload, and it verifies that the directory is ok.
21
22 It verifies that the directory has the magic file "git-daemon-export-ok", and
23 it will refuse to export any git directory that hasn't explicitly been marked
24 for export this way (unless the '--export-all' parameter is specified). If you
25 pass some directory paths as 'git-daemon' arguments, you can further restrict
26 the offers to a whitelist comprising of those.
27
28 This is ideally suited for read-only updates, ie pulling from git repositories.
29
30 OPTIONS
31 -------
32 --export-all::
33 Allow pulling from all directories that look like GIT repositories
34 (have the 'objects' subdirectory and a 'HEAD' file), even if they
35 do not have the 'git-daemon-export-ok' file.
36
37 --inetd::
38 Have the server run as an inetd service.
39
40 --port::
41 Listen on an alternative port.
42
43 --init-timeout::
44 Timeout between the moment the connection is established and the
45 client request is received (typically a rather low value, since
46 that should be basically immediate).
47
48 --timeout::
49 Timeout for specific client sub-requests. This includes the time
50 it takes for the server to process the sub-request and time spent
51 waiting for next client's request.
52
53 --syslog::
54 Log to syslog instead of stderr. Note that this option does not imply
55 --verbose, thus by default only error conditions will be logged.
56
57 --verbose::
58 Log details about the incoming connections and requested files.
59
60 Author
61 ------
62 Written by Linus Torvalds <torvalds@osdl.org> and YOSHIFUJI Hideaki <yoshfuji@linux-ipv6.org>
63
64 Documentation
65 --------------
66 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
67
68 GIT
69 ---
70 Part of the gitlink:git[7] suite
71