]> granicus.if.org Git - apache/blob - docs/manual/programs/httpd.html.en
Update docs and transforms
[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         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5               This file is generated from xml source: DO NOT EDIT
6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7       -->
8 <title>httpd - Apache Hypertext Transfer Protocol Server - Apache HTTP Server</title>
9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
13 <body id="manual-page"><div id="page-header">
14 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
15 <p class="apache">Apache HTTP Server Version 2.3</p>
16 <img alt="" src="../images/feather.gif" /></div>
17 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
18 <div id="path">
19 <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.3</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>httpd - Apache Hypertext Transfer Protocol Server</h1>
20 <div class="toplang">
21 <p><span>Available Languages: </span><a href="../en/programs/httpd.html" title="English">&nbsp;en&nbsp;</a> |
22 <a href="../ko/programs/httpd.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
23 </div>
24
25      <p><code>httpd</code> is the Apache HyperText Transfer Protocol
26      (HTTP) server program.  It is designed to be run as a standalone
27      daemon process. When used like this it will create a pool of
28      child processes or threads to handle requests.</p>
29
30      <p>In general, <code>httpd</code> should not be invoked directly,
31      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,
32      2000 and XP</a> and <a href="../platform/windows.html#wincons">as
33      a console application on Windows 9x and ME</a>.</p>
34 </div>
35 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
36 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
37 </ul><h3>See also</h3><ul class="seealso"><li><a href="../invoking.html">Starting Apache</a></li><li><a href="../stopping.html">Stopping Apache</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></ul></div>
38 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
39 <div class="section">
40 <h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
41      <p><code><strong>httpd</strong> [ -<strong>d</strong>
42      <var>serverroot</var> ] [ -<strong>f</strong> <var>config</var> ]
43      [ -<strong>C</strong> <var>directive</var> ] [ -<strong>c</strong>
44      <var>directive</var> ] [ -<strong>D</strong> <var>parameter</var> ]
45      [ -<strong>e</strong> <var>level</var> ] [ -<strong>E</strong>
46      <var>file</var> ] 
47      [ <strong>-k</strong> start|restart|graceful|stop|graceful-stop ]
48      [ -<strong>R</strong> <var>directory</var> ] [ -<strong>h</strong> ]
49      [ -<strong>l</strong> ] [ -<strong>L</strong> ] [ -<strong>S</strong> ]
50      [ -<strong>t</strong> ] [ -<strong>v</strong> ] [ -<strong>V</strong> ]
51      [ -<strong>X</strong> ] [ -<strong>M</strong> ]</code></p>
52
53      <p>On <a href="../platform/windows.html">Windows systems</a>, the
54      following additional arguments are available:</p>
55
56      <p><code><strong>httpd</strong> [ -<strong>k</strong>
57      install|config|uninstall ] [ -<strong>n</strong> <var>name</var> ]
58      [ -<strong>w</strong> ]</code></p>
59 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
60 <div class="section">
61 <h2><a name="options" id="options">Options</a></h2>
62
63 <dl>
64 <dt><code>-d <var>serverroot</var></code></dt>
65
66 <dd>Set the initial value for the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code> directive to
67 <var>serverroot</var>.  This can be overridden by the ServerRoot
68 directive in the configuration file. The default is
69 <code>/usr/local/apache2</code>.</dd>
70
71 <dt><code>-f <var>config</var></code></dt>
72
73 <dd>Uses the directives in the file <var>config</var> on startup. If
74 <var>config</var> does not begin with a /, then it is taken to be a
75 path relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>. The default is
76 <code>conf/httpd.conf</code>.</dd>
77
78 <dt><code>-k <code>start|restart|graceful|stop|graceful-stop</code></code></dt>
79
80 <dd>Signals <code>httpd</code> to start, restart, or stop.  See <a href="../stopping.html">Stopping Apache</a> for more information.</dd>
81
82 <dt><code>-C <var>directive</var></code></dt>
83
84 <dd>Process the configuration <var>directive</var> before reading
85 config files.</dd>
86
87 <dt><code>-c <var>directive</var></code></dt>
88
89 <dd>Process the configuration <var>directive</var> after reading config
90 files.</dd>
91
92
93 <dt><code>-D <var>parameter</var></code></dt>
94
95 <dd>Sets a configuration <var>parameter </var>which can be used with
96 <code class="directive"><a href="../mod/core.html#ifdefine">&lt;IfDefine&gt;</a></code> sections
97 in the configuration files to conditionally skip or process
98 commands at server startup and restart.</dd>
99
100 <dt><code>-e <var>level</var></code></dt>
101
102 <dd>Sets the <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> to
103 <var>level</var> during server startup.  This is useful for
104 temporarily increasing the verbosity of the error messages to find
105 problems during startup.</dd>
106
107 <dt><code>-E <var>file</var></code></dt>
108
109 <dd>Send error messages during server startup to <var>file</var>.</dd>
110
111 <dt><code>-R <var>directory</var></code></dt>
112
113 <dd>When the server is compiled using the <code>SHARED_CORE</code>
114 rule, this specifies the <var>directory</var> for the shared
115 object files.</dd>
116
117 <dt><code>-h</code></dt>
118
119 <dd>Output a short summary of available command line options.</dd>
120
121 <dt><code>-l</code></dt>
122
123 <dd>Output a list of modules compiled into the server.  This will
124 <strong>not</strong> list dynamically loaded modules included using
125 the <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code> directive.</dd>
126
127 <dt><code>-L</code></dt>
128
129 <dd>Output a list of directives provided by static modules, together with expected arguments and
130 places where the directive is valid. Directives provided by shared modules are not listed.</dd>
131
132 <dt><code>-M</code></dt>
133
134 <dd>Dump a list of loaded Static and Shared Modules.</dd>
135
136 <dt><code>-S</code></dt>
137
138 <dd>Show the settings as parsed from the config file (currently only
139 shows the virtualhost settings).</dd>
140
141 <dt><code>-t</code></dt>
142
143 <dd>Run syntax tests for configuration files only.  The program
144 immediately exits after these syntax parsing tests with either a return code
145 of 0 (Syntax OK) or return code not equal to 0 (Syntax Error).  If -D
146 <var>DUMP</var>_<var>VHOSTS </var>is also set, details of the virtual host
147 configuration will be printed. If -D <var>DUMP</var>_<var>MODULES </var> is
148 set, all loaded modules will be printed.</dd>
149
150 <dt><code>-v</code></dt>
151
152 <dd>Print the version of <code>httpd</code>, and then exit.</dd>
153
154 <dt><code>-V</code></dt>
155
156 <dd>Print the version and build parameters of <code>httpd</code>, and
157 then exit.</dd>
158
159 <dt><code>-X</code></dt>
160
161 <dd>Run httpd in debug mode.  Only one worker will be started and the
162 server will not detach from the console.</dd>
163
164 </dl>
165
166 <p>The following arguments are available only on the <a href="../platform/windows.html">Windows platform</a>:</p>
167
168 <dl>
169
170 <dt><code>-k install|config|uninstall</code></dt>
171
172 <dd>Install Apache as a Windows NT service; change startup options for
173 the Apache service; and uninstall the Apache service.</dd>
174
175 <dt><code>-n <var>name</var></code></dt>
176
177 <dd>The <var>name</var> of the Apache service to signal.</dd>
178
179 <dt><code>-w</code></dt>
180
181 <dd>Keep the console window open on error so that the error message can 
182 be read.</dd>
183
184 </dl>
185
186 </div></div>
187 <div class="bottomlang">
188 <p><span>Available Languages: </span><a href="../en/programs/httpd.html" title="English">&nbsp;en&nbsp;</a> |
189 <a href="../ko/programs/httpd.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
190 </div><div id="footer">
191 <p class="apache">Copyright 2006 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>
192 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
193 </body></html>