Commit 46351918 authored by Jim Jagielski's avatar Jim Jagielski
Browse files

start documenting those that use the time-interval format 

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1799460 13f79535-47bb-0310-9956-ffa450edef68
parent e90ead75

docs/manual/mod/core.xml

+2 −2
Original line number Diff line number Diff line
@@ -2635,7 +2635,7 @@ the server configuration files</description> 
<name>KeepAliveTimeout</name>

<description>Amount of time the server will wait for subsequent

requests on a persistent connection</description>

<syntax>KeepAliveTimeout <var>num</var>[ms]</syntax>

<syntax>KeepAliveTimeout <var>time-interval</var>[s]</syntax>

<default>KeepAliveTimeout 5</default>

<contextlist><context>server config</context><context>virtual host</context>

</contextlist>
@@ -4770,7 +4770,7 @@ server</description> 
<name>TimeOut</name>

<description>Amount of time the server will wait for

certain events before failing a request</description>

<syntax>TimeOut <var>seconds</var></syntax>

<syntax>TimeOut <var>time-interval</var>[s]</syntax>

<default>TimeOut 60</default>

<contextlist><context>server config</context><context>virtual host</context></contextlist>

docs/manual/mod/mod_proxy.xml

+7 −6
Original line number Diff line number Diff line
@@ -1093,7 +1093,7 @@ ProxyPass "/example" "http://backend.example.com" max=20 ttl=120 retry=300 
    <tr><td>flushwait</td>

        <td>10</td>

        <td>The time to wait for additional input, in milliseconds, before

        flushing the output brigade if 'flushpackets' is 'auto'.

        flushing the output brigade if 'flushpackets' is 'auto'. Uses time-interval directive syntax.

    </td></tr>

    <tr><td>iobuffersize</td>

        <td>8192</td>
@@ -1112,7 +1112,7 @@ ProxyPass "/example" "http://backend.example.com" max=20 ttl=120 retry=300 
    <p>The frequency of initial and subsequent TCP keepalive probes

    depends on global OS settings, and may be as high as 2 hours. To be useful,

    the frequency configured in the OS must be smaller than the threshold used

    by the firewall.</p>

    by the firewall. Uses time-interval directive syntax.</p>

    </td></tr>

    <tr><td>lbset</td>

        <td>0</td>
@@ -1139,7 +1139,7 @@ ProxyPass "/example" "http://backend.example.com" max=20 ttl=120 retry=300 
        which could be an issue, but it will lower the

        traffic in case some of the cluster nodes are down or busy.

        By adding a postfix of ms, the delay can be also set in

        milliseconds.

        milliseconds. Uses time-interval directive syntax.

    </td></tr>

    <tr><td>receivebuffersize</td>

        <td>0</td>
@@ -1163,7 +1163,7 @@ ProxyPass "/example" "http://backend.example.com" max=20 ttl=120 retry=300 
    Apache httpd will not forward any requests to that server until the timeout

    expires. This enables to shut down the backend server for maintenance

    and bring it back online later. A value of 0 means always retry workers

    in an error state with no timeout.

    in an error state with no timeout. Uses time-interval directive syntax.

    </td></tr>

    <tr><td>route</td>

        <td>-</td>
@@ -1195,13 +1195,14 @@ ProxyPass "/example" "http://backend.example.com" max=20 ttl=120 retry=300 
        <td><directive module="mod_proxy">ProxyTimeout</directive></td>

        <td>Connection timeout in seconds.

        The number of seconds Apache httpd waits for data sent by / to the backend.

        Uses time-interval directive syntax.

    </td></tr>

    <tr><td>ttl</td>

        <td>-</td>

        <td>Time to live for inactive connections and associated connection

        pool entries, in seconds.  Once reaching this limit, a

        connection will not be used again; it will be closed at some

        later time.

        later time. Uses time-interval directive syntax.

    </td></tr>

    <tr><td>flusher</td>

        <td>flush</td>
@@ -1279,7 +1280,7 @@ ProxyPass "/example" "http://backend.example.com" max=20 ttl=120 retry=300 
    <tr><td>timeout</td>

        <td>0</td>

        <td>Balancer timeout in seconds. If set, this will be the maximum time

        to wait for a free worker. The default is to not wait.

        to wait for a free worker. The default is to not wait. Uses time-interval directive syntax.

    </td></tr>

    <tr><td>failonstatus</td>

        <td>-</td>

docs/manual/mod/mod_proxy_hcheck.xml

+1 −1
Original line number Diff line number Diff line
@@ -78,7 +78,7 @@ 
        <td>Number of failed health check tests before worker is disabled</td></tr>

    <tr><td>hcinterval</td>

        <td>30</td>

        <td>Period of health checks in seconds (e.g. performed every 30 seconds)</td></tr>

        <td>Period of health checks in seconds (e.g. performed every 30 seconds). Uses time-interval directive syntax. </td></tr>

    <tr><td>hcuri</td>

        <td>&nbsp;</td>

        <td>Additional URI to be appended to the worker URL for the health check.</td></tr>

docs/manual/mod/mod_watchdog.xml

+1 −1
Original line number Diff line number Diff line
@@ -48,7 +48,7 @@ core or, if a dynamic module, be loaded before the calling module. 
<directivesynopsis>

<name>WatchdogInterval</name>

<description>Watchdog interval in seconds</description>

<syntax>WatchdogInterval <var>number-of-seconds</var></syntax>

<syntax>WatchdogInterval <var>time-interval</var>[s]</syntax>

<default>WatchdogInterval 1</default>

<contextlist><context>server config</context></contextlist>