Mailing List Archive: cvs commit: httpd-docs-1.3/htdocs/manual install-tpf.html readme-tpf.html

gregames 00/09/27 10:37:32

Modified: htdocs/manual install-tpf.html readme-tpf.html
Log:
Update TPF platform-specific documents to reflect:
* changes to IBM's TPF operating system made this year, and
* suggestions from customers who are using these files.

Submitted by: David McCreedy <McCreedy@us.ibm.com>
Reviewed by: Greg Ames <gregames@raleigh.ibm.com>

Revision Changes Path
1.10 +60 -24 httpd-docs-1.3/htdocs/manual/install-tpf.html

Index: install-tpf.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/install-tpf.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- install-tpf.html 1999/12/21 20:43:48 1.9
+++ install-tpf.html 2000/09/27 17:37:30 1.10
@@ -71,7 +71,8 @@
 
<li>Extract the archived files necessary for compiling Apache:
<ul>
- <li><tt>pax -rvkf open_edition_filename.tar -o from=ISO8859-1,to=IBM-1047 "*/src"</tt>
+ <li><tt>pax -rvkf open_edition_filename.tar -o from=ISO8859-1,to=IBM-1047 "*/src"</tt> 
+ (any errors extracting files outside of the "src" directory can be ignored)
<li>switch to the source code subdirectory of the newly extracted apache directory: <tt>cd apache-1.3/src</tt>
<li>remove unnecessary subdirectories:
<tt>rm -r os/bs2000 os/mpeix os/netware os/os2 os/os390 os/win32</tt>
@@ -117,7 +118,7 @@
if you feel so inclined.
 
<LI>Comment out (by preceding the line with a "#") lines corresponding
- to those modules you DO NOT wish to include.
+ to those modules you do not wish to include.
 
<LI>Uncomment (by removing the initial "#", if present) lines
corresponding to those optional modules you wish
@@ -135,20 +136,24 @@
There are instructions on that page for linking these modules into the core Apache
code.
 
-<LI>Set the TPF environment variables:
+<LI><A NAME="export"></A>Set the TPF environment variables:
<TT>. os/tpf/TPFExport</TT>
 
- (The initial period and blank on the command are required to ensure
- the environment variables exist beyond the scope of the shell script.)
+ TIP:
+ The initial period and blank on the command are required to ensure
+ the environment variables exist beyond the scope of the shell script.
+ 
This script will set the environment variables required to compile the
programs for TPF. Verify that the export variables are valid for your
installation, in particular, the system include file directories. The
system include files must reside on your Open Edition system in the
appropriate file structure similar to /usr/include and /usr/include/sys.
- DO NOT modify the <TT>TPF=YES</TT> export variable. If this is
+ If your system header files contain line numbers in columns 72-80, you must truncate them.
+ 
+ Do not modify the <TT>TPF=YES</TT> export variable. If this is
changed, the "Configure" script will not recognize TPF.
 
-<LI>Run the "Configure" script:
+<LI><A NAME="configure"></A>Run the "Configure" script:
<TT>Configure</TT>
 
This generates modules.c, include/ap_config_auto.h, and necessary Makefiles:
@@ -166,16 +171,17 @@
Creating Makefile in os/tpf
Creating Makefile in ap
Creating Makefile in main
+ Creating Makefile in lib/expat-lite
Creating Makefile in modules/standard
$ _
</PRE>
If you want to maintain multiple configurations, you can
say, e.g.,
 
- <TT>Configure -file Configuration.ai</TT>
+ <TT>Configure -file Configuration.2nd</TT>
 
<PRE>
- Using config file: Configuration.ai
+ Using config file: Configuration.2nd
Creating Makefile
+ configured for <whatever> platform
+ setting C compiler to <whatever>
@@ -216,25 +222,48 @@
This change will only take effect after Apache is (re)compiled.

