11b0ed9
11b0ed9
11b0ed9
  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">[
11b0ed9
11b0ed9
]>
11b0ed9
11b0ed9
 Copyright 2018 Red Hat, Inc.
11b0ed9
11b0ed9
 Licensed to the Apache Software Foundation (ASF) under one or more
11b0ed9
 contributor license agreements. See the NOTICE file distributed with
11b0ed9
 this work for additional information regarding copyright ownership.
11b0ed9
 The ASF licenses this file to You under the Apache License, Version 2.0
11b0ed9
 (the "License"); you may not use this file except in compliance with
11b0ed9
 the License. You may obtain a copy of the License at
11b0ed9
11b0ed9
     http://www.apache.org/licenses/LICENSE-2.0
11b0ed9
11b0ed9
 Unless required by applicable law or agreed to in writing, software
11b0ed9
 distributed under the License is distributed on an "AS IS" BASIS,
11b0ed9
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11b0ed9
 See the License for the specific language governing permissions and
11b0ed9
 limitations under the License.
11b0ed9
-->
11b0ed9
<refentry>
11b0ed9
  <refentryinfo>
11b0ed9
    <title>apachectl</title>
11b0ed9
    <productname>httpd</productname>
11b0ed9
    <corpauthor>Apache Software Foundation</corpauthor>
11b0ed9
    <editor><contrib>Fedora man page</contrib><surname>Dana</surname><firstname>Frank</firstname><email>ferdnyc@gmail.com</email></editor>
11b0ed9
  </refentryinfo>
11b0ed9
11b0ed9
  <refmeta>
11b0ed9
    <refentrytitle>apachectl</refentrytitle>
11b0ed9
    <manvolnum>8</manvolnum>
11b0ed9
  </refmeta>
11b0ed9
11b0ed9
  <refnamediv>
11b0ed9
    <refname>apachectl</refname>
11b0ed9
    <refpurpose>Server control interface for httpd</refpurpose>
11b0ed9
  </refnamediv>
11b0ed9
11b0ed9
  <refsynopsisdiv id='synopsis'>
11b0ed9
    <cmdsynopsis>
11b0ed9
      <command>apachectl</command>
11b0ed9
      <arg choice='opt'><replaceable>command</replaceable> </arg>
11b0ed9
      <sbr/>
11b0ed9
    </cmdsynopsis>
11b0ed9
  </refsynopsisdiv>
11b0ed9
11b0ed9
11b0ed9
  <refsect1 id='description'>
11b0ed9
    <title>DESCRIPTION</title>
11b0ed9
11b0ed9
    <para><command>apachectl</command> is a front end to the Apache HyperText
11b0ed9
    Transfer Protocol (HTTP) server. It is designed to help the
11b0ed9
    administrator control the functioning of the Apache
11b0ed9
    <command>httpd</command> daemon.</para>
11b0ed9
11b0ed9
    <para>The <command>apachectl</command> script takes one-word arguments like
11b0ed9
    <option>start</option>,
11b0ed9
    <option>restart</option>, and
11b0ed9
    <option>stop</option>, and translates them
11b0ed9
    into appropriate signals to <command>httpd</command>.</para>
11b0ed9
11b0ed9
    <para>The <command>apachectl</command> script returns a 0 exit value on
11b0ed9
    success, and >0 if an error occurs.</para>
11b0ed9
11b0ed9
  </refsect1>
11b0ed9
11b0ed9
  <refsect1 id='options'>
11b0ed9
    <title>OPTIONS</title>
11b0ed9
    <variablelist remap='TP'>
11b0ed9
      <varlistentry>
11b0ed9
        <term><option>start</option></term>
11b0ed9
        <listitem>
11b0ed9
          <para>Start the Apache <command>httpd</command> daemon. Gives an error if it
11b0ed9
          is already running. This is equivalent to <command>systemctl start httpd.service</command>.</para>
11b0ed9
        </listitem>
11b0ed9
      </varlistentry>
11b0ed9
11b0ed9
      <varlistentry>
11b0ed9
        <term><option>stop</option></term>
11b0ed9
        <listitem>
11b0ed9
          <para>Stops the Apache <command>httpd</command> daemon. This is equivalent to
11b0ed9
          <command>systemctl stop httpd.service</command>.</para>
11b0ed9
        </listitem>
11b0ed9
      </varlistentry>
11b0ed9
11b0ed9
      <varlistentry>
11b0ed9
        <term><option>restart</option></term>
