freshlybakedca.ke
Git fork
git-daemon doc: update mark-up of synopsis option descriptions
To unify mark-up used in our documentation to a newer convention,
started by 22293895 (doc: apply synopsis simplification on git-clone
and git-init, 2024-09-24), update the documentation of 'git daemon'
to
* use [synopsis], not [verse] in the SYNOPSIS section
* enclose `--option=<value>` in backquotes
Also, split '--[no-]option' into '--option' and '--no-option'
to make it easier to grep for them.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
+90
-89
Documentation/git-daemon.adoc
+90
-89
Documentation/git-daemon.adoc
···
7
7
8
8
SYNOPSIS
9
9
--------
10
-
[verse]
11
-
'git daemon' [--verbose] [--syslog] [--export-all]
12
-
[--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]
13
-
[--strict-paths] [--base-path=<path>] [--base-path-relaxed]
14
-
[--user-path | --user-path=<path>]
15
-
[--interpolated-path=<pathtemplate>]
16
-
[--reuseaddr] [--detach] [--pid-file=<file>]
17
-
[--enable=<service>] [--disable=<service>]
18
-
[--allow-override=<service>] [--forbid-override=<service>]
19
-
[--access-hook=<path>] [--[no-]informative-errors]
20
-
[--inetd |
21
-
[--listen=<host-or-ipaddr>] [--port=<n>]
22
-
[--user=<user> [--group=<group>]]]
23
-
[--log-destination=(stderr|syslog|none)]
24
-
[<directory>...]
10
+
[synopsis]
11
+
git daemon [--verbose] [--syslog] [--export-all]
12
+
[--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]
13
+
[--strict-paths] [--base-path=<path>] [--base-path-relaxed]
14
+
[--user-path | --user-path=<path>]
15
+
[--interpolated-path=<pathtemplate>]
16
+
[--reuseaddr] [--detach] [--pid-file=<file>]
17
+
[--enable=<service>] [--disable=<service>]
18
+
[--allow-override=<service>] [--forbid-override=<service>]
19
+
[--access-hook=<path>] [--[no-]informative-errors]
20
+
[--inetd |
21
+
[--listen=<host-or-ipaddr>] [--port=<n>]
22
+
[--user=<user> [--group=<group>]]]
23
+
[--log-destination=(stderr|syslog|none)]
24
+
[<directory>...]
25
25
26
26
DESCRIPTION
27
27
-----------
···
32
32
It verifies that the directory has the magic file "git-daemon-export-ok", and
33
33
it will refuse to export any Git directory that hasn't explicitly been marked
34
34
for export this way (unless the `--export-all` parameter is specified). If you
35
-
pass some directory paths as 'git daemon' arguments, the offers are limited to
35
+
pass some directory paths as `git daemon` arguments, the offers are limited to
36
36
repositories within those directories.
37
37
38
38
By default, only `upload-pack` service is enabled, which serves
39
-
'git fetch-pack' and 'git ls-remote' clients, which are invoked
40
-
from 'git fetch', 'git pull', and 'git clone'.
39
+
`git fetch-pack` and `git ls-remote` clients, which are invoked
40
+
from `git fetch`, `git pull`, and `git clone`.
41
41
42
42
This is ideally suited for read-only updates, i.e., pulling from
43
43
Git repositories.
44
44
45
-
An `upload-archive` also exists to serve 'git archive'.
45
+
An `upload-archive` also exists to serve `git archive`.
46
46
47
47
OPTIONS
48
48
-------
49
-
--strict-paths::
49
+
`--strict-paths`::
50
50
Match paths exactly (i.e. don't allow "/foo/repo" when the real path is
51
51
"/foo/repo.git" or "/foo/repo/.git") and don't do user-relative paths.
52
-
'git daemon' will refuse to start when this option is enabled and no
52
+
`git daemon` will refuse to start when this option is enabled and no
53
53
directory arguments are provided.
54
54
55
-
--base-path=<path>::
55
+
`--base-path=<path>`::
56
56
Remap all the path requests as relative to the given path.
57
-
This is sort of "Git root" - if you run 'git daemon' with
58
-
'--base-path=/srv/git' on example.com, then if you later try to pull
59
-
'git://example.com/hello.git', 'git daemon' will interpret the path
60
-
as `/srv/git/hello.git`.
57
+
This is sort of "Git root" - if you run `git daemon` with
58
+
`--base-path=/srv/git` on `example.com`, then if you later try
59
+
to pull from `git://example.com/hello.git`, `git daemon` will
60
+
interpret the path as `/srv/git/hello.git`.
61
61
62
-
--base-path-relaxed::
63
-
If --base-path is enabled and repo lookup fails, with this option
64
-
'git daemon' will attempt to lookup without prefixing the base path.
65
-
This is useful for switching to --base-path usage, while still
62
+
`--base-path-relaxed`::
63
+
If `--base-path` is enabled and repo lookup fails, with this option
64
+
`git daemon` will attempt to lookup without prefixing the base path.
65
+
This is useful for switching to `--base-path` usage, while still
66
66
allowing the old paths.
67
67
68
-
--interpolated-path=<pathtemplate>::
68
+
`--interpolated-path=<pathtemplate>`::
69
69
To support virtual hosting, an interpolated path template can be
70
70
used to dynamically construct alternate paths. The template
71
-
supports %H for the target hostname as supplied by the client but
72
-
converted to all lowercase, %CH for the canonical hostname,
73
-
%IP for the server's IP address, %P for the port number,
74
-
and %D for the absolute path of the named repository.
71
+
supports `%H` for the target hostname as supplied by the client but
72
+
converted to all lowercase, `%CH` for the canonical hostname,
73
+
`%IP` for the server's IP address, `%P` for the port number,
74
+
and `%D` for the absolute path of the named repository.
75
75
After interpolation, the path is validated against the directory
76
76
list.
77
77
78
-
--export-all::
78
+
`--export-all`::
79
79
Allow pulling from all directories that look like Git repositories
80
80
(have the 'objects' and 'refs' subdirectories), even if they
81
-
do not have the 'git-daemon-export-ok' file.
81
+
do not have the `git-daemon-export-ok` file.
82
82
83
-
--inetd::
84
-
Have the server run as an inetd service. Implies --syslog (may be
85
-
overridden with `--log-destination=`).
86
-
Incompatible with --detach, --port, --listen, --user and --group
87
-
options.
83
+
`--inetd`::
84
+
Have the server run as an inetd service. Implies `--syslog` (may
85
+
be overridden with `--log-destination=`).
86
+
Incompatible with `--detach`, `--port`, `--listen`, `--user` and
87
+
`--group` options.
88
88
89
-
--listen=<host-or-ipaddr>::
89
+
`--listen=<host-or-ipaddr>`::
90
90
Listen on a specific IP address or hostname. IP addresses can
91
91
be either an IPv4 address or an IPv6 address if supported. If IPv6
92
-
is not supported, then --listen=<hostname> is also not supported and
93
-
--listen must be given an IPv4 address.
92
+
is not supported, then `--listen=<hostname>` is also not supported
93
+
and `--listen` must be given an IPv4 address.
94
94
Can be given more than once.
95
95
Incompatible with `--inetd` option.
96
96
97
-
--port=<n>::
97
+
`--port=<n>`::
98
98
Listen on an alternative port. Incompatible with `--inetd` option.
99
99
100
-
--init-timeout=<n>::
100
+
`--init-timeout=<n>`::
101
101
Timeout (in seconds) between the moment the connection is established
102
102
and the client request is received (typically a rather low value, since
103
103
that should be basically immediate).
104
104
105
-
--timeout=<n>::
105
+
`--timeout=<n>`::
106
106
Timeout (in seconds) for specific client sub-requests. This includes
107
107
the time it takes for the server to process the sub-request and the
108
108
time spent waiting for the next client's request.
109
109
110
-
--max-connections=<n>::
110
+
`--max-connections=<n>`::
111
111
Maximum number of concurrent clients, defaults to 32. Set it to
112
112
zero for no limit.
113
113
114
-
--syslog::
114
+
`--syslog`::
115
115
Short for `--log-destination=syslog`.
116
116
117
-
--log-destination=<destination>::
117
+
`--log-destination=<destination>`::
118
118
Send log messages to the specified destination.
119
-
Note that this option does not imply --verbose,
119
+
Note that this option does not imply `--verbose`,
120
120
thus by default only error conditions will be logged.
121
-
The <destination> must be one of:
121
+
The _<destination>_ must be one of:
122
122
+
123
123
--
124
-
stderr::
124
+
`stderr`::
125
125
Write to standard error.
126
126
Note that if `--detach` is specified,
127
127
the process disconnects from the real standard error,
128
128
making this destination effectively equivalent to `none`.
129
-
syslog::
129
+
`syslog`::
130
130
Write to syslog, using the `git-daemon` identifier.
131
-
none::
131
+
`none`::
132
132
Disable all logging.
133
133
--
134
134
+
135
135
The default destination is `syslog` if `--inetd` or `--detach` is specified,
136
136
otherwise `stderr`.
137
137
138
-
--user-path::
139
-
--user-path=<path>::
138
+
`--user-path`::
139
+
`--user-path=<path>`::
140
140
Allow {tilde}user notation to be used in requests. When
141
141
specified with no parameter, a request to
142
142
git://host/{tilde}alice/foo is taken as a request to access
···
145
145
taken as a request to access `<path>/foo` repository in
146
146
the home directory of user `alice`.
147
147
148
-
--verbose::
148
+
`--verbose`::
149
149
Log details about the incoming connections and requested files.
150
150
151
-
--reuseaddr::
152
-
Use SO_REUSEADDR when binding the listening socket.
151
+
`--reuseaddr`::
152
+
Use `SO_REUSEADDR` when binding the listening socket.
153
153
This allows the server to restart without waiting for
154
154
old connections to time out.
155
155
156
-
--detach::
157
-
Detach from the shell. Implies --syslog.
156
+
`--detach`::
157
+
Detach from the shell. Implies `--syslog`.
158
158
159
-
--pid-file=<file>::
160
-
Save the process id in 'file'. Ignored when the daemon
159
+
`--pid-file=<file>`::
160
+
Save the process id in _<file>_. Ignored when the daemon
161
161
is run under `--inetd`.
162
162
163
-
--user=<user>::
164
-
--group=<group>::
163
+
`--user=<user>`::
164
+
`--group=<group>`::
165
165
Change daemon's uid and gid before entering the service loop.
166
166
When only `--user` is given without `--group`, the
167
167
primary group ID for the user is used. The values of
···
170
170
+
171
171
Giving these options is an error when used with `--inetd`; use
172
172
the facility of inet daemon to achieve the same before spawning
173
-
'git daemon' if needed.
173
+
`git daemon` if needed.
174
174
+
175
175
Like many programs that switch user id, the daemon does not reset
176
-
environment variables such as `$HOME` when it runs git programs,
176
+
environment variables such as `HOME` when it runs git programs,
177
177
e.g. `upload-pack` and `receive-pack`. When using this option, you
178
178
may also want to set and export `HOME` to point at the home
179
-
directory of `<user>` before starting the daemon, and make sure any
180
-
Git configuration files in that directory are readable by `<user>`.
179
+
directory of _<user>_ before starting the daemon, and make sure any
180
+
Git configuration files in that directory are readable by _<user>_.
181
181
182
-
--enable=<service>::
183
-
--disable=<service>::
182
+
`--enable=<service>`::
183
+
`--disable=<service>`::
184
184
Enable/disable the service site-wide per default. Note
185
185
that a service disabled site-wide can still be enabled
186
186
per repository if it is marked overridable and the
187
187
repository enables the service with a configuration
188
188
item.
189
189
190
-
--allow-override=<service>::
191
-
--forbid-override=<service>::
190
+
`--allow-override=<service>`::
191
+
`--forbid-override=<service>`::
192
192
Allow/forbid overriding the site-wide default with per
193
193
repository configuration. By default, all the services
194
194
may be overridden.
195
195
196
-
--[no-]informative-errors::
196
+
`--informative-errors`::
197
+
`--no-informative-errors`::
197
198
When informative errors are turned on, git-daemon will report
198
199
more verbose errors to the client, differentiating conditions
199
200
like "no such repository" from "repository not exported". This
200
201
is more convenient for clients, but may leak information about
201
202
the existence of unexported repositories. When informative
202
203
errors are not enabled, all errors report "access denied" to the
203
-
client. The default is --no-informative-errors.
204
+
client. The default is `--no-informative-errors`.
204
205
205
-
--access-hook=<path>::
206
+
`--access-hook=<path>`::
206
207
Every time a client connects, first run an external command
207
208
specified by the <path> with service name (e.g. "upload-pack"),
208
-
path to the repository, hostname (%H), canonical hostname
209
-
(%CH), IP address (%IP), and TCP port (%P) as its command-line
209
+
path to the repository, hostname (`%H`), canonical hostname
210
+
(`%CH`), IP address (`%IP`), and TCP port (`%P`) as its command-line
210
211
arguments. The external command can decide to decline the
211
212
service by exiting with a non-zero status (or to allow it by
212
213
exiting with a zero status). It can also look at the $REMOTE_ADDR
···
217
218
standard output to be sent to the requestor as an error message when
218
219
it declines the service.
219
220
220
-
<directory>::
221
+
_<directory>_::
221
222
The remaining arguments provide a list of directories. If any
222
223
directories are specified, then the `git-daemon` process will
223
224
serve a requested directory only if it is contained in one of
···
229
230
230
231
These services can be globally enabled/disabled using the
231
232
command-line options of this command. If finer-grained
232
-
control is desired (e.g. to allow 'git archive' to be run
233
+
control is desired (e.g. to allow `git archive` to be run
233
234
against only in a few selected repositories the daemon serves),
234
235
the per-repository configuration file can be used to enable or
235
236
disable them.
236
237
237
238
upload-pack::
238
-
This serves 'git fetch-pack' and 'git ls-remote'
239
+
This serves `git fetch-pack` and `git ls-remote`
239
240
clients. It is enabled by default, but a repository can
240
241
disable it by setting `daemon.uploadpack` configuration
241
242
item to `false`.
242
243
243
244
upload-archive::
244
-
This serves 'git archive --remote'. It is disabled by
245
+
This serves `git archive --remote`. It is disabled by
245
246
default, but a repository can enable it by setting
246
247
`daemon.uploadarch` configuration item to `true`.
247
248
248
249
receive-pack::
249
-
This serves 'git send-pack' clients, allowing anonymous
250
+
This serves `git send-pack` clients, allowing anonymous
250
251
push. It is disabled by default, as there is _no_
251
252
authentication in the protocol (in other words, anybody
252
253
can push anything into the repository, including removal
···
300
301
301
302
302
303
'git daemon' as regular daemon for virtual hosts::
303
-
To set up 'git daemon' as a regular, non-inetd service that
304
+
To set up `git daemon` as a regular, non-inetd service that
304
305
handles repositories for multiple virtual hosts based on
305
306
their IP addresses, start the daemon like this:
306
307
+
···
317
318
they correspond to these IP addresses.
318
319
319
320
selectively enable/disable services per repository::
320
-
To enable 'git archive --remote' and disable 'git fetch' against
321
+
To enable `git archive --remote` and disable `git fetch` against
321
322
a repository, have the following in the configuration file in the
322
323
repository (that is the file 'config' next to `HEAD`, 'refs' and
323
324
'objects').
···
331
332
332
333
ENVIRONMENT
333
334
-----------
334
-
'git daemon' will set REMOTE_ADDR to the IP address of the client
335
-
that connected to it, if the IP address is available. REMOTE_ADDR will
335
+
`git daemon` will set `REMOTE_ADDR` to the IP address of the client
336
+
that connected to it, if the IP address is available. `REMOTE_ADDR` will
336
337
be available in the environment of hooks called when
337
338
services are performed.
338
339