]> granicus.if.org Git - apache/blob - docs/manual/programs/httpd.html.en
Xforms.
[apache] / docs / manual / programs / httpd.html.en
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>httpd - Apache Hypertext Transfer Protocol Server - Apache HTTP Server Version 2.5</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" /></head>
18 <body id="manual-page"><div id="page-header">
19 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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>
20 <p class="apache">Apache HTTP Server Version 2.5</p>
21 <img alt="" src="../images/feather.png" /></div>
22 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
23 <div id="path">
24 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>httpd - Apache Hypertext Transfer Protocol Server</h1>
25 <div class="toplang">
26 <p><span>Available Languages: </span><a href="../en/programs/httpd.html" title="English">&nbsp;en&nbsp;</a> |
27 <a href="../ko/programs/httpd.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
28 <a href="../tr/programs/httpd.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
29 </div>
30
31      <p><code>httpd</code> is the Apache HyperText Transfer Protocol
32      (HTTP) server program.  It is designed to be run as a standalone
33      daemon process. When used like this it will create a pool of
34      child processes or threads to handle requests.</p>
35
36      <p>In general, <code>httpd</code> should not be invoked directly,
37      but rather should be invoked via <code class="program"><a href="../programs/apachectl.html">apachectl</a></code> on Unix-based systems or <a href="../platform/windows.html#winsvc">as a service on Windows NT,
38      2000 and XP</a> and <a href="../platform/windows.html#wincons">as
39      a console application on Windows 9x and ME</a>.</p>
40 </div>
41 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
42 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
43 </ul><h3>See also</h3><ul class="seealso"><li><a href="../invoking.html">Starting Apache httpd</a></li><li><a href="../stopping.html">Stopping Apache httpd</a></li><li><a href="../configuring.html">Configuration Files</a></li><li><a href="../platform/">Platform-specific Documentation</a></li><li><code class="program"><a href="../programs/apachectl.html">apachectl</a></code></li><li><a href="#comments_section">Comments</a></li></ul></div>
44 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
45 <div class="section">
46 <h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
47      <p><code><strong>httpd</strong> [ -<strong>d</strong>
48      <var>serverroot</var> ] [ -<strong>f</strong> <var>config</var> ]
49      [ -<strong>C</strong> <var>directive</var> ] [ -<strong>c</strong>
50      <var>directive</var> ] [ -<strong>D</strong> <var>parameter</var> ]
51      [ -<strong>e</strong> <var>level</var> ] [ -<strong>E</strong>
52      <var>file</var> ]
53      [ <strong>-k</strong> start|restart|graceful|stop|graceful-stop ]
54      [ -<strong>R</strong> <var>directory</var> ] [ -<strong>h</strong> ]
55      [ -<strong>l</strong> ] [ -<strong>L</strong> ] [ -<strong>S</strong> ]
56      [ -<strong>t</strong> ] [ -<strong>v</strong> ] [ -<strong>V</strong> ]
57      [ -<strong>X</strong> ] [ -<strong>M</strong> ] [ -<strong>T</strong> ]
58      </code></p>
59
60      <p>On <a href="../platform/windows.html">Windows systems</a>, the
61      following additional arguments are available:</p>
62
63      <p><code><strong>httpd</strong> [ -<strong>k</strong>
64      install|config|uninstall ] [ -<strong>n</strong> <var>name</var> ]
65      [ -<strong>w</strong> ]</code></p>
66 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
67 <div class="section">
68 <h2><a name="options" id="options">Options</a></h2>
69
70 <dl>
71 <dt><code>-d <var>serverroot</var></code></dt>
72
73 <dd>Set the initial value for the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code> directive to
74 <var>serverroot</var>.  This can be overridden by the ServerRoot
75 directive in the configuration file. The default is
76 <code>/usr/local/apache2</code>.</dd>
77
78 <dt><code>-f <var>config</var></code></dt>
79
80 <dd>Uses the directives in the file <var>config</var> on startup. If
81 <var>config</var> does not begin with a /, then it is taken to be a
82 path relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>. The default is
83 <code>conf/httpd.conf</code>.</dd>
84
85 <dt><code>-k <code>start|restart|graceful|stop|graceful-stop</code></code></dt>
86
87 <dd>Signals <code>httpd</code> to start, restart, or stop.  See <a href="../stopping.html">Stopping Apache httpd</a> for more information.</dd>
88
89 <dt><code>-C <var>directive</var></code></dt>
90
91 <dd>Process the configuration <var>directive</var> before reading
92 config files.</dd>
93
94 <dt><code>-c <var>directive</var></code></dt>
95
96 <dd>Process the configuration <var>directive</var> after reading config
97 files.</dd>
98
99
100 <dt><code>-D <var>parameter</var></code></dt>
101
102 <dd>Sets a configuration <var>parameter </var>which can be used with
103 <code class="directive"><a href="../mod/core.html#ifdefine">&lt;IfDefine&gt;</a></code> sections
104 in the configuration files to conditionally skip or process commands
105 at server startup and restart. Also can be used to set certain
106 less-common startup parameters including <code>-DNO_DETACH</code>
107 (prevent the parent from forking) and <code>-DFOREGROUND</code>
108 (prevent the parent from calling <code>setsid()</code> et al).</dd>
109
110 <dt><code>-e <var>level</var></code></dt>
111
112 <dd>Sets the <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> to
113 <var>level</var> during server startup.  This is useful for
114 temporarily increasing the verbosity of the error messages to find
115 problems during startup.</dd>
116
117 <dt><code>-E <var>file</var></code></dt>
118
119 <dd>Send error messages during server startup to <var>file</var>.</dd>
120
121 <dt><code>-h</code></dt>
122
123 <dd>Output a short summary of available command line options.</dd>
124
125 <dt><code>-l</code></dt>
126
127 <dd>Output a list of modules compiled into the server.  This will
128 <strong>not</strong> list dynamically loaded modules included using
129 the <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code> directive.</dd>
130
131 <dt><code>-L</code></dt>
132
133 <dd>Output a list of directives provided by static modules, together with expected arguments and
134 places where the directive is valid. Directives provided by shared modules are not listed.</dd>
135
136 <dt><code>-M</code></dt>
137
138 <dd>Dump a list of loaded Static and Shared Modules.</dd>
139
140 <dt><code>-S</code></dt>
141
142 <dd>Show the settings as parsed from the config file (currently only
143 shows the virtualhost settings).</dd>
144
145 <dt><code>-T</code> (Available in 2.3.8 and later)</dt>
146
147 <dd>Skip document root check at startup/restart.</dd>
148
149 <dt><code>-t</code></dt>
150
151 <dd>Run syntax tests for configuration files only.  The program
152 immediately exits after these syntax parsing tests with either a return code
153 of 0 (Syntax OK) or return code not equal to 0 (Syntax Error).  If -D
154 <var>DUMP</var>_<var>VHOSTS </var>is also set, details of the virtual host
155 configuration will be printed. If -D <var>DUMP</var>_<var>MODULES </var> is
156 set, all loaded modules will be printed. If -D <var>DUMP</var>_<var>CERTS </var>
157 is set and <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is used, configured SSL certificates will
158 be printed.  If -D <var>DUMP</var>_<var>CA</var>_<var>_CERTS </var> is set and
159 <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is used, configured SSL CA certificates and configured
160 directories containing SSL CA certificates will be printed.</dd>
161
162 <dt><code>-v</code></dt>
163
164 <dd>Print the version of <code>httpd</code>, and then exit.</dd>
165
166 <dt><code>-V</code></dt>
167
168 <dd>Print the version and build parameters of <code>httpd</code>, and
169 then exit.</dd>
170
171 <dt><code>-X</code></dt>
172
173 <dd>Run httpd in debug mode.  Only one worker will be started and the
174 server will not detach from the console.</dd>
175
176 </dl>
177
178 <p>The following arguments are available only on the <a href="../platform/windows.html">Windows platform</a>:</p>
179
180 <dl>
181
182 <dt><code>-k install|config|uninstall</code></dt>
183
184 <dd>Install Apache httpd as a Windows NT service; change startup options for
185 the Apache httpd service; and uninstall the Apache httpd service.</dd>
186
187 <dt><code>-n <var>name</var></code></dt>
188
189 <dd>The <var>name</var> of the Apache httpd service to signal.</dd>
190
191 <dt><code>-w</code></dt>
192
193 <dd>Keep the console window open on error so that the error message can
194 be read.</dd>
195
196 </dl>
197
198 </div></div>
199 <div class="bottomlang">
200 <p><span>Available Languages: </span><a href="../en/programs/httpd.html" title="English">&nbsp;en&nbsp;</a> |
201 <a href="../ko/programs/httpd.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
202 <a href="../tr/programs/httpd.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
203 </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&amp;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>
204 <script type="text/javascript"><!--//--><![CDATA[//><!--
205 var comments_shortname = 'httpd';
206 var comments_identifier = 'http://httpd.apache.org/docs/trunk/programs/httpd.html';
207 (function(w, d) {
208     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
209         d.write('<div id="comments_thread"><\/div>');
210         var s = d.createElement('script');
211         s.type = 'text/javascript';
212         s.async = true;
213         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
214         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
215     }
216     else {
217         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
218     }
219 })(window, document);
220 //--><!]]></script></div><div id="footer">
221 <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>
222 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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[//><!--
223 if (typeof(prettyPrint) !== 'undefined') {
224     prettyPrint();
225 }
226 //--><!]]></script>
227 </body></html>