NAME manquery - returns reference manual pages from Eastern Illinois University's
UNIX server to Web clients. SYNOPSIS
<A HREF='[http://www.eiu.edu]/cgi-bin/manquery[?[<filename>]+[options]]'>...</a>
where <filename> is an executable command composed of any alphanumeric,
_ (underscore), - (hyphen), : (colon), () (parentheses), or . (period)
characters, and where 'options' includes any order of the characters [+A-Z].
Brackets [] are used in this document to denote optional values and are
not used in the actual syntax. AVAILABILITY
http://www.eiu.edu
DESCRIPTION manquery has both search and browse capabilities. The script's search
function accepts either a query string from an external, filename-appended
URL address or standard input from an internal HTML form and returns any
matching manual pages. The script's browse function provides an alphabetical
list of links to all of the commands in the windex database on the web
platform. OPTIONS Any combination of options is prefixed by a single '+' and includes any
order of the following case-sensitive letters.
++ |
Display the current documentation and disable
all other actions of the script. |
+_ |
Display the _th index from the Table of Contents, where
a single letter 'A-Z' is substituted for the underscore. |
USAGE The client creates a case-sensitive query with any alphanumeric, _ (underscore),
- (hyphen), : (colon), () (parentheses), or . (period) characters. Only
man pages with whole-word matches to the query will be returned. There
are no wildcard (meta) characters available. FILES The script uses the '/usr/bin/man' command to create the manual pages
and '/usr/bin/cat' command to define the table of contents from the /usr/share/man/windex
database. If either the executables or the windex database are not available
on the web platform, the script will return a critical error message and
send a warning to the webmaster. SEE ALSO
CGI Suite (Collection of General Purpose Scripts)
UNIX man pages
(<man>)
DIAGNOSTICS manquery was developed to handle all types of user- and server-related
errors. The script will send back to the client various well-behaved error
messages that will diagnose problems in creating the query. WARNINGS Man pages are preformatted by the UNIX server and may not appear standardized
on a Web browser. NOTES manquery has been tested without problem on Windows NT Workstations with
Netscape Communicator 4.x and Microsoft Internet Explorer 3.x web browsers.
Older versions of these and other browsers that do not support JavaScript
and Cascading Style Sheets will not display the response messages and
documentation as fully designed. This browser limitation, however, has
no effect on the function of the script. BUGS There are no known bugs in the current version. AUTHOR Gerald Charles Wagner. Version 2.0 (Release July 1998). |
