3 .\" $Id: sw-cgi.1,v 1.2 2004/04/08 01:52:19 mdw Exp $
5 .\" Man page for `sw' CGI script
10 .\"----- Licensing notice ---------------------------------------------------
12 .\" This file is part of sw-tools.
14 .\" sw-tools is free software; you can redistribute it and/or modify
15 .\" it under the terms of the GNU General Public License as published by
16 .\" the Free Software Foundation; either version 2 of the License, or
17 .\" (at your option) any later version.
19 .\" sw-tools is distributed in the hope that it will be useful,
20 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
21 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 .\" GNU General Public License for more details.
24 .\" You should have received a copy of the GNU General Public License
25 .\" along with sw-tools; if not, write to the Free Software Foundation,
26 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 if [ ! -r "$SW_PREFIX/doc/$SW_PACKAGE" ]; then
29 echo >&2 "no documentation file \`$SW_PREFIX/doc/$SW_PACKAGE'"
33 Links to these documentation files are put into the table
34 automatically. The script picks out likely-looking references to other
35 sources of information:
38 A reference of the form
40 is suspected of being a manual page; the script looks in the manual
41 directories to see if this is the case and if so inserts a hypertext
42 link to the manual page. This is the standard form for manual page
46 A reference of the form
48 is assumed to be a reference to the GNU Info manual called
50 and an appropriate link inserted. There isn't a standard form for Info
51 references in non-Info manuals, so I've invented one.
54 A URL which begins with one of
58 is spotted and turned into a link. Only these two work.
61 Something that looks like an email address is turned into a
65 Similar transformations are applied to manual pages when they're
68 .SS "Script arguments"
69 The behaviour of the script is determined by the value of the
71 key. Any of the following may be given:
74 Emit the list of packages in tabular form. This is the default if no
79 Format a textual documentation file. The name of the package whose
80 documentation is to be emitted is given as the value of the
85 Format a manual page, or emit a manual index. If no
87 key is given, an index of all manual pages in the software area is
90 is a manual page section (e.g.,
96 is not given then an index of that particular section is emitted. If
101 are supplied then the manual page whose name is given by the
103 key in the section given by the
105 key is formatted (using
107 and displayed. Manual page references, URLs and email addresses are
108 transformed into links in the output.
111 Format a GNU Info node. If the
113 key is given, its value names an Info manual to open; the default is
117 key is given, its value names a node within the manual; the default is
121 Emits a table showing the configuration settings which the script is
124 below. This is useful during debugging.
127 Displays the environment variables passed to the script by the Web
128 server. This is useful during debugging.
131 Displays the query string passed by the Web server, decomposed into keys
132 and values and decoded. This is useful during debugging.
137 CGI script needs some configuration before it can do its work properly.
138 Indeed, it will refuse to run until the configuration file has been
141 The configuration file is in
142 .IB prefix /share/sw.conf\fR.
143 The format is simple. A line may be empty, or a comment, in which case
144 it is ignored. Comments have
146 as their first non-whitespace character; blank lines contain only
147 whitespace. A line may also contain a configuration variable
148 assignment, of the form
154 may be anything you like; only certain keys make sense to the script.
156 Configuration keys currently used are:
159 The name of the package in which the script came. This is set
160 automatically and you should not change the value.
163 The version number of the package. This is set automatically and you
164 should not change the value.
166 .B edited-config-file
167 Must be assigned the value
169 If this is not the case the script will immediately report an error.
170 The default configuration file comes with a commented-out assignment to
174 The installation prefix where your software gets installed. You
175 shouldn't need to change this, although it's handy for debugging.
177 .BR index ", " doc " and " datadir
178 The name of the index file, documentation directory and shared data
179 directory respectively. The default values of these variables are set
180 automatically and you shouldn't need to change them.
183 Your email domain. Set this to the domain part for email addresses of
184 people at your site, and the script will generate correct links in its
187 .\"--------------------------------------------------------------------------
195 The \*(sw program, and this manual, are \*(mw productions, in association
196 with the European Bioinformatics Institute. They were written by Mark
197 Wooding <mdw@nsict.org>. Go and ask him if you have problems.
199 .\"----- That's all, folks --------------------------------------------------