Merge branch 'js/refs' into next
[gitweb.git] / Documentation / git-daemon.txt
index 972e0e1571391efb6041f0e7bff5df18fb1a4eaf..2cc6075fb0b316f4254273caa4fe184fdc5afb35 100644 (file)
@@ -7,8 +7,11 @@ git-daemon - A really simple server for git repositories.
 
 SYNOPSIS
 --------
+[verse]
 'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all]
-             [--timeout=n] [--init-timeout=n] [directory...]
+             [--timeout=n] [--init-timeout=n] [--strict-paths]
+             [--base-path=path] [--user-path | --user-path=path]
+            [directory...]
 
 DESCRIPTION
 -----------
@@ -29,12 +32,19 @@ This is ideally suited for read-only updates, ie pulling from git repositories.
 
 OPTIONS
 -------
-+--strict-paths::
+--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.
 
+--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
+       '--base-path=/srv/git' on example.com, then if you later try to pull
+       'git://example.com/hello.git', `git-daemon` will interpret the path
+       as '/srv/git/hello.git'.
+
 --export-all::
        Allow pulling from all directories that look like GIT repositories
        (have the 'objects' and 'refs' subdirectories), even if they
@@ -60,6 +70,15 @@ OPTIONS
        Log to syslog instead of stderr. Note that this option does not imply
        --verbose, thus by default only error conditions will be logged.
 
+--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
+       'foo' 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`.
+
 --verbose::
        Log details about the incoming connections and requested files.