Annotation of src/usr.bin/mandoc/man.cgi.8, Revision 1.15
1.15 ! jmc 1: .\" $OpenBSD: man.cgi.8,v 1.14 2016/03/18 13:21:07 schwarze Exp $
1.1 schwarze 2: .\"
1.13 schwarze 3: .\" Copyright (c) 2014, 2015, 2016 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
8: .\"
9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: .\"
1.14 schwarze 17: .Dd $Mdocdate: March 18 2016 $
1.1 schwarze 18: .Dt MAN.CGI 8
19: .Os
20: .Sh NAME
21: .Nm man.cgi
22: .Nd CGI program to search and display manual pages
23: .Sh DESCRIPTION
24: The
25: .Nm
26: CGI program searches for manual pages on a WWW server
27: and displays them to HTTP clients,
28: providing functionality equivalent to the
29: .Xr apropos 1
30: and
31: .Xr man 1
32: utilities.
33: It can use multiple manual trees in parallel.
34: .Ss HTML search interface
35: At the top of each generated HTML page,
36: .Nm
37: displays a search form containing these elements:
38: .Bl -enum
39: .It
1.2 schwarze 40: An input box for search queries, expecting
41: either a name of a manual page or an
1.1 schwarze 42: .Ar expression
43: using the syntax described in the
44: .Xr apropos 1
45: manual; filling this in is required for each search.
1.10 schwarze 46: .Pp
47: The expression is broken into words at whitespace.
48: Whitespace characters and backslashes can be escaped
49: by prepending a backslash.
50: The effect of prepending a backslash to another character is undefined;
51: in the current implementation, it has no effect.
1.1 schwarze 52: .It
1.2 schwarze 53: A
54: .Dq Submit
55: button to send a search request from the client to the server.
56: .It
57: A
58: .Dq Reset
59: button to undo any changes to the input boxes and the dropdown menus
60: and reset them to the values contained in the
61: .Ev QUERY_STRING .
62: .It
63: Radio buttons to select pages either by name like in
64: .Xr man 1
65: or using
66: .Xr apropos 1
67: queries.
68: .It
69: A dropdown menu to optionally select a manual section.
1.1 schwarze 70: If one is provided, it has the same effect as the
1.2 schwarze 71: .Xr man 1
72: and
1.1 schwarze 73: .Xr apropos 1
74: .Fl s
75: option.
76: Otherwise, pages from all sections are shown.
77: .It
1.2 schwarze 78: A dropdown menu to optionally select an architecture.
1.1 schwarze 79: If one is provided, it has the same effect as the
1.2 schwarze 80: .Xr man 1
81: and
1.1 schwarze 82: .Xr apropos 1
83: .Fl S
84: option.
85: By default, pages for all architectures are shown.
86: .It
87: A dropdown menu to select a manual tree.
88: If the configuration file
89: .Pa /var/www/man/manpath.conf
90: contains only one manpath, the dropdown menu is not shown.
91: By default, the first manpath given in the file is used.
92: .El
93: .Ss Program output
94: The
95: .Nm
96: program generates five kinds of output pages:
97: .Bl -tag -width Ds
98: .It The index page.
99: This is returned when calling
100: .Nm
101: without
102: .Ev PATH_INFO
103: and without a
104: .Ev QUERY_STRING .
105: It serves as a starting point for using the program
106: and shows the search form only.
107: .It A list page.
108: Lists are returned when searches match more than one manual page.
109: The first column shows the names and section numbers of manuals
110: as clickable links.
111: The second column shows the one-line descriptions of the manuals.
112: .It A manual page.
113: This output format is used when a search matches exactly one
114: manual page, or when a link on a list page or an
115: .Ic \&Xr
116: link on another manual page is followed.
117: .It A no-result page.
118: This is shown when a search request returns no results -
119: eiher because it violates the query syntax, or because
120: the search does not match any manual pages.
121: .It \&An error page.
122: This cannot happen by merely clicking the
123: .Dq Search
124: button, but only by manually entering an invalid URI.
125: It does not show the search form, but only an error message
126: and a link back to the index page.
127: .El
128: .Ss Setup
129: For each manual tree, create one first-level subdirectory below
130: .Pa /var/www/man .
131: The name of one of these directories is called a
132: .Dq manpath
133: in the context of
134: .Nm .
135: Create a single ASCII text file
136: .Pa /var/www/man/manpath.conf
137: containing the names of these directories, one per line.
138: The directory given first is used as the default manpath.
139: .Pp
140: Inside each of these directories, use the same directory and file
141: structure as found below
142: .Pa /usr/share/man ,
143: that is, second-level subdirectories
144: .Pa /var/www/man/*/man1 , /var/www/man/*/man2
145: etc. containing source
146: .Xr mdoc 7
147: and
148: .Xr man 7
149: manuals with file name extensions matching the section numbers,
150: second-level subdirectories
151: .Pa /var/www/man/*/cat1 , /var/www/man/*/cat2
152: etc. containing preformatted manuals with the file name extension
153: .Sq 0 ,
154: and optional third-level subdirectories for architectures.
155: Use
156: .Xr makewhatis 8
157: to create a
158: .Xr mandoc.db 5
159: database inside each manpath.
160: .Pp
161: Configure your web server to execute CGI programs located in
162: .Pa /cgi-bin .
1.4 schwarze 163: .Pp
164: To compile
165: .Nm ,
166: first copy
167: .Pa cgi.h.example
168: to
169: .Pa cgi.h
170: and edit it according to your needs.
171: It contains the following compile-time definitions:
172: .Bl -tag -width Ds
173: .It Ev COMPAT_OLDURI
174: Only useful for running on www.openbsd.org to deal with old URIs containing
175: .Qq "manpath=OpenBSD "
176: where the blank character has to be translated to a hyphen.
177: When compiling for other sites, this definition can be deleted.
1.14 schwarze 178: .It Dv CSS_DIR
179: An optional file system path to the directory containing the file
180: .Pa mandoc.css ,
1.4 schwarze 181: to be specified relative to the server's document root,
182: and to be specified without a trailing slash.
1.14 schwarze 183: When empty, the CSS file is assumed to be in the document root.
184: Otherwise, a leading slash is needed.
1.4 schwarze 185: This is used in generated HTML code.
1.14 schwarze 186: .It Dv CUSTOMIZE_TITLE
1.12 schwarze 187: An ASCII string to be used for the HTML <TITLE> element.
1.14 schwarze 188: .It Dv HTTP_HOST
1.6 schwarze 189: The FQDN of the (possibly virtual) host the HTTP server is running on.
190: This is used for
191: .Ic Location:
192: headers in HTTP 303 responses.
1.14 schwarze 193: .It Dv MAN_DIR
194: A file system path to the
1.4 schwarze 195: .Nm
1.14 schwarze 196: data directory relative to the web server
1.4 schwarze 197: .Xr chroot 2
1.14 schwarze 198: directory, to be specified with a leading slash and without a trailing slash.
199: It needs to have at least one component; the root directory cannot be used
200: for this purpose.
201: The files
202: .Pa manpath.conf ,
203: .Pa header.html ,
204: and
205: .Pa footer.html
206: are looked up in this directory.
207: It is also prepended to the manpath when opening
1.4 schwarze 208: .Xr mandoc.db 5
209: and manual page files.
1.14 schwarze 210: .It Dv SCRIPT_NAME
211: The initial component of URIs, to be specified without leading
212: and trailing slashes.
213: It can be empty.
1.4 schwarze 214: .El
215: .Pp
216: After editing
217: .Pa cgi.h ,
218: run
219: .Pp
220: .Dl make man.cgi
221: .Pp
222: and copy the files to the proper locations.
223: Reading the
224: .Cm installcgi
225: target in the
226: .Pa Makefile
227: can help with that, but do not run it without carefully checking it
228: because the directory layouts of web servers vary greatly.
1.1 schwarze 229: .Ss URI interface
230: .Nm
231: uniform resource identifiers are not needed for interactive use,
232: but can be useful for deep linking.
233: They consist of:
234: .Bl -enum
235: .It
236: The
237: .Cm http://
238: protocol specifier.
239: .It
1.14 schwarze 240: The host name.
1.1 schwarze 241: .It
1.14 schwarze 242: The
243: .Dv SCRIPT_NAME ,
244: preceded by a slash unless empty.
1.1 schwarze 245: .It
1.2 schwarze 246: To show a single page, a slash, the manpath, another slash,
1.1 schwarze 247: and the name of the requested file, for example
248: .Pa /OpenBSD-current/man1/mandoc.1 .
1.13 schwarze 249: This can be abbreviated according to the following syntax:
250: .Sm off
251: .Op / Ar manpath Oo / Cm man Ar sec Oc Op / Ar arch
252: .Pf / Ar name Op \&. Ar sec
253: .Sm on
1.1 schwarze 254: .It
1.2 schwarze 255: For searches, a query string starting with a question mark
1.1 schwarze 256: and consisting of
257: .Ar key Ns = Ns Ar value
258: pairs, separated by ampersands, for example
1.2 schwarze 259: .Pa ?manpath=OpenBSD-current&query=mandoc .
1.1 schwarze 260: Supported keys are
261: .Cm manpath ,
1.2 schwarze 262: .Cm query ,
1.1 schwarze 263: .Cm sec ,
264: .Cm arch ,
265: corresponding to
266: .Xr apropos 1
267: .Fl M ,
268: .Ar expression ,
269: .Fl s ,
270: .Fl S ,
1.2 schwarze 271: respectively, and
272: .Cm apropos ,
273: which is a boolean parameter to select or deselect the
274: .Xr apropos 1
275: query mode.
1.1 schwarze 276: For backward compatibility with the traditional
277: .Nm ,
1.2 schwarze 278: .Cm sektion
1.1 schwarze 279: is supported as an alias for
280: .Cm sec .
281: .El
1.7 schwarze 282: .Ss Restricted character set
283: For security reasons, in particular to prevent cross site scripting
284: attacks, some strings used by
285: .Nm
286: can only contain the following characters:
287: .Pp
288: .Bl -dash -compact -offset indent
289: .It
290: lower case and upper case ASCII letters
291: .It
292: the ten decimal digits
293: .It
294: the dash
295: .Pq Sq -
296: .It
297: the dot
298: .Pq Sq \&.
299: .It
300: the slash
301: .Pq Sq /
302: .It
303: the underscore
304: .Pq Sq _
305: .El
306: .Pp
1.14 schwarze 307: In particular, this applies to all manpaths and architecture names.
1.1 schwarze 308: .Sh ENVIRONMENT
309: The web server may pass the following CGI variables to
310: .Nm :
311: .Bl -tag -width Ds
1.14 schwarze 312: .It Ev SCRIPT_NAME
1.15 ! jmc 313: The initial part of the URI passed from the client to the server,
1.14 schwarze 314: starting after the server's host name and ending before
315: .Ev PATH_INFO .
316: This is ignored by
317: .Nm .
318: When constructing URIs for links and redirections, the
319: .Dv SCRIPT_NAME
320: preprocessor constant is used instead.
1.1 schwarze 321: .It Ev PATH_INFO
322: The final part of the URI path passed from the client to the server,
323: starting after the
324: .Ev SCRIPT_NAME
325: and ending before the
326: .Ev QUERY_STRING .
327: It is used by the
328: .Cm show
1.8 schwarze 329: page to acquire the manpath and filename it needs.
1.1 schwarze 330: .It Ev QUERY_STRING
331: The HTTP query string passed from the client to the server.
332: It is the final part of the URI, after the question mark.
333: It is used by the
334: .Cm search
335: page to acquire the named parameters it needs.
336: .El
337: .Sh FILES
338: .Bl -tag -width Ds
339: .It Pa /var/www
340: Default web server
341: .Xr chroot 2
342: directory.
343: All the following paths are specified relative to this directory.
344: .It Pa /cgi-bin/man.cgi
1.14 schwarze 345: The usual file system path to the
1.1 schwarze 346: .Nm
1.14 schwarze 347: program inside the web server
348: .Xr chroot 2
349: directory.
350: A different name can be chosen, but in any case, it needs to be configured in
351: .Xr httpd.conf 5 .
1.1 schwarze 352: .It Pa /htdocs
1.14 schwarze 353: The file system path to the server document root directory
354: relative to the server
355: .Xr chroot 2
356: directory.
1.1 schwarze 357: This is part of the web server configuration and not specific to
358: .Nm .
1.11 schwarze 359: .It Pa /htdocs/mandoc.css
1.1 schwarze 360: A style sheet for
361: .Xr mandoc 1
1.11 schwarze 362: HTML styling, referenced from each generated HTML page.
1.1 schwarze 363: .It Pa /man
364: Default
365: .Nm
366: data directory containing all the manual trees.
367: Can be overridden by
1.14 schwarze 368: .Dv MAN_DIR .
1.3 schwarze 369: .It Pa /man/mandoc/man1/apropos.1 , /man/mandoc/man8/man.cgi.8
370: Manual pages documenting
371: .Nm
372: itself, linked from the index page.
1.1 schwarze 373: .It Pa /man/manpath.conf
374: The list of available manpaths, one per line.
1.7 schwarze 375: If any of the lines in this file contains a slash
376: .Pq Sq /
377: or any character not contained in the
378: .Sx Restricted character set ,
379: .Nm
380: reports an internal server error and exits without doing anything.
1.12 schwarze 381: .It Pa /man/header.html
382: An optional file containing static HTML code to be inserted right
383: after opening the <BODY> element.
384: .It Pa /man/footer.html
385: An optional file containing static HTML code to be inserted right
386: before closing the <BODY> element.
1.1 schwarze 387: .It Pa /man/OpenBSD-current/man1/mandoc.1
388: An example
389: .Xr mdoc 7
390: source file located below the
391: .Dq OpenBSD-current
392: manpath.
1.2 schwarze 393: .El
1.1 schwarze 394: .Sh COMPATIBILITY
395: The
396: .Nm
397: CGI program is call-compatible with queries from the traditional
398: .Pa man.cgi
399: script by Wolfram Schneider.
1.2 schwarze 400: However, the output may not be quite the same.
1.1 schwarze 401: .Sh SEE ALSO
402: .Xr apropos 1 ,
403: .Xr mandoc.db 5 ,
404: .Xr makewhatis 8 ,
405: .Xr slowcgi 8
406: .Sh HISTORY
407: A version of
408: .Nm
409: based on
410: .Xr mandoc 1
411: first appeared in mdocml-1.12.1 (March 2012).
412: The current SQLite3-based version first appeared in
413: .Ox 5.6 .
414: .Sh AUTHORS
415: .An -nosplit
416: The
417: .Nm
418: program was written by
419: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
420: and ported to the SQLite3-based
421: .Xr mandoc.db 5
422: backend by
423: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .