Skip to content

Commit

Permalink
add doc for #1208
Browse files Browse the repository at this point in the history
  • Loading branch information
kazuho committed Mar 14, 2017
1 parent b4d89f2 commit 72a9cb6
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions srcdoc/configure/access_log_directives.mt
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,21 @@ EOT

<p>
If the supplied argument is a mapping, its <code>path</code> property is considered as the path of the log file or the pipe command, and the <code>format</code> property is treated as the format of the log file.
Starting from version 2.2, <code>escape</code> property can be used to specify the escape sequence that should be used to emit unsafe octets.
</p>

<p>
Two forms of escape sequences are supported.
If <code>apache</code> is specified as the value of the <code>escape</code> property, unsafe octets are emitted in the form of <code>\xNN</code>, where N is a hexadecimal number in lower case.
If <code>json</code> is specified, unsafe octets are emitted in the form of <code>\u00NN</code>.
<code>apache</code> is the default escape method.
</p>

<?= $ctx->{example}->('Emit access log to file using Common Log Format', <<'EOT')
access-log:
path: /path/to/access-log-file
format: "%h %l %u %t \"%r\" %s %b"
escape: apache
EOT
?>

Expand Down

0 comments on commit 72a9cb6

Please sign in to comment.