github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_so.html.en (about) 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> 4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> 5 <!-- 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 This file is generated from xml source: DO NOT EDIT 8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 9 --> 10 <title>mod_so - Apache HTTP Server Version 2.2</title> 11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" /> 14 <script src="../style/scripts/prettify.min.js" type="text/javascript"> 15 </script> 16 17 <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_so.html" rel="canonical" /></head> 18 <body> 19 <div id="page-header"> 20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p> 21 <p class="apache">Apache HTTP Server Version 2.2</p> 22 <img alt="" src="../images/feather.gif" /></div> 23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> 24 <div id="path"> 25 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div> 26 <div id="page-content"> 27 <div class="retired"><h4>Please note</h4> 28 <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p> 29 <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_so.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_so</h1> 30 <div class="toplang"> 31 <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English"> en </a> | 32 <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 33 <a href="../ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 34 <a href="../tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> 35 </div> 36 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Loading of executable code and 37 modules into the server at start-up or restart time</td></tr> 38 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 39 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>so_module</td></tr> 40 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_so.c</td></tr> 41 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>This is a Base module (always included) on 42 Windows</td></tr></table> 43 <h3>Summary</h3> 44 45 46 <p>On selected operating systems this module can be used to 47 load modules into Apache at runtime via the <a href="../dso.html">Dynamic Shared Object</a> (DSO) mechanism, 48 rather than requiring a recompilation.</p> 49 50 <p>On Unix, the loaded code typically comes from shared object 51 files (usually with <code>.so</code> extension), on Windows 52 this may either the <code>.so</code> or <code>.dll</code> 53 extension.</p> 54 55 <div class="warning"><h3>Warning</h3> 56 <p>Apache 1.3 modules cannot be directly used 57 with Apache 2.0 - the module must be modified to dynamically 58 load or compile into Apache 2.0.</p> 59 </div> 60 </div> 61 <div id="quickview"><h3>Topics</h3> 62 <ul id="topics"> 63 <li><img alt="" src="../images/down.gif" /> <a href="#windows">Creating Loadable Modules for Windows</a></li> 64 </ul><h3 class="directives">Directives</h3> 65 <ul id="toc"> 66 <li><img alt="" src="../images/down.gif" /> <a href="#loadfile">LoadFile</a></li> 67 <li><img alt="" src="../images/down.gif" /> <a href="#loadmodule">LoadModule</a></li> 68 </ul> 69 <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 70 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 71 <div class="section"> 72 <h2><a name="windows" id="windows">Creating Loadable Modules for Windows</a></h2> 73 74 <div class="note"><h3>Note</h3> 75 <p>The module name format changed for Windows 76 with Apache 1.3.15 and 2.0 - the modules are now named as 77 mod_foo.so</p> 78 79 <p>While mod_so still loads modules with 80 ApacheModuleFoo.dll names, the new naming convention is 81 preferred; if you are converting your loadable module for 2.0, 82 please fix the name to this 2.0 convention.</p></div> 83 84 <p>The Apache module API is unchanged between the Unix and 85 Windows versions. Many modules will run on Windows with no or 86 little change from Unix, although others rely on aspects of the 87 Unix architecture which are not present in Windows, and will 88 not work.</p> 89 90 <p>When a module does work, it can be added to the server in 91 one of two ways. As with Unix, it can be compiled into the 92 server. Because Apache for Windows does not have the 93 <code>Configure</code> program of Apache for Unix, the module's 94 source file must be added to the ApacheCore project file, and 95 its symbols must be added to the 96 <code>os\win32\modules.c</code> file.</p> 97 98 <p>The second way is to compile the module as a DLL, a shared 99 library that can be loaded into the server at runtime, using 100 the <code><code class="directive">LoadModule</code></code> 101 directive. These module DLLs can be distributed and run on any 102 Apache for Windows installation, without recompilation of the 103 server.</p> 104 105 <p>To create a module DLL, a small change is necessary to the 106 module's source file: The module record must be exported from 107 the DLL (which will be created later; see below). To do this, 108 add the <code>AP_MODULE_DECLARE_DATA</code> (defined in the 109 Apache header files) to your module's module record definition. 110 For example, if your module has:</p> 111 112 <div class="example"><p><code> 113 module foo_module; 114 </code></p></div> 115 116 <p>Replace the above with:</p> 117 <div class="example"><p><code> 118 module AP_MODULE_DECLARE_DATA foo_module; 119 </code></p></div> 120 121 <p>Note that this will only be activated on Windows, so the 122 module can continue to be used, unchanged, with Unix if needed. 123 Also, if you are familiar with <code>.DEF</code> files, you can 124 export the module record with that method instead.</p> 125 126 <p>Now, create a DLL containing your module. You will need to 127 link this against the libhttpd.lib export library that is 128 created when the libhttpd.dll shared library is compiled. You 129 may also have to change the compiler settings to ensure that 130 the Apache header files are correctly located. You can find 131 this library in your server root's modules directory. It is 132 best to grab an existing module .dsp file from the tree to 133 assure the build environment is configured correctly, or 134 alternately compare the compiler and link options to your 135 .dsp.</p> 136 137 <p>This should create a DLL version of your module. Now simply 138 place it in the <code>modules</code> directory of your server 139 root, and use the <code class="directive">LoadModule</code> 140 directive to load it.</p> 141 142 </div> 143 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 144 <div class="directive-section"><h2><a name="LoadFile" id="LoadFile">LoadFile</a> <a name="loadfile" id="loadfile">Directive</a></h2> 145 <table class="directive"> 146 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Link in the named object file or library</td></tr> 147 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadFile <em>filename</em> [<em>filename</em>] ...</code></td></tr> 148 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> 149 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 150 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr> 151 </table> 152 153 <p>The LoadFile directive links in the named object files or 154 libraries when the server is started or restarted; this is used 155 to load additional code which may be required for some module 156 to work. <em>Filename</em> is either an absolute path or 157 relative to <a href="core.html#serverroot">ServerRoot</a>.</p> 158 159 <p>For example:</p> 160 161 <div class="example"><p><code>LoadFile libexec/libxmlparse.so</code></p></div> 162 163 164 </div> 165 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 166 <div class="directive-section"><h2><a name="LoadModule" id="LoadModule">LoadModule</a> <a name="loadmodule" id="loadmodule">Directive</a></h2> 167 <table class="directive"> 168 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Links in the object file or library, and adds to the list 169 of active modules</td></tr> 170 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadModule <em>module filename</em></code></td></tr> 171 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> 172 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 173 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr> 174 </table> 175 <p>The LoadModule directive links in the object file or library 176 <em>filename</em> and adds the module structure named 177 <em>module</em> to the list of active modules. <em>Module</em> 178 is the name of the external variable of type 179 <code>module</code> in the file, and is listed as the <a href="module-dict.html#ModuleIdentifier">Module Identifier</a> 180 in the module documentation. Example:</p> 181 182 <div class="example"><p><code> 183 LoadModule status_module modules/mod_status.so 184 </code></p></div> 185 186 <p>loads the named module from the modules subdirectory of the 187 ServerRoot.</p> 188 189 </div> 190 </div> 191 <div class="bottomlang"> 192 <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English"> en </a> | 193 <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 194 <a href="../ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 195 <a href="../tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> 196 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> 197 <script type="text/javascript"><!--//--><![CDATA[//><!-- 198 var comments_shortname = 'httpd'; 199 var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_so.html'; 200 (function(w, d) { 201 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 202 d.write('<div id="comments_thread"><\/div>'); 203 var s = d.createElement('script'); 204 s.type = 'text/javascript'; 205 s.async = true; 206 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 207 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 208 } 209 else { 210 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 211 } 212 })(window, document); 213 //--><!]]></script></div><div id="footer"> 214 <p class="apache">Copyright 2017 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> 215 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- 216 if (typeof(prettyPrint) !== 'undefined') { 217 prettyPrint(); 218 } 219 //--><!]]></script> 220 </body></html>