home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 November / PCWorld_2003-11_cd.bin / Komunik / apache / apache_2.0.47-win32-x86-no_ssl.msi / Data.Cab / F251294_apxs.xml < prev    next >
Extensible Markup Language  |  2003-04-29  |  14KB  |  315 lines
  1. <?xml version='1.0' encoding='UTF-8' ?>
  2. <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <manualpage metafile="apxs.xml.meta">
  5. <parentdocument href="./">Programs</parentdocument>
  6.  
  7. <title>apxs - APache eXtenSion tool</title>
  8.  
  9. <summary>
  10.     <p><code>apxs</code> is a tool for building and installing extension
  11.     modules for the Apache HyperText Transfer Protocol (HTTP) server. This is
  12.     achieved by building a dynamic shared object (DSO) from one or more source
  13.     or object <var>files</var> which then can be loaded into the Apache server
  14.     under runtime via the <directive module="mod_so">LoadModule</directive>
  15.     directive from <module>mod_so</module>.</p>
  16.  
  17.     <p>So to use this extension mechanism your platform has to support the DSO
  18.     feature and your Apache <code>httpd</code> binary has to be built with the
  19.     <module>mod_so</module> module. The <code>apxs</code> tool automatically
  20.     complains if this is not the case. You can check this yourself by manually
  21.     running the command</p>
  22.  
  23.     <example>
  24.       $ httpd -l
  25.     </example>
  26.  
  27.     <p>The module <module>mod_so</module> should be part of the displayed list.
  28.     If these requirements are fulfilled you can easily extend your Apache
  29.     server's functionality by installing your own modules with the DSO mechanism
  30.     by the help of this <code>apxs</code> tool:</p>
  31.  
  32.     <example>
  33.       $ apxs -i -a -c mod_foo.c<br />
  34.       gcc -fpic -DSHARED_MODULE -I/path/to/apache/include -c mod_foo.c<br />
  35.       ld -Bshareable -o mod_foo.so mod_foo.o<br />
  36.       cp mod_foo.so /path/to/apache/modules/mod_foo.so<br />
  37.       chmod 755 /path/to/apache/modules/mod_foo.so<br />
  38.       [activating module `foo' in /path/to/apache/etc/httpd.conf]<br />
  39.       $ apachectl restart<br />
  40.       /path/to/apache/sbin/apachectl restart: httpd not running, trying to start<br />
  41.       [Tue Mar 31 11:27:55 1998] [debug] mod_so.c(303): loaded module foo_module<br />
  42.       /path/to/apache/sbin/apachectl restart: httpd started<br />
  43.       $ _
  44.     </example>
  45.  
  46.     <p>The arguments <var>files</var> can be any C source file (.c), a object
  47.     file (.o) or even a library archive (.a). The <code>apxs</code> tool
  48.     automatically recognizes these extensions and  automatically used the C
  49.     source files for compilation while just using the object and archive files
  50.     for the linking phase. But when using such pre-compiled objects make sure
  51.     they are compiled for position independent code (PIC) to be able to use them
  52.     for a dynamically loaded shared object. For instance with GCC you always
  53.     just have to use <code>-fpic</code>. For other C compilers consult its
  54.     manual page or at watch for the flags <code>apxs</code> uses to compile the
  55.     object files.</p>
  56.  
  57.     <p>For more details about DSO support in Apache read the documentation of
  58.     <module>mod_so</module> or perhaps even read the
  59.     <code>src/modules/standard/mod_so.c</code> source file.</p>
  60. </summary>
  61. <seealso><a href="apachectl.html">apachectl</a></seealso>
  62. <seealso><a href="httpd.html">httpd</a></seealso>
  63.  
  64. <section id="synopsis"><title>Synopsis</title>
  65.     <p><code><strong>apxs</strong> -<strong>g</strong>
  66.     [ -<strong>S</strong> <var>name</var>=<var>value</var> ]
  67.     -<strong>n</strong> <var>modname</var></code></p>
  68.  
  69.     <p><code><strong>apxs</strong> -<strong>q</strong>
  70.     [ -<strong>S</strong> <var>name</var>=<var>value</var> ]
  71.     <var>query</var> ...</code></p>
  72.  
  73.     <p><code><strong>apxs</strong> -<strong>c</strong>
  74.     [ -<strong>S</strong> <var>name</var>=<var>value</var> ]
  75.     [ -<strong>o</strong> <var>dsofile</var> ]
  76.     [ -<strong>I</strong> <var>incdir</var> ]
  77.     [ -<strong>D</strong> <var>name</var>=<var>value</var> ]
  78.     [ -<strong>L</strong> <var>libdir</var> ]
  79.     [ -<strong>l</strong> <var>libname</var> ]
  80.     [ -<strong>Wc,</strong><var>compiler-flags</var> ]
  81.     [ -<strong>Wl,</strong><var>linker-flags</var> ]
  82.     <var>files</var> ...</code></p>
  83.  
  84.     <p><code><strong>apxs</strong> -<strong>i</strong>
  85.     [ -<strong>S</strong> <var>name</var>=<var>value</var> ]
  86.     [ -<strong>n</strong> <var>modname</var> ]
  87.     [ -<strong>a</strong> ]
  88.     [ -<strong>A</strong> ]
  89.     <var>dso-file</var> ...</code></p>
  90.  
  91.     <p><code><strong>apxs</strong> -<strong>e</strong>
  92.     [ -<strong>S</strong> <var>name</var>=<var>value</var> ]
  93.     [ -<strong>n</strong> <var>modname</var> ]
  94.     [ -<strong>a</strong> ]
  95.     [ -<strong>A</strong> ]
  96.     <var>dso-file</var> ...</code></p>
  97. </section>
  98.  
  99. <section id="options"><title>Options</title>
  100.     <section id="options.common"><title>Common Options</title>
  101.       <dl>
  102.       <dt><code>-n <var>modname</var></code></dt>
  103.       <dd>This explicitly sets the module name for the <code>-i</code> (install)
  104.       and <code>-g</code> (template generation) option. Use this to explicitly
  105.       specify the module name. For option <code>-g</code> this is required, for
  106.       option <code>-i</code> the <code>apxs</code> tool tries to determine the
  107.       name from the source or (as a fallback) at least by guessing it from the
  108.       filename.</dd>
  109.       </dl>
  110.     </section>
  111.  
  112.     <section id="options.query"><title>Query Options</title>
  113.       <dl>
  114.       <dt><code>-q</code></dt>
  115.       <dd>Performs a query for <code>apxs</code>'s knowledge about certain
  116.       settings. The <var>query</var> parameters can be one or more of the
  117.       following strings: <code>CC</code>, <code>CFLAGS</code>,
  118.       <code>CFLAGS_SHLIB</code>, <code>INCLUDEDIR</code>, <code>LD_SHLIB</code>,
  119.       <code>LDFLAGS_SHLIB</code>, <code>LIBEXECDIR</code>,
  120.       <code>LIBS_SHLIB</code>, <code>SBINDIR</code>, <code>SYSCONFDIR</code>,
  121.       <code>TARGET</code>.
  122.  
  123.       <p>Use this for manually determining settings. For instance use</p>
  124.       <example>
  125.         INC=-I`apxs -q INCLUDEDIR`
  126.       </example>
  127.  
  128.       <p>inside your own Makefiles if you need manual access to Apache's C
  129.       header files.</p></dd>
  130.       </dl>
  131.     </section>
  132.  
  133.     <section id="options.conf"><title>Configuration Options</title>
  134.       <dl>
  135.       <dt><code>-S <var>name</var>=<var>value</var></code></dt>
  136.       <dd>This option changes the apxs settings described above.</dd>
  137.       </dl>
  138.     </section>
  139.  
  140.     <section id="options.template"><title>Template Generation Options</title>
  141.       <dl>
  142.       <dt><code>-g</code></dt>
  143.       <dd>This generates a subdirectory <var>name</var> (see option
  144.       <code>-n</code>) and there two files: A sample module source file named
  145.       <code>mod_<var>name</var>.c</code> which can be used as a template for
  146.       creating your own modules or as a quick start for playing with the
  147.       apxs mechanism. And a corresponding <code>Makefile</code> for even easier
  148.       build and installing of this module.</dd>
  149.       </dl>
  150.     </section>
  151.  
  152.     <section id="options.dso"><title>DSO Compilation Options</title>
  153.       <dl>
  154.       <dt><code>-c</code></dt>
  155.       <dd>This indicates the compilation operation. It first compiles the C
  156.       source files (.c) of <var>files</var> into corresponding object files (.o)
  157.       and then builds a dynamically shared object in <var>dsofile</var> by
  158.       linking these object files plus the remaining object files (.o and .a) of
  159.       <var>files</var>. If no <code>-o</code> option is specified the output
  160.       file is guessed from the first filename in <var>files</var> and thus
  161.       usually defaults to <code>mod_<var>name</var>.so</code>.</dd>
  162.  
  163.       <dt><code>-o <var>dsofile</var></code></dt>
  164.       <dd>Explicitly specifies the filename of the created dynamically shared
  165.       object. If not specified and the name cannot be guessed from the
  166.       <var>files</var> list, the fallback name <code>mod_unknown.so</code> is
  167.       used.</dd>
  168.  
  169.       <dt><code>-D <var>name</var>=<var>value</var></code></dt>
  170.       <dd>This option is directly passed through to the compilation command(s).
  171.       Use this to add your own defines to the build process.</dd>
  172.  
  173.       <dt><code>-I <var>incdir</var></code></dt>
  174.       <dd>This option is directly passed through to the compilation command(s).
  175.       Use this to add your own include directories to search to the build
  176.       process.</dd>
  177.  
  178.       <dt><code>-L <var>libdir</var></code></dt>
  179.       <dd>This option is directly passed through to the linker command. Use this
  180.       to add your own library directories to search to the build  process.</dd>
  181.  
  182.       <dt><code>-l <var>libname</var></code></dt>
  183.       <dd>This option is directly passed through to the linker command. Use this
  184.       to add your own libraries to search to the build process.</dd>
  185.  
  186.       <dt><code>-Wc,<var>compiler-flags</var></code></dt>
  187.       <dd>This option passes <var>compiler-flags</var> as additional flags to
  188.       the compiler command. Use this to add local compiler-specific options.</dd>
  189.  
  190.       <dt><code>-Wl,<var>linker-flags</var></code></dt>
  191.       <dd>This option passes <var>linker-flags</var> as additional flags to
  192.       the linker command. Use this to add local linker-specific options.</dd>
  193.       </dl>
  194.     </section>
  195.  
  196.     <section id="options.dsoinstall">
  197.     <title>DSO Installation and Configuration Options</title>
  198.       <dl>
  199.       <dt><code>-i</code></dt>
  200.       <dd>This indicates the installation operation and installs one or more
  201.       dynamically shared objects into the server's <var>modules</var>
  202.       directory.</dd>
  203.  
  204.       <dt><code>-a</code></dt>
  205.       <dd>This activates the module by automatically adding a corresponding
  206.       <directive module="mod_so">LoadModule</directive> line to Apache's
  207.       <code>httpd.conf</code> configuration file, or by enabling it if it
  208.       already exists.</dd>
  209.  
  210.       <dt><code>-A</code></dt>
  211.       <dd>Same as option <code>-a</code> but the created <directive
  212.       module="mod_so">LoadModule</directive> directive is prefixed with a hash
  213.       sign (<code>#</code>), <em>i.e.</em>, the module is just prepared for
  214.       later activation but initially disabled.</dd>
  215.  
  216.       <dt><code>-e</code></dt>
  217.       <dd>This indicates the editing operation, which can be used with the
  218.       <code>-a</code> and <code>-A</code> options similarly to the
  219.       <code>-i</code> operation to edit Apache's <code>httpd.conf</code>
  220.       configuration file without attempting to install the module.</dd>
  221.       </dl>
  222.     </section>
  223. </section>
  224.  
  225. <section id="examples"><title>Examples</title>
  226.     <p>Assume you have an Apache module named <code>mod_foo.c</code> available
  227.     which should extend Apache's server functionality. To accomplish this you
  228.     first have to compile the C source into a shared object suitable for loading
  229.     into the Apache server under runtime via the following command:</p>
  230.  
  231.     <example>
  232.       $ apxs -c mod_foo.c<br />
  233.       gcc -fpic -DSHARED_MODULE -I/path/to/apache/include -c mod_foo.c<br />
  234.       ld -Bshareable -o mod_foo.so mod_foo.o<br />
  235.       $ _
  236.     </example>
  237.  
  238.     <p>Then you have to update the Apache configuration by making sure a
  239.     <directive module="mod_so">LoadModule</directive> directive is present to
  240.     load this shared object. To simplify this step <code>apxs</code> provides
  241.     an automatic way to install the shared object in its "modules" directory
  242.     and updating the <code>httpd.conf</code> file accordingly. This can be
  243.     achieved by running:</p>
  244.  
  245.     <example>
  246.       $ apxs -i -a mod_foo.c<br />
  247.       cp mod_foo.so /path/to/apache/modules/mod_foo.so<br />
  248.       chmod 755 /path/to/apache/modules/mod_foo.so<br />
  249.       [activating module `foo' in /path/to/apache/etc/httpd.conf]<br />
  250.       $ _
  251.     </example>
  252.  
  253.     <p>This way a line named</p>
  254.  
  255.     <example>
  256.       LoadModule foo_module modules/mod_foo.so
  257.     </example>
  258.  
  259.     <p>is added to the configuration file if still not present. If you want to
  260.     have this disabled per default use the <code>-A</code> option,
  261.     <em>i.e.</em></p>
  262.  
  263.     <example>
  264.       $ apxs -i -A mod_foo.c
  265.     </example>
  266.  
  267.     <p>For a quick test of the apxs mechanism you can create a sample Apache
  268.     module template plus a corresponding Makefile via:</p>
  269.  
  270.     <example>
  271.       $ apxs -g -n foo<br />
  272.       Creating [DIR]  foo<br />
  273.       Creating [FILE] foo/Makefile<br />
  274.       Creating [FILE] foo/mod_foo.c<br />
  275.       $ _
  276.     </example>
  277.  
  278.     <p>Then you can immediately compile this sample module into a shared object
  279.     and load it into the Apache server:</p>
  280.  
  281.     <example>
  282.       $ cd foo<br />
  283.       $ make all reload<br />
  284.       apxs -c mod_foo.c<br />
  285.       gcc -fpic -DSHARED_MODULE -I/path/to/apache/include -c mod_foo.c<br />
  286.       ld -Bshareable -o mod_foo.so mod_foo.o<br />
  287.       apxs -i -a -n "foo" mod_foo.so<br />
  288.       cp mod_foo.so /path/to/apache/modules/mod_foo.so<br />
  289.       chmod 755 /path/to/apache/modules/mod_foo.so<br />
  290.       [activating module `foo' in /path/to/apache/etc/httpd.conf]<br />
  291.       apachectl restart<br />
  292.       /path/to/apache/sbin/apachectl restart: httpd not running, trying to start<br />
  293.       [Tue Mar 31 11:27:55 1998] [debug] mod_so.c(303): loaded module foo_module<br />
  294.       /path/to/apache/sbin/apachectl restart: httpd started<br />
  295.       $ _
  296.     </example>
  297.  
  298.     <p>You can even use <code>apxs</code> to compile complex modules outside the
  299.     Apache source tree, like PHP3:</p>
  300.  
  301.     <example>
  302.       $ cd php3<br />
  303.       $ ./configure --with-shared-apache=../apache-1.3<br />
  304.       $ apxs -c -o libphp3.so mod_php3.c libmodphp3-so.a<br />
  305.       gcc -fpic -DSHARED_MODULE -I/tmp/apache/include  -c mod_php3.c<br />
  306.       ld -Bshareable -o libphp3.so mod_php3.o libmodphp3-so.a<br />
  307.       $ _
  308.     </example>
  309.  
  310.     <p>because <code>apxs</code> automatically recognized C source files and
  311.     object files. Only C source files are compiled while remaining object
  312.     files are used for the linking phase.</p>
  313. </section>
  314. </manualpage>
  315.