Update git-daemon's documentation wrt. new options

New options --timeout, --init-timeout, --export-all and whitelist support
were added to git-daemon, but noone bothered to also add the proper
documentation. This patch aims to fix that.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Petr Baudis 2005-10-21 02:28:45 +02:00 committed by Junio C Hamano
parent baa720f501
commit 2707da9c08
1 changed files with 20 additions and 2 deletions

View File

@ -7,7 +7,8 @@ git-daemon - A really simple server for git repositories.


SYNOPSIS SYNOPSIS
-------- --------
'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] 'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all]
[--timeout=n] [--init-timeout=n] [directory...]


DESCRIPTION DESCRIPTION
----------- -----------
@ -20,18 +21,35 @@ 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 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 it will refuse to export any git directory that hasn't explicitly been marked
for export this way. 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.


This is ideally suited for read-only updates, ie pulling from git repositories. This is ideally suited for read-only updates, ie pulling from git repositories.


OPTIONS OPTIONS
------- -------
--export-all::
Allow pulling from all directories that look like GIT repositories
(have the 'objects' subdirectory and a 'HEAD' file), even if they
do not have the 'git-daemon-export-ok' file.

--inetd:: --inetd::
Have the server run as an inetd service. Have the server run as an inetd service.


--port:: --port::
Listen on an alternative port. Listen on an alternative port.


--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::
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.

--syslog:: --syslog::
Log to syslog instead of stderr. Note that this option does not imply Log to syslog instead of stderr. Note that this option does not imply
--verbose, thus by default only error conditions will be logged. --verbose, thus by default only error conditions will be logged.