Annotation of mandoc/man.cgi.8, Revision 1.14
1.14 ! schwarze 1: .\" $Id: man.cgi.8,v 1.13 2015/11/05 20:55:41 schwarze Exp $
1.1 schwarze 2: .\"
1.14 ! 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.13 schwarze 17: .Dd $Mdocdate: November 5 2015 $
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.4 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.11 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.4 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.4 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.4 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.4 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 .
163: When using
1.12 schwarze 164: .Ox
165: .Xr httpd 8
166: or
1.1 schwarze 167: .Xr nginx 8 ,
168: the
169: .Xr slowcgi 8
170: proxy daemon is needed to translate FastCGI requests to plain old CGI.
1.6 schwarze 171: .Pp
172: To compile
173: .Nm ,
174: first copy
175: .Pa cgi.h.example
176: to
177: .Pa cgi.h
178: and edit it according to your needs.
179: It contains the following compile-time definitions:
180: .Bl -tag -width Ds
181: .It Ev COMPAT_OLDURI
182: Only useful for running on www.openbsd.org to deal with old URIs containing
183: .Qq "manpath=OpenBSD "
184: where the blank character has to be translated to a hyphen.
185: When compiling for other sites, this definition can be deleted.
186: .It Ev CSS_DIR
187: An optional path to the directory containing the CSS files,
188: to be specified relative to the server's document root,
189: and to be specified without a trailing slash.
190: When not specified, the CSS files
191: are assumed to be in the document root.
192: This is used in generated HTML code.
193: .It Ev CUSTOMIZE_TITLE
1.13 schwarze 194: An ASCII string to be used for the HTML <TITLE> element.
1.8 schwarze 195: .It Ev HTTP_HOST
196: The FQDN of the (possibly virtual) host the HTTP server is running on.
197: This is used for
198: .Ic Location:
199: headers in HTTP 303 responses.
1.6 schwarze 200: .It Ev MAN_DIR
201: A path to the
202: .Nm
203: data directory to be used instead of
204: .Pa /var/www/man ,
205: relative to the web server
206: .Xr chroot 2
207: directory, to be specified without a trailing slash.
208: This is prepended to the manpath when opening
209: .Xr mandoc.db 5
210: and manual page files.
211: .El
212: .Pp
213: After editing
214: .Pa cgi.h ,
215: run
216: .Pp
217: .Dl make man.cgi
218: .Pp
219: and copy the files to the proper locations.
220: Reading the
221: .Cm installcgi
222: target in the
223: .Pa Makefile
224: can help with that, but do not run it without carefully checking it
225: because the directory layouts of web servers vary greatly.
1.1 schwarze 226: .Ss URI interface
227: .Nm
228: uniform resource identifiers are not needed for interactive use,
229: but can be useful for deep linking.
230: They consist of:
231: .Bl -enum
232: .It
233: The
234: .Cm http://
235: protocol specifier.
236: .It
237: The host name and a following slash.
238: .It
239: The path to the program, normally
240: .Pa cgi-bin/man.cgi/ .
1.14 ! schwarze 241: On
! 242: .Lk http://man.openbsd.org/ ,
! 243: .Xr httpd 8
! 244: is configured such that the path to the program can be omitted.
1.1 schwarze 245: .It
1.4 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.14 ! 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.4 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.4 schwarze 259: .Pa ?manpath=OpenBSD-current&query=mandoc .
1.1 schwarze 260: Supported keys are
261: .Cm manpath ,
1.4 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.4 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.4 schwarze 278: .Cm sektion
1.1 schwarze 279: is supported as an alias for
280: .Cm sec .
281: .El
1.9 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
307: In particular, this applies to the
308: .Ev SCRIPT_NAME ,
309: to all manpaths, and to all architecture names.
1.1 schwarze 310: .Sh ENVIRONMENT
311: The web server may pass the following CGI variables to
312: .Nm :
313: .Bl -tag -width Ds
314: .It Ev PATH_INFO
315: The final part of the URI path passed from the client to the server,
316: starting after the
317: .Ev SCRIPT_NAME
318: and ending before the
319: .Ev QUERY_STRING .
320: It is used by the
321: .Cm show
1.10 schwarze 322: page to acquire the manpath and filename it needs.
1.1 schwarze 323: .It Ev QUERY_STRING
324: The HTTP query string passed from the client to the server.
325: It is the final part of the URI, after the question mark.
326: It is used by the
327: .Cm search
328: page to acquire the named parameters it needs.
329: .It Ev SCRIPT_NAME
330: The path to the
331: .Nm
332: binary relative to the server root, usually
333: .Pa /cgi-bin/man.cgi .
334: This is used for generating URIs to be embedded
335: in generated HTML code and HTTP headers.
1.9 schwarze 336: If this contains any character not contained in the
337: .Sx Restricted character set ,
338: .Nm
339: reports an internal server error and exits without doing anything.
1.1 schwarze 340: .El
341: .Sh FILES
342: .Bl -tag -width Ds
343: .It Pa /var/www
344: Default web server
345: .Xr chroot 2
346: directory.
347: All the following paths are specified relative to this directory.
348: .It Pa /cgi-bin/man.cgi
349: The path to the
350: .Nm
351: program relative to the server root.
352: Can be overridden by
353: .Ev SCRIPT_NAME .
354: .It Pa /htdocs
355: The path to the server document root relative to the server root.
356: This is part of the web server configuration and not specific to
357: .Nm .
1.12 schwarze 358: .It Pa /htdocs/mandoc.css
1.1 schwarze 359: A style sheet for
360: .Xr mandoc 1
1.12 schwarze 361: HTML styling, referenced from each generated HTML page.
1.1 schwarze 362: .It Pa /man
363: Default
364: .Nm
365: data directory containing all the manual trees.
366: Can be overridden by
367: .Ev MAN_DIR .
1.5 schwarze 368: .It Pa /man/mandoc/man1/apropos.1 , /man/mandoc/man8/man.cgi.8
369: Manual pages documenting
370: .Nm
371: itself, linked from the index page.
1.1 schwarze 372: .It Pa /man/manpath.conf
373: The list of available manpaths, one per line.
1.9 schwarze 374: If any of the lines in this file contains a slash
375: .Pq Sq /
376: or any character not contained in the
377: .Sx Restricted character set ,
378: .Nm
379: reports an internal server error and exits without doing anything.
1.13 schwarze 380: .It Pa /man/header.html
381: An optional file containing static HTML code to be inserted right
382: after opening the <BODY> element.
383: .It Pa /man/footer.html
384: An optional file containing static HTML code to be inserted right
385: before closing the <BODY> element.
1.1 schwarze 386: .It Pa /man/OpenBSD-current/man1/mandoc.1
387: An example
388: .Xr mdoc 7
389: source file located below the
390: .Dq OpenBSD-current
391: manpath.
1.4 schwarze 392: .El
1.1 schwarze 393: .Sh COMPATIBILITY
394: The
395: .Nm
396: CGI program is call-compatible with queries from the traditional
397: .Pa man.cgi
398: script by Wolfram Schneider.
1.4 schwarze 399: However, the output may not be quite the same.
1.1 schwarze 400: .Sh SEE ALSO
401: .Xr apropos 1 ,
402: .Xr mandoc.db 5 ,
403: .Xr makewhatis 8 ,
404: .Xr slowcgi 8
1.2 schwarze 405: .Sh HISTORY
406: A version of
407: .Nm
408: based on
409: .Xr mandoc 1
410: first appeared in mdocml-1.12.1 (March 2012).
411: The current SQLite3-based version first appeared in
412: .Ox 5.6 .
1.1 schwarze 413: .Sh AUTHORS
414: .An -nosplit
415: The
416: .Nm
417: program was written by
418: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
419: and ported to the SQLite3-based
420: .Xr mandoc.db 5
421: backend by
422: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
CVSweb