Sun Apr 24 07:17:02 2011 UTC ()
Remove the "This option..." sentence prefix for all option definitions.
Adjust some sentences so that the new text makes sense.  OK mrg@.


(jmmv)
diff -r1.27 -r1.28 src/libexec/httpd/bozohttpd.8

cvs diff -r1.27 -r1.28 src/libexec/httpd/bozohttpd.8 (expand / switch to unified diff)

--- src/libexec/httpd/bozohttpd.8 2011/04/02 07:44:15 1.27
+++ src/libexec/httpd/bozohttpd.8 2011/04/24 07:17:02 1.28
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: bozohttpd.8,v 1.27 2011/04/02 07:44:15 mbalmer Exp $ 1.\" $NetBSD: bozohttpd.8,v 1.28 2011/04/24 07:17:02 jmmv Exp $
2.\" 2.\"
3.\" $eterna: bozohttpd.8,v 1.99 2010/09/20 22:26:28 mrg Exp $ 3.\" $eterna: bozohttpd.8,v 1.99 2010/09/20 22:26:28 mrg Exp $
4.\" 4.\"
5.\" Copyright (c) 1997-2010 Matthew R. Green 5.\" Copyright (c) 1997-2010 Matthew R. Green
6.\" All rights reserved. 6.\" All rights reserved.
7.\" 7.\"
8.\" Redistribution and use in source and binary forms, with or without 8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions 9.\" modification, are permitted provided that the following conditions
10.\" are met: 10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright 11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer. 12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in the 14.\" notice, this list of conditions and the following disclaimer in the
@@ -16,27 +16,27 @@ @@ -16,27 +16,27 @@
16.\" 16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 22.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE. 27.\" SUCH DAMAGE.
28.\" 28.\"
29.Dd April 2, 2011 29.Dd April 23, 2011
30.Dt HTTPD 8 30.Dt HTTPD 8
31.Os 31.Os
32.Sh NAME 32.Sh NAME
33.Nm httpd 33.Nm httpd
34.Nd hyper text transfer protocol version 1.1 daemon 34.Nd hyper text transfer protocol version 1.1 daemon
35.Sh SYNOPSIS 35.Sh SYNOPSIS
36.Nm 36.Nm
37.Op Fl befHnrsuVX 37.Op Fl befHnrsuVX
38.Op Fl C Ar suffix cgihandler 38.Op Fl C Ar suffix cgihandler
39.Op Fl c Ar cgibin 39.Op Fl c Ar cgibin
40.Op Fl I Ar port 40.Op Fl I Ar port
41.Op Fl i Ar address 41.Op Fl i Ar address
42.Op Fl M Ar suffix type encoding encoding11 42.Op Fl M Ar suffix type encoding encoding11
@@ -69,226 +69,226 @@ option for virtual hosting.) @@ -69,226 +69,226 @@ option for virtual hosting.)
69.Nm 69.Nm
70writes logs to 70writes logs to
71.Xr syslog 3 71.Xr syslog 3
72using the ftp facility (but see the 72using the ftp facility (but see the
73.Fl s 73.Fl s
74option for testing.) 74option for testing.)
75.Nm 75.Nm
76is designed to be small, simple and relatively featureless, 76is designed to be small, simple and relatively featureless,
77hopefully increasing its security. 77hopefully increasing its security.
78.Ss OPTIONS 78.Ss OPTIONS
79The following options are available: 79The following options are available:
80.Bl -tag -width xxxcgibin 80.Bl -tag -width xxxcgibin
81.It Fl b 81.It Fl b
82This option enables daemon mode, where 82Enables daemon mode, where
83.Nm 83.Nm
84detaches from the current terminal, running in the background and 84detaches from the current terminal, running in the background and
85servicing HTTP requests. 85servicing HTTP requests.
86.It Fl C Ar suffix cgihandler 86.It Fl C Ar suffix cgihandler
87This option adds a new CGI handler program for a particular file type. 87Adds a new CGI handler program for a particular file type.
88The 88The
89.Ar suffix 89.Ar suffix
90should be any normal file suffix, and the 90should be any normal file suffix, and the
91.Ar cgihandler 91.Ar cgihandler
92should be a full path to an interpreter. 92should be a full path to an interpreter.
93This option is the only way to enable CGI programs that exist 93This option is the only way to enable CGI programs that exist
94outside of the cgibin directory to be executed. 94outside of the cgibin directory to be executed.
95Multiple 95Multiple
96.Fl C 96.Fl C
97options may be passed. 97options may be passed.
98.It Fl c Ar cgibin 98.It Fl c Ar cgibin
99This option enables the CGI/1.1 interface. 99Enables the CGI/1.1 interface.
100The 100The
101.Ar cgibin 101.Ar cgibin
102directory is expected to contain the CGI programs to be used. 102directory is expected to contain the CGI programs to be used.
103.Nm 103.Nm
104looks for URL's in the form of 104looks for URL's in the form of
105.Em /cgi-bin/\*[Lt]scriptname\*[Gt] 105.Em /cgi-bin/\*[Lt]scriptname\*[Gt]
106where 106where
107.Aq scriptname 107.Aq scriptname
108is a valid CGI program in the 108is a valid CGI program in the
109.Ar cgibin 109.Ar cgibin
110directory. 110directory.
111In other words, all CGI URL's must begin with 111In other words, all CGI URL's must begin with
112.Em \%/cgi-bin/ . 112.Em \%/cgi-bin/ .
113Note that the CGI/1.1 interface is not available with 113Note that the CGI/1.1 interface is not available with
114.Em ~user 114.Em ~user
115translation. 115translation.
116.It Fl e 116.It Fl e
117This option causes 117Causes
118.Nm 118.Nm
119to not clear the environment when used with either the 119to not clear the environment when used with either the
120.Fl t 120.Fl t
121or 121or
122.Fl U 122.Fl U
123options. 123options.
124.It Fl f 124.It Fl f
125This option stops the 125Stops the
126.Fl b 126.Fl b
127flag from 127flag from
128.Nm 128.Nm
129detaching from the tty and going into the background. 129detaching from the tty and going into the background.
130.It Fl H 130.It Fl H
131This option causes directory index mode to hide files and directories 131Causes directory index mode to hide files and directories
132that start with a period, except for 132that start with a period, except for
133.Pa .. . 133.Pa .. .
134Also see 134Also see
135.Fl X . 135.Fl X .
136.It Fl I Ar port 136.It Fl I Ar port
137This option is only valid with the 137Causes
138.Fl b 
139option. 
140It causes 
141.Ar port 138.Ar port
142to use used as the port to bind daemon mode. 139to use used as the port to bind daemon mode.
143The default is the 140The default is the
144.Dq http 141.Dq http
145port. 142port.
146.It Fl i Ar address 
147This option is only valid with the 143This option is only valid with the
148.Fl b 144.Fl b
149option. 145option.
150It causes 146.It Fl i Ar address
 147Causes