<A NAME="daemon"></A>   
-<LI>Edit include/ap_config.h if you plan on using the ZINET DAEMON model instead of the NOLISTEN model. 
+<LI>Determine if you will use the ZINET DAEMON model instead of the default NOLISTEN model. 
The default behavior is to let Apache check the server status (active/inactive) with ZINET
- and shut itself down when appropriate. The default behavior also includes checking Apache's activation number.
- Available with PUT11 (PJ25761) ZINET can perform these functions instead of Apache by using the DAEMON model.
+ and shut itself down when appropriate. This default behavior also includes checking the activation number.
+ ZINET can now perform these functions instead of Apache by using the DAEMON model
+ (PUT12 with APARs PJ25761 & PJ27363 required).
This model offers increased reliability and is preferred over the NOLISTEN model.
- If Apache goes down while running under the NOLISTEN model ZINET will not reactivate it nor alert the operator.
- To use the DAEMON model you must modify the default behavior of Apache by uncommenting or adding the directive
- <tt>#define USE_TPF_DAEMON</tt> within the TPF section in ap_config.h.
- This directive is also recommend when starting Apache from the command line (APAR PJ26515).
- This change will only take effect after Apache is (re)compiled.
- 
+ If Apache goes down while running under the NOLISTEN model, ZINET will not reactivate it nor alert
+ the operator. 
+ To use the DAEMON model you must do the following: 
+ <ul>
+ <li>Modify the default behavior of Apache by uncommenting or adding the directive
+ <code>#define USE_TPF_DAEMON</code> within the TPF section of include/ap_config.h.
+ This change will only take effect after Apache is (re)compiled. 
+ <li>Insert these four lines of code immediately prior to the <code>#endif</code> line in the
+ <code>os_check_server</code> function in os/tpf/os.c (if they are not already there): <code><ul>
+ #else 
+ if (getppid() == 1) { 
+ <ul>return 1; </ul>
+ } </ul></code>
+ </ul>

<LI>Now compile the programs: <TT>make</TT> 
Besides compiling, <tt>make</tt> also runs main/gen_test_char.c and main/gen_uri_delims.c
in order to create main/test_char.h and main/uri_delims.h respectively 
+
If during compilation you get a warning about a missing 'regex.h', set
<TT>WANTHSREGEX=yes</TT> in the src/Configuration file and start back at the
- <TT>Configure</TT> step.
+ <A HREF="#configure"><TT>Configure</TT></A> step. 
+
+ If you get a <tt>'Duplicate type specifier "long" ignored'</tt> error,
+ append the following line to the os/tpf/TPFExport file and start back at the
+ <A HREF="#export"><TT>export</TT></A> step: 
+ <ul><tt>export _C89_OPTIONS="-W 0,langlvl(extended)"</tt></ul> 
+
+ The following compilation warnings are expected and can be ignored: 
+ <ul>
+ <li>util_uri.c:   <tt>Function argument assignment between types "unsigned char*" and "const unsigned char*" is not allowed.</tt>
+ <li>mod_put.c:   <tt>#include file "ap_vercompat.h" not found</tt>
+ <li>mod_tpf_shm_static.c:   <tt>#include file <sys/mman.h> not found</tt>
+ <li>mod_usertrack.c:   <tt>#include file <sys/time.h> not found</tt>
+
</OL>

<A NAME="installation"> </A>
@@ -248,13 +277,15 @@
<li>Add/remove <TT>mod_xxx.o</TT> files so they correspond to the
<TT>mod_xxx.o</TT> lines in your src/Configuration file.
</ul>
- TIP: 
- Do NOT include gen_test_char.o or gen_uri_delims.o in the link JCL since these files are only
+ TIP:
+ Do not include gen_test_char.o or gen_uri_delims.o in the link JCL since these files are only
used during the <tt>make</tt> step.
 
<LI>Create a loadset. Sample loadset JCL has been included as src/os/tpf/samples/loadset.jcl.
You will need to modify this JCL for your particular site.
 
+ A JCL condition code of 4 is expected since the C load module will contain no link map data.
+ 
<LI>Load (<tt>ZOLDR LOAD</tt>) and activate (<tt>ZOLDR ACT</tt>) the loadset on your test system.
 
<LI>Ensure that the program name you are using for Apache has <tt>RESTRICT</tt> and <tt>KEY0</tt> authorization.
@@ -293,12 +324,17 @@
/usr/local/apache/logs
/usr/local/apache/icons
/usr/local/apache/htdocs</PRE>
- All gif, jpg, and zip files should be TFTP'd as binary; conf files and html pages should be TFTP'd as text.
- The logs directory must exist in order to avoid an <CODE>fopen</CODE> error while running Apache.
+ All gif, jpg, and zip files should be TFTP'd as binary; conf files and html pages should be TFTP'd as text. 
+ The logs directory must exist in order to avoid an <CODE>fopen</CODE> error while running Apache: 
+ <ul>
If you're running a PUT10 or higher version of TPF make the directory using the
<tt>zfile mkdir /usr/local/apache/logs</tt> functional entry.
- If you're running TPF version PUT09 TFTP an empty file into the logs subdirectory to create it.
 
+ If you're running TPF version PUT09, TFTP an empty file into the logs subdirectory to create it.
+ 
+ Regardless of your TPF version, make sure Apache can write into the logs subdirectory by doing a
+ <tt>zfile chmod</tt> on it with the appropriate permission settings.
+ </ul> 
<LI>Start the server using the <tt>ZINET START S-APACHE</tt> command.
</OL>
<A NAME="visualage"> </A>