11b0ed9
        <listitem>
11b0ed9
          <para>Restarts the Apache <command>httpd</command> daemon. If the daemon is
11b0ed9
          not running, it is started. This is equivalent
11b0ed9
          to <command>systemctl restart httpd.service</command>.</para>
11b0ed9
        </listitem>
11b0ed9
      </varlistentry>
11b0ed9
11b0ed9
      <varlistentry>
11b0ed9
        <term><option>status</option></term>
11b0ed9
        <listitem>
11b0ed9
          <para>Displays a brief status report. This is equivalent to <command>systemctl status httpd.service.</command></para>
11b0ed9
        </listitem>
11b0ed9
      </varlistentry>
11b0ed9
11b0ed9
      <varlistentry>
11b0ed9
        <term><option>graceful</option></term>
11b0ed9
        <listitem>
11b0ed9
          <para>Gracefully restarts the Apache <command>httpd</command> daemon. If the
11b0ed9
          daemon is not running, it is started. This differs from a normal
11b0ed9
          restart in that currently open connections are not aborted. A side
11b0ed9
          effect is that old log files will not be closed immediately. This
11b0ed9
          means that if used in a log rotation script, a substantial delay may
11b0ed9
          be necessary to ensure that the old log files are closed before
11b0ed9
          processing them. This is equivalent to
11b0ed9
          <command>systemctl kill --signal=SIGUSR1 --kill-who=main httpd.service</command>.</para>
11b0ed9
        </listitem>
11b0ed9
      </varlistentry>
11b0ed9
11b0ed9
      <varlistentry>
11b0ed9
        <term><option>graceful-stop</option></term>
11b0ed9
        <listitem>
11b0ed9
          <para>Gracefully stops the Apache <command>httpd</command> daemon.
11b0ed9
          This differs from a normal stop in that currently open connections are not
11b0ed9
          aborted. A side effect is that old log files will not be closed immediately.
11b0ed9
          This is equivalent to
11b0ed9
          <command>systemctl kill --signal=SIGWINCH --kill-who=main httpd.service</command>.</para>
11b0ed9
        </listitem>
11b0ed9
      </varlistentry>
11b0ed9
11b0ed9
      <varlistentry>
11b0ed9
        <term><option>configtest</option></term>
11b0ed9
        <listitem>
11b0ed9
          <para>Run a configuration file syntax test. It parses the configuration
11b0ed9
          files and either reports <literal>Syntax Ok</literal>
11b0ed9
          or detailed information about the particular syntax error. This is
11b0ed9
          equivalent to <command>httpd -t</command>.</para>
11b0ed9
        </listitem>
11b0ed9
      </varlistentry>
11b0ed9
    </variablelist>
11b0ed9
11b0ed9
    <para>The following options were available in earlier versions but have been removed.</para>
11b0ed9
11b0ed9
    <variablelist remap='TP'>
11b0ed9
      <varlistentry>
11b0ed9
        <term><option>fullstatus</option></term>
11b0ed9
        <listitem>
11b0ed9
          <para>Displays a full status report from <literal>mod_status</literal>.
11b0ed9
          For this to work, you need to have <literal>mod_status</literal> enabled
11b0ed9
          on your server and a text-based browser such as <command>lynx</command>
11b0ed9
          available on your system. The URL used to access the status report
11b0ed9
          can be set by editing the <literal>STATUSURL</literal> variable in the
11b0ed9
          script.</para>
11b0ed9
        </listitem>
11b0ed9
      </varlistentry>
11b0ed9
11b0ed9
      <varlistentry>
11b0ed9
        <term><option>startssl</option></term>
11b0ed9
        <listitem>
11b0ed9
          <para>To start <command>httpd</command> with SSL support, you should edit
11b0ed9
          your configuration file to include the relevant directives and then
11b0ed9
          use the normal <command>apachectl start</command>.</para>
11b0ed9
        </listitem>
11b0ed9
      </varlistentry>
11b0ed9
    </variablelist>
11b0ed9
  </refsect1>
11b0ed9
11b0ed9
  <refsect1 id='bugs'>
11b0ed9
    <title>BUGS</title>
11b0ed9
    <para>Please report bugs by filing an issue against the "httpd" component of the "Fedora"
11b0ed9
    project, in <ulink url='https://bugzilla.redhat.com/'>RedHat Bugzilla</ulink>.</para>
11b0ed9
  </refsect1>
11b0ed9
11b0ed9
</refentry>