151.Ar address 148.Ar address
152to use used as the address to bind daemon mode. 149to use used as the address to bind daemon mode.
153If otherwise unspecified, the address used to bind is derived from the 150If otherwise unspecified, the address used to bind is derived from the
154.Ar myname , 151.Ar myname ,
155which defaults to the name returned by 152which defaults to the name returned by
156.Xr gethostname 3 . 153.Xr gethostname 3 .
157Only the last 154Only the last
158.Fl i 155.Fl i
159option is used. 156option is used.
 157This option is only valid with the
 158.Fl b
 159option.
160.It Fl M Ar suffix type encoding encoding11 160.It Fl M Ar suffix type encoding encoding11
161This option adds a new entry to the table that converts file suffixes to 161Adds a new entry to the table that converts file suffixes to
162content type and encoding. 162content type and encoding.
163This option takes four additional arguments containing 163This option takes four additional arguments containing
164the file prefix, its 164the file prefix, its
165.Dq Content-Type , 165.Dq Content-Type ,
166.Dq Content-Encoding , 166.Dq Content-Encoding ,
167and 167and
168.Dq Content-Encoding 168.Dq Content-Encoding
169for HTTP/1.1 connections, respectively. 169for HTTP/1.1 connections, respectively.
170If any of these are a single dash 170If any of these are a single dash
171.Pq Dq - , 171.Pq Dq - ,
172the empty string is used instead. 172the empty string is used instead.
173Multiple 173Multiple
174.Fl M 174.Fl M
175options may be passed. 175options may be passed.
176.It Fl n 176.It Fl n
177This option stops 177Stops
178.Nm 178.Nm
179from doing IP address to name resolution of hosts for setting the 179from doing IP address to name resolution of hosts for setting the
180.Ev REMOTE_HOST 180.Ev REMOTE_HOST
181variable before running a CGI program. 181variable before running a CGI program.
182This option has no effect without the 182This option has no effect without the
183.Fl c 183.Fl c
184option. 184option.
185.It Fl P Ar pidfile 185.It Fl P Ar pidfile
186This option causes 186Causes
187.Nm 187.Nm
188to create a pid file in 188to create a pid file in
189.Ar pidfile 189.Ar pidfile
190when run in daemon mode with the 190when run in daemon mode with the
191.Fl b 191.Fl b
192option. 192option.
193.It Fl p Ar pubdir 193.It Fl p Ar pubdir
194This option changes the default user directory for 194Changes the default user directory for
195.Em /~user/ 195.Em /~user/
196translations from 196translations from
197.Dq public_html 197.Dq public_html
198to 198to
199.Ar pubdir . 199.Ar pubdir .
200.It Fl r 200.It Fl r
201This option forces pages besides the 201Forces pages besides the
202.Dq index.html 202.Dq index.html
203(see the 203(see the
204.Fl X 204.Fl X
205option) page to require that the Referrer: header be present and 205option) page to require that the Referrer: header be present and
206refer to this web server, otherwise a redirect to the 206refer to this web server, otherwise a redirect to the
207.Dq index.html 207.Dq index.html
208page will be returned instead. 208page will be returned instead.
209.It Fl S Ar server_software 209.It Fl S Ar server_software
210This option sets the internal server version to 210Sets the internal server version to
211.Ar server_software . 211.Ar server_software .
212.It Fl s 212.It Fl s
213This option forces logging to be set to stderr always. 213Forces logging to be set to stderr always.
214.It Fl t Ar chrootdir 214.It Fl t Ar chrootdir
215When this option is used, 215Makes
216.Nm 216.Nm
217will chroot to the specified directory 217chroot to the specified directory
218before answering requests. 218before answering requests.
219Every other path should be specified relative 219Every other path should be specified relative
220to the new root, if this option is used. 220to the new root, if this option is used.
221Note that the current environment 221Note that the current environment
222is normally replaced with an empty environment with this option, unless the 222is normally replaced with an empty environment with this option, unless the
223.Fl e 223.Fl e
224option is also used. 224option is also used.
225.It Fl U Ar username 225.It Fl U Ar username
226This option causes 226Causes
227.Nm 227.Nm
228to switch to the user and the groups of 228to switch to the user and the groups of
229.Ar username 229.Ar username
230after initialization. 230after initialization.
231This option, like 231This option, like
232.Fl t 232.Fl t
233above, causes 233above, causes
234.Nm 234.Nm
235to clear the environment unless the 235to clear the environment unless the
236.Fl e 236.Fl e
237option is given. 237option is given.
238.It Fl u 238.It Fl u
239This option enables the transformation of Uniform Resource Locators of 239Enables the transformation of Uniform Resource Locators of
240the form 240the form
241.Em /~user/ 241.Em /~user/
242into the directory 242into the directory
243.Pa ~user/public_html 243.Pa ~user/public_html
244(but see the 244(but see the
245.Fl p 245.Fl p
246option above). 246option above).
247.It Fl V 247.It Fl V
248This option sets the default virtual host directory to 248Sets the default virtual host directory to
249.Ar slashdir . 249.Ar slashdir .
250If no directory exists in 250If no directory exists in
251.Ar virtualroot 251.Ar virtualroot
252for the request, then 252for the request, then
253.Ar slashdir 253.Ar slashdir
254will be used. 254will be used.
255The default behaviour is to return 404 (Not Found.) 255The default behaviour is to return 404 (Not Found.)
256.It Fl v Ar virtualroot 256.It Fl v Ar virtualroot
257This option enables virtual hosting support. 257Enables virtual hosting support.
258Directories in 258Directories in
259.Ar virtualroot 259.Ar virtualroot
260will be searched for a matching virtual host name, when parsing 260will be searched for a matching virtual host name, when parsing
261the HTML request. 261the HTML request.
262If a matching name is found, it will be used 262If a matching name is found, it will be used
263as both the server's real name, 263as both the server's real name,
264.Op Ar myname , 264.Op Ar myname ,
265and as the 265and as the
266.Ar slashdir . 266.Ar slashdir .
267See the 267See the
268.Sx EXAMPLES 268.Sx EXAMPLES
269section for an example of using this option. 269section for an example of using this option.
270.It Fl X 270.It Fl X
271This option enables directory indexing. 271Enables directory indexing.
272A directory index will be generated only when the default file (i.e. 272A directory index will be generated only when the default file (i.e.
273.Pa index.html 273.Pa index.html
274normally) is not present. 274normally) is not present.
275.It Fl x Ar index 275.It Fl x Ar index
276This option changes the default file read for directories from 276Changes the default file read for directories from
277.Dq index.html 277.Dq index.html
278to 278to
279.Ar index . 279.Ar index .
280.It Fl Z Ar certificate_path privatekey_path 280.It Fl Z Ar certificate_path privatekey_path
281This option sets the path to the server certificate file and the private key file 281Sets the path to the server certificate file and the private key file
282in pem format. 282in pem format.
283It also causes 283It also causes
284.Nm 284.Nm
285to start SSL mode. 285to start SSL mode.
286.El 286.El
287.Pp 287.Pp
288Note that in 288Note that in
289.Nm 289.Nm
290versions 20031005 and prior that supported the 290versions 20031005 and prior that supported the
291.Fl C 291.Fl C
292and 292and
293.Fl M 293.Fl M
294options, they took a single space-separated argument that was parsed. 294options, they took a single space-separated argument that was parsed.