1.9 +66 -1 httpd-docs-1.3/htdocs/manual/readme-tpf.html

Index: readme-tpf.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/readme-tpf.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- readme-tpf.html 2000/09/12 02:29:09 1.8
+++ readme-tpf.html 2000/09/27 17:37:30 1.9
@@ -9,6 +9,7 @@
<HR>
<CENTER>[. <A HREF="#configuration_files">Configuration Files</A>
 | <A HREF="#whats_available">What's Available</A>
+  | <A HREF="#cgi">CGI Scripts</A>
 | <A HREF="#porting_notes">Porting Notes</A> ]
</CENTER>
<HR>
@@ -129,7 +130,7 @@
</UL></MULTICOL>
<A NAME="notes"></A>Notes:
<ol>
- <li>Use of mod_access directives "<tt>Allow from</tt>" & "<tt>Deny from</tt>"
+ <li>Use of mod_access directives "<tt>allow from</tt>" & "<tt>deny from</tt>"
with host names (verses ip addresses) requires TPF version 4.1 PUT10
<li>CGI execution requires TPF version 4.1 PUT10
</ol>
@@ -157,6 +158,69 @@
<LI>suexec.c
</UL></MULTICOL>

+<A NAME="cgi"> </A>
+<H2 align=center>How to Use CGI Scripts</H2>
+
+ The following is a very simple example of a CGI script ("Hello World") and the necessary steps to run it. 
+ Refer to the <A HREF="http://www.apache.org/docs/mod/mod_cgi.html">mod_cgi module</A> for
+ additional information. 
+
+ <H3>Add necessary directives to httpd.conf:</H3>
+ <UL>
+ Example:
+ <tt> <UL>
+ ScriptLog logs/script_log 
+ ScriptAlias /cgi-bin/ /usr/local/apache/cgi-bin/
+ </tt></UL> 
+ A request for <tt>http://myserver/cgi-bin/filename.cgi</tt> would cause the server to run the script
+ <tt>/usr/local/apache/cgi-bin/filename.cgi</tt>
+ </UL>
+
+ <H3>Create the CGI script:</H3>
+ <UL>
+ For this example <tt>QZZ1</tt> is the name of the TPF program that will be executed by the CGI script. 
+ The directory path must match what is in the httpd.conf file for <tt>ScriptAlias</tt> directive. 
+ <UL>
+ <tt>zfile echo "#!QZZ1" > /usr/local/apache/cgi-bin/filename.cgi 
+ zfile cat /usr/local/apache/cgi-bin/filename.cgi    </tt>
+ (this should display<tt>#!QZZ1</tt>) 
+ </UL>
+ </UL>
+
+ <H3>Mark the script as executable:</H3>
+ <UL>
+ <tt>zfile chmod 755 /usr/local/apache/cgi-bin/filename.cgi </tt>
+ </UL>
+
+ <H3>Create, load, and activate a loadset containing the CGI program (QZZ1xx):</H3>
+ <UL>
+ <code>
+ /** QZZ1-- simple "Hello world" program to demonstrate basic CGI output **/ 
+ #include &LT;stdio.h&GT 
+ void main() { 
+ <UL>
+ /** Print the CGI response header, required for all HTML output. **/ 
+ /** Note the extra \n, to send the blank line. **/ 
+
+ printf("Content-type: text/html\n\n"); 
+
+ /** Print the HTML response page to stdout. **/ 
+ printf("&LT;html&GT\n"); 
+ printf("&LT;head&GT&LT;title&GT CGI Output &LT;/title&GT&LT;/head&GT\n"); 
+ printf("&LT;body&GT\n"); 
+ printf("&LT;h1&GT Hello world &LT;/h1&GT \n"); 
+ printf("&LT/body&GT\n"); 
+ printf("&LT/html&GT\n"); 
+ </UL>
+ } 
+ </code>
+ </UL>
+
+ <H3>Request the CGI script from a browser:</H3>
+ <UL>
+ <tt>http://myserver/cgi-bin/filename.cgi</tt> 
+ </UL>
+
<A NAME="porting_notes"> </A>
<H2 align=center>Porting Notes</H2>

@@ -201,6 +265,7 @@
<CENTER>[. <A HREF="#top">top</A>
 | <A HREF="#configuration_files">Configuration Files</A>
 | <A HREF="#whats_available">What's Available</A>
+  | <A HREF="#cgi">CGI Scripts</A>
 | <A HREF="#porting_notes">Porting Notes</A> ]
</CENTER>