You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by mi...@apache.org on 2016/07/25 15:57:05 UTC

[36/50] [abbrv] logging-log4j2 git commit: Docs.

Docs.

Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/f6e2f367
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/f6e2f367
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/f6e2f367

Branch: refs/heads/LOG4J-1181
Commit: f6e2f367b5f51fef4831de4dd848cc3eb5158223
Parents: 863c61a
Author: Gary Gregory <gg...@apache.org>
Authored: Fri Jul 15 17:56:19 2016 -0700
Committer: Gary Gregory <gg...@apache.org>
Committed: Fri Jul 15 17:56:19 2016 -0700

----------------------------------------------------------------------
 src/site/xdoc/manual/layouts.xml.vm | 45 +++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/f6e2f367/src/site/xdoc/manual/layouts.xml.vm
----------------------------------------------------------------------
diff --git a/src/site/xdoc/manual/layouts.xml.vm b/src/site/xdoc/manual/layouts.xml.vm
index 752f8c4..894709b 100644
--- a/src/site/xdoc/manual/layouts.xml.vm
+++ b/src/site/xdoc/manual/layouts.xml.vm
@@ -1439,7 +1439,12 @@ WARN  [main]: Message 2</pre>
                 &nbsp;&nbsp;{<br/>
                 &nbsp;&nbsp;&nbsp;&nbsp;["none"|"short"|"full"|depth]<br/>
                 &nbsp;&nbsp;&nbsp;&nbsp;[,filters(package,package,...)]<br/>
-                &nbsp;&nbsp;}
+                &nbsp;&nbsp;}<br/>
+                &nbsp;&nbsp;{ansi(<br/>
+                &nbsp;&nbsp;&nbsp;&nbsp;Key=Value,Value,...<br/>
+                &nbsp;&nbsp;&nbsp;&nbsp;Key=Value,Value,...<br/>
+                &nbsp;&nbsp;&nbsp;&nbsp;...)<br/>
+                &nbsp;&nbsp;}<br/>
               </td>
               <td>
                 <p>The same as the %throwable conversion word but also includes class packaging information.
@@ -1457,6 +1462,44 @@ WARN  [main]: Message 2</pre>
                   should be suppressed from stack traces. Specifying <b>%xEx{none}</b>
                   or <b>%xEx{0}</b> will suppress printing of the exception.
                 </p>
+                <p>
+                 The <code>ansi</code> option renders stack traces with ANSI escapes code using the JAnsi library.
+                 Use <code>{ansi}</code> to use the default color mapping. You can specify your own mappings with
+                 <code>key=value</code> pairs. The keys are:
+                </p>
+                  <ul>
+                    <li>Prefix</li>
+                    <li>Name</li>
+                    <li>Message</li>
+                    <li>At</li>
+                    <li>CauseLabel</li>
+                    <li>Text</li>
+                    <li>More</li>
+                    <li>Suppressed</li>
+                    <li>StackTraceElement.ClassName</li>
+                    <li>StackTraceElement.ClassMethodSeparator</li>
+                    <li>StackTraceElement.MethodName</li>
+                    <li>StackTraceElement.NativeMethod</li>
+                    <li>StackTraceElement.FileName</li>
+                    <li>StackTraceElement.LineNumber</li>
+                    <li>StackTraceElement.Container</li>
+                    <li>StackTraceElement.ContainerSeparator</li>
+                    <li>StackTraceElement.UnknownSource</li>
+                    <li>ExtraClassInfo.Inexact</li>
+                    <li>ExtraClassInfo.Container</li>
+                    <li>ExtraClassInfo.ContainerSeparator</li>
+                    <li>ExtraClassInfo.Location</li>
+                    <li>ExtraClassInfo.Version</li>                   
+                  </ul> 
+                <p>
+                  The values are names from JAnsi's 
+                  <a href="https://fusesource.github.io/jansi/documentation/api/org/fusesource/jansi/AnsiRenderer.Code.html">Code</a>
+                  class like <code>blue</code>, <code>bg_red</code>, and so on (Log4j ignores case.)                  
+                </p>
+                <p>
+                  The special key <code>StyleMapName</code> can be set to one of the following prefedined maps: 
+                  <code>Spock</code>, <code>Kirk</code>.
+                </p>
               </td>
             </tr>
             <tr>