Commit 934e31cf authored by Rainer Jung's avatar Rainer Jung
Browse files

Add information about "||" piped log syntax 

to the docs.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.2.x@989598 13f79535-47bb-0310-9956-ffa450edef68
parent f77c1120

docs/manual/logs.xml

+16 −0
Changes for docs/manual/logs.xml: 16 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -513,6 +513,22 @@ 
    <p>As with conditional logging, piped logs are a very powerful

    tool, but they should not be used where a simpler solution like

    off-line post-processing is available.</p>



    <p>By default the piped log process is spawned using a shell.

    (usually with <code>/bin/sh -c</code>).

    Depending on the shell specifics invocation via shell might

    lead to an additional shell process for the lifetime of the

    logging pipe program and signal handling problems during

    restart.</p>



    <p>Use "<code>||</code>" instead of "<code>|</code>"

    to spawn without invoking a shell:</p>



    <example>

      # Invoke "rotatelogs" without using a shell<br />

      CustomLog "||/usr/local/apache/bin/rotatelogs

      /var/log/access_log 86400" common

    </example>

  </section>



  <section id="virtualhost">

docs/manual/mod/core.xml

+5 −2
Changes for docs/manual/mod/core.xml: 5 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -1098,13 +1098,16 @@ in case of an error</description> 
    </example>



    <p>If the <var>file-path</var>

    begins with a pipe (|) then it is assumed to be a command to spawn

    to handle the error log.</p>

    begins with a pipe character "<code>|</code>" then it is assumed to be a

    command to spawn to handle the error log.</p>



    <example><title>Example</title>

    ErrorLog "|/usr/local/bin/httpd_errors"

    </example>



    <p>See the notes on <a href="../logs.html#piped">piped logs</a> for

    more information.</p>



    <p>Using <code>syslog</code> instead of a filename enables logging

    via syslogd(8) if the system supports it. The default is to use

    syslog facility <code>local7</code>, but you can override this by

docs/manual/mod/mod_log_config.xml

+2 −1
Changes for docs/manual/mod/mod_log_config.xml: 2 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -377,7 +377,8 @@ 
      <dt><var>pipe</var></dt>

      <dd>The pipe character "<code>|</code>", followed by the path

      to a program to receive the log information on its standard

      input.

      input. See the notes on <a href="../logs.html#piped">piped logs</a>

      for more information.



      <note type="warning"><title>Security:</title>

      <p>If a program is used, then it will be run as the user who