/usr/share/doc/liblog4tango-doc/html/api/classlog4tango_1_1PatternLayout.html is in liblog4tango-doc 9.2.5a+dfsg1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>log4tango: log4tango::PatternLayout Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">log4tango
 <span id="projectnumber">5.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4tango.html">log4tango</a></li><li class="navelem"><a class="el" href="classlog4tango_1_1PatternLayout.html">PatternLayout</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="classlog4tango_1_1PatternLayout-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">log4tango::PatternLayout Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="PatternLayout_8hh_source.html">PatternLayout.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for log4tango::PatternLayout:</div>
<div class="dyncontent">
<div class="center">
<img src="classlog4tango_1_1PatternLayout.png" usemap="#log4tango::PatternLayout_map" alt=""/>
<map id="log4tango::PatternLayout_map" name="log4tango::PatternLayout_map">
<area href="classlog4tango_1_1Layout.html" alt="log4tango::Layout" shape="rect" coords="0,0,151,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1PatternLayout_1_1PatternComponent.html">PatternComponent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a16f0799306962ff3fc4eeda8ca4d7e2b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1PatternLayout.html#a16f0799306962ff3fc4eeda8ca4d7e2b">PatternLayout</a> ()</td></tr>
<tr class="separator:a16f0799306962ff3fc4eeda8ca4d7e2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a7d2df88df11eba3b9d800cbcbaf8f4"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1PatternLayout.html#a6a7d2df88df11eba3b9d800cbcbaf8f4">~PatternLayout</a> ()</td></tr>
<tr class="separator:a6a7d2df88df11eba3b9d800cbcbaf8f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a127f7708ad24a3290d3c6cbe29257020"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1PatternLayout.html#a127f7708ad24a3290d3c6cbe29257020">format</a> (const <a class="el" href="structlog4tango_1_1LoggingEvent.html">LoggingEvent</a> &event)</td></tr>
<tr class="memdesc:a127f7708ad24a3290d3c6cbe29257020"><td class="mdescLeft"> </td><td class="mdescRight">Formats the <a class="el" href="structlog4tango_1_1LoggingEvent.html" title="The internal representation of logging events. ">LoggingEvent</a> in the style set by the set_conversion_pattern call. <a href="#a127f7708ad24a3290d3c6cbe29257020">More...</a><br /></td></tr>
<tr class="separator:a127f7708ad24a3290d3c6cbe29257020"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a893fc5d34dad85771c45cd081c932b"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1PatternLayout.html#a0a893fc5d34dad85771c45cd081c932b">set_conversion_pattern</a> (const std::string &conversionPattern)</td></tr>
<tr class="memdesc:a0a893fc5d34dad85771c45cd081c932b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the format of log lines handled by this <a class="el" href="classlog4tango_1_1PatternLayout.html">PatternLayout</a>. <a href="#a0a893fc5d34dad85771c45cd081c932b">More...</a><br /></td></tr>
<tr class="separator:a0a893fc5d34dad85771c45cd081c932b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63d623584c317efbdd70e5fa920e7bc1"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1PatternLayout.html#a63d623584c317efbdd70e5fa920e7bc1">get_conversion_pattern</a> () const</td></tr>
<tr class="separator:a63d623584c317efbdd70e5fa920e7bc1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a668d59b015305affebfbefef0cedb4b9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1PatternLayout.html#a668d59b015305affebfbefef0cedb4b9">clear_conversion_pattern</a> ()</td></tr>
<tr class="separator:a668d59b015305affebfbefef0cedb4b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classlog4tango_1_1Layout"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4tango_1_1Layout')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classlog4tango_1_1Layout.html">log4tango::Layout</a></td></tr>
<tr class="memitem:a053084d0c22a45a3304a75f7b0c5de39 inherit pub_methods_classlog4tango_1_1Layout"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1Layout.html#a053084d0c22a45a3304a75f7b0c5de39">Layout</a> ()</td></tr>
<tr class="memdesc:a053084d0c22a45a3304a75f7b0c5de39 inherit pub_methods_classlog4tango_1_1Layout"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classlog4tango_1_1Layout.html">Layout</a>. <a href="classlog4tango_1_1Layout.html#a053084d0c22a45a3304a75f7b0c5de39">More...</a><br /></td></tr>
<tr class="separator:a053084d0c22a45a3304a75f7b0c5de39 inherit pub_methods_classlog4tango_1_1Layout"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3298877b40a255b5723a6cfa58e00ea inherit pub_methods_classlog4tango_1_1Layout"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1Layout.html#ae3298877b40a255b5723a6cfa58e00ea">~Layout</a> ()</td></tr>
<tr class="memdesc:ae3298877b40a255b5723a6cfa58e00ea inherit pub_methods_classlog4tango_1_1Layout"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classlog4tango_1_1Layout.html">Layout</a>. <a href="classlog4tango_1_1Layout.html#ae3298877b40a255b5723a6cfa58e00ea">More...</a><br /></td></tr>
<tr class="separator:ae3298877b40a255b5723a6cfa58e00ea inherit pub_methods_classlog4tango_1_1Layout"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a8d601a7465e1e7c5b83fc87a1a68cd37"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4tango_1_1PatternLayout.html#a8d601a7465e1e7c5b83fc87a1a68cd37">BASIC_CONVERSION_PATTERN</a> = "%R %p %c %m%n"</td></tr>
<tr class="memdesc:a8d601a7465e1e7c5b83fc87a1a68cd37"><td class="mdescLeft"> </td><td class="mdescRight">A conversion pattern equivalent to the BasicLayout. <a href="#a8d601a7465e1e7c5b83fc87a1a68cd37">More...</a><br /></td></tr>
<tr class="separator:a8d601a7465e1e7c5b83fc87a1a68cd37"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a16f0799306962ff3fc4eeda8ca4d7e2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16f0799306962ff3fc4eeda8ca4d7e2b">◆ </a></span>PatternLayout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4tango::PatternLayout::PatternLayout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6a7d2df88df11eba3b9d800cbcbaf8f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a7d2df88df11eba3b9d800cbcbaf8f4">◆ </a></span>~PatternLayout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">log4tango::PatternLayout::~PatternLayout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a668d59b015305affebfbefef0cedb4b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a668d59b015305affebfbefef0cedb4b9">◆ </a></span>clear_conversion_pattern()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4tango::PatternLayout::clear_conversion_pattern </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a127f7708ad24a3290d3c6cbe29257020"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a127f7708ad24a3290d3c6cbe29257020">◆ </a></span>format()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string log4tango::PatternLayout::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlog4tango_1_1LoggingEvent.html">LoggingEvent</a> & </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Formats the <a class="el" href="structlog4tango_1_1LoggingEvent.html" title="The internal representation of logging events. ">LoggingEvent</a> in the style set by the set_conversion_pattern call. </p>
<p>By default, set to "%%m%%n" </p>
<p>Reimplemented from <a class="el" href="classlog4tango_1_1Layout.html#a0ade719b2ab1ce512aca5699f136eb8b">log4tango::Layout</a>.</p>
</div>
</div>
<a id="a63d623584c317efbdd70e5fa920e7bc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63d623584c317efbdd70e5fa920e7bc1">◆ </a></span>get_conversion_pattern()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string log4tango::PatternLayout::get_conversion_pattern </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0a893fc5d34dad85771c45cd081c932b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a893fc5d34dad85771c45cd081c932b">◆ </a></span>set_conversion_pattern()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int log4tango::PatternLayout::set_conversion_pattern </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>conversionPattern</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the format of log lines handled by this <a class="el" href="classlog4tango_1_1PatternLayout.html">PatternLayout</a>. </p>
<p>By default, set to "%%m%%n".<br />
Format characters are as follows:<br />
</p><ul>
<li>
<b>%%%%</b> - a single percent sign </li>
<li>
<b>%c</b> - the logger </li>
<li>
<b>%d</b> - the date<br />
Date format: The date format character may be followed by a date format specifier enclosed between braces. For example, %d{%H:%M:%S,%l} or %d{%d %m %Y %H:%M:%S,%l}. If no date format specifier is given then the following format is used: "Wed Jan 02 02:03:55 1980". The date format specifier admits the same syntax as the ANSI C function strftime, with 1 addition. The addition is the specifier %l for milliseconds, padded with zeros to make 3 digits. </li>
<li>
<b>%m</b> - the message </li>
<li>
<b>%n</b> - the platform specific line separator </li>
<li>
<b>%p</b> - the level </li>
<li>
<b>%r</b> - milliseconds since this layout was created. </li>
<li>
<b>%R</b> - seconds since Jan 1, 1970 </li>
<li>
<b>%u</b> - clock ticks since process start </li>
<li>
<b>%x</b> - the NDC </li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">conversionPattern</td><td>the conversion pattern </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">ConfigureFailure</td><td>if the pattern is invalid </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8d601a7465e1e7c5b83fc87a1a68cd37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d601a7465e1e7c5b83fc87a1a68cd37">◆ </a></span>BASIC_CONVERSION_PATTERN</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char * log4tango::PatternLayout::BASIC_CONVERSION_PATTERN = "%R %p %c %m%n"</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A conversion pattern equivalent to the BasicLayout. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="PatternLayout_8hh_source.html">PatternLayout.hh</a></li>
<li><a class="el" href="PatternLayout_8cpp.html">PatternLayout.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|