=================================================================== RCS file: /cvs/mandoc/man.cgi.8,v retrieving revision 1.15 retrieving revision 1.19 diff -u -p -r1.15 -r1.19 --- mandoc/man.cgi.8 2016/03/18 13:22:27 1.15 +++ mandoc/man.cgi.8 2016/07/10 10:05:33 1.19 @@ -1,4 +1,4 @@ -.\" $Id: man.cgi.8,v 1.15 2016/03/18 13:22:27 schwarze Exp $ +.\" $Id: man.cgi.8,v 1.19 2016/07/10 10:05:33 schwarze Exp $ .\" .\" Copyright (c) 2014, 2015, 2016 Ingo Schwarze .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 18 2016 $ +.Dd $Mdocdate: July 10 2016 $ .Dt MAN.CGI 8 .Os .Sh NAME @@ -26,9 +26,9 @@ The CGI program searches for manual pages on a WWW server and displays them to HTTP clients, providing functionality equivalent to the -.Xr apropos 1 -and .Xr man 1 +and +.Xr apropos 1 utilities. It can use multiple manual trees in parallel. .Ss HTML search interface @@ -51,20 +51,15 @@ The effect of prepending a backslash to another charac in the current implementation, it has no effect. .It A -.Dq Submit -button to send a search request from the client to the server. -.It -A -.Dq Reset -button to undo any changes to the input boxes and the dropdown menus -and reset them to the values contained in the -.Ev QUERY_STRING . -.It -Radio buttons to select pages either by name like in .Xr man 1 -or using +submit button. +The string in the input box is interpreted as the name of a manual page. +.It +An .Xr apropos 1 -queries. +submit button. +The string in the input box is interpreted as a search +.Ar expression . .It A dropdown menu to optionally select a manual section. If one is provided, it has the same effect as the @@ -162,9 +157,7 @@ Configure your web server to execute CGI programs loca .Pa /cgi-bin . When using .Ox -.Xr httpd 8 -or -.Xr nginx 8 , +.Xr httpd 8 , the .Xr slowcgi 8 proxy daemon is needed to translate FastCGI requests to plain old CGI. @@ -227,13 +220,16 @@ run .Pp .Dl make man.cgi .Pp -and copy the files to the proper locations. -Reading the -.Cm installcgi -target in the -.Pa Makefile -can help with that, but do not run it without carefully checking it -because the directory layouts of web servers vary greatly. +and copy the resulting binary to the proper location, +for example using the command: +.Pp +.Dl make installcgi +.Pp +In addition to that, make sure the default manpath contains the files +.Pa man1/apropos.1 +and +.Pa man8/man.cgi.8 , +or the documentation links at the bottom of the index page will not work. .Ss URI interface .Nm uniform resource identifiers are not needed for interactive use, @@ -318,7 +314,7 @@ The web server may pass the following CGI variables to .Nm : .Bl -tag -width Ds .It Ev SCRIPT_NAME -The initial part of the the URI passed from the client to the server, +The initial part of the URI passed from the client to the server, starting after the server's host name and ending before .Ev PATH_INFO . This is ignored by @@ -374,10 +370,6 @@ Default data directory containing all the manual trees. Can be overridden by .Dv MAN_DIR . -.It Pa /man/mandoc/man1/apropos.1 , /man/mandoc/man8/man.cgi.8 -Manual pages documenting -.Nm -itself, linked from the index page. .It Pa /man/manpath.conf The list of available manpaths, one per line. If any of the lines in this file contains a slash