/usr/share/doc/libbobcat2-dev/man/syslogstream.3.html is in libbobcat-dev 2.20.01-1.
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 | <html><head>
<title>FBB::SyslogStream</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::SyslogStream</h1>
<h2>libbobcat1-dev_2.20.01-x.tar.gz</h2>
<h2>2005-2011</h2>
<html><head>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1></h1>
<html><head>
<title>FBB::SyslogStream(3bobcat)</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::SyslogStream(3bobcat)</h1>
<h2>libbobcat1-dev_2.20.01-x.tar.gz Output Stream for Syslog</h2>
<h2>2005-2011</h2>
<p>
<h2>NAME</h2>FBB::SyslogStream - An output stream inserting syslog messages
<p>
<h2>SYNOPSIS</h2>
<strong>#include <bobcat/syslogstream></strong><br>
Linking option: <em>-lbobcat</em>
<p>
<h2>DESCRIPTION</h2>
<strong>FBB::SyslogStream</strong> objects may be used as a <strong>std::ostream</strong> to write
syslog messages using stream facilities.
<p>
<h2>NAMESPACE</h2>
<strong>FBB</strong><br>
All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace <strong>FBB</strong>.
<p>
<h2>INHERITS FROM</h2>
<strong>std::ostream</strong>
<p>
<h2>ENUMERATIONS</h2>
<p>
The following enumerations are defined in the namespace <strong>FBB</strong>:
<p>
<strong>Priority</strong>:
<p>
The values of this enumeration match the corresponding priority
<strong>LOG_xxx</strong> values used with <strong>syslog</strong>(3):
<ul>
<li> <strong>EMERG</strong>:<br>
system is unusable;
<li> <strong>ALERT</strong>:<br>
action must be taken immediately;
<li> <strong>CRIT</strong>:<br>
critical conditions;
<li> <strong>ERR</strong>:<br>
error conditions;
<li> <strong>WARNING</strong>:<br>
warning conditions;
<li> <strong>NOTICE</strong>:<br>
normal, but significant, condition;
<li> <strong>INFO</strong>:<br>
informational message;
<li> <strong>DEBUG</strong>:<br>
debug-level message;
</ul>
<p>
<strong>Facility</strong>:
<p>
The values of this enumeration match the corresponding facility
<strong>LOG_xxx</strong> values used with <strong>syslog</strong>(3):
<ul>
<li> <strong>AUTHPRIV</strong>:<br>
security/authorization messages (private)
<li> <strong>CRON</strong>:<br>
clock daemon (<em>cron</em> and <em>at</em>)
<li> <strong>DAEMON</strong>:<br>
other system daemons
<li> <strong>KERN</strong>:<br>
kernel messages
<li> <strong>LOCAL0</strong>:<br>
reserved for local use. <strong>LOCAL1</strong> through <strong>LOCAL7</strong> are
available as well.
<li> <strong>LPR</strong>:<br>
line printer subsystem
<li> <strong>MAIL</strong>:<br>
mail subsystem
<li> <strong>NEWS</strong>:<br>
<em>USENET</em> news subsystem
<li> <strong>SYSLOGBUF</strong>:<br>
messages generated internally by <em>syslogbufd</em>
<li> <strong>USER</strong>:<br>
generic user-level messages
<li> <strong>UUCP</strong>:<br>
UUCP subsystem
</ul>
<p>
<h2>CONSTRUCTOR</h2>
<ul>
<li> <strong>SyslogStream(char *ident,
FBB::Priority priority = FBB::NOTICE,
FBB::Facility facility = FBB::USER,
int option = 0)</strong>:<br>
This <strong>Syslogstream()</strong> constructor initializes the streamstream. The
<strong>ident</strong> parameter is usually the name of the program. Its contents are
prepended to syslog messages. Use value 0 if no text needs to be
prepended.
<p>
The <strong>priority</strong> parameter determines the importance of the message. By
default <strong>FBB::NOTICE</strong> is used.
<p>
The <strong>facility</strong> parameter determines the type of program doing the
logging. By default <strong>FBB::USER</strong> is used.
<p>
The <strong>option</strong> parameter may be used to specify various options (use the
binary `<em>bitor</em>' (`<em>|</em>') operator to combine options):
<p>
<strong>LOG_CONS</strong>:
write directly to system console if there is an
error while sending to system logger <br>
<strong>LOG_NDELAY</strong>:
open the connection immediately (normally, the con-
nection is opened when the first message is logged) <br>
<strong>LOG_PERROR</strong>:
print to stderr as well <br>
<strong>LOG__PID</strong>:
include PID with each message <br>
<p>
By default no options are used.
</ul>
<p>
The copy constructor is not available.
<p>
<h2>MEMBER FUNCTIONS</h2>
All members of <strong>std::streamstream</strong> are available, as
<strong>FBB::SyslogStream</strong> inherits from this class.
<ul>
<li> <strong>Priority defaultPriority() const</strong>:<br>
Returns the default priority. I.e., the priority that will be used for
the messages after inserting <strong>endl</strong>, unless altered by
<strong>setDefaultPriority()</strong>.
<li> <strong>Priority priority() const</strong>:<br>
Returns the next priority. I.e., the priority that will be used for
the next message, unless altered by <strong>setPriority()</strong>.
<li> <strong>Priority setDefaultPriority(Priority priority)</strong>:<br>
Changes the default priority of the next syslog-message after
inserting <strong>std::eoln</strong>. Initially, the priority is determined as the value
passed to the constructor. The previously active default priority is returned.
<li> <strong>Priority setPriority(Priority priority)</strong>:<br>
Changes the priority for the next syslog message (after <strong>std::eoln</strong>
has been inserted). Subsequent messages will use the default priority
again. The previously active priority setting is returned.
</ul>
<p>
<h2>MANIPULATORS</h2>
<p>
The following set of manipulators are all defined as (static) members of
the class <strong>FBB::SyslogStream</strong>. They may be inserted into an
<strong>FBB::SyslogStream</strong>. Except for the last manipulator
(<strong>strerrno</strong>), they have the following characteristics in common:
<ul>
<li> They will change the priority of the messages that are subsequently
inserted by the <strong>FBB::SyslogStream</strong> object.
<li> When inserting multiple manipulators before the inserted message is
flushed (e.g., using the <strong>ios::flush</strong> or the <strong>ios::endl</strong> manipulators) the
last inserted <strong>FBB::SyslogStream</strong> manipulator will be used.
<li> Nothing happens if the manipulators are not inserted into an
<strong>FBB::SyslogStream</strong> object.
</ul>
Here are the available manipulators:
<ul>
<li> <strong>SyslogStream::alert</strong>:<br>
Messages are inserted with priority <strong>LOG_ALERT</strong>.
<li> <strong>SyslogStream::crit</strong>:<br>
Message are inserted with priority <strong>LOG_CRIT</strong>.
<li> <strong>SyslogStream::debug</strong>:<br>
Messages are inserted with priority <strong>LOG_DEBUG</strong>.
<li> <strong>SyslogStream::emerg</strong>:<br>
Messages are inserted with priority <strong>LOG_EMERG</strong>.
<li> <strong>SyslogStream::err</strong>:<br>
Messages are inserted with priority <strong>LOG_ERR</strong>.
<li> <strong>SyslogStream::info</strong>:<br>
Messages are inserted with priority <strong>LOG_INFO</strong>.
<li> <strong>SyslogStream::notice</strong>:<br>
Messages are inserted with priority <strong>LOG_NOTICE</strong>.
<li> <strong>SyslogStream::strerrno</strong>:<br>
This manipulator inserts the textual interpretation of
<em>std::errno</em>'s current value into a <strong>std::ostream</strong>. Note that the object
into which the manipulator is inserted does not have to be a
<strong>FBB::SyslogStream</strong> object.
<li> <strong>SyslogStream::warning</strong>:<br>
Messages are inserted with priority <strong>LOG_WARNING</strong>.
</ul>
<p>
<h2>EXAMPLE</h2>
<pre>
#include <bobcat/syslogstream>
using namespace std;
using namespace FBB;
int main(int argc, char **argv)
{
SyslogStream sls(argv[0]);
sls << SyslogStream::debug << "Hello world" << endl;
sls << SyslogStream::strerrno << endl;
return 0;
}
</pre>
<p>
<h2>FILES</h2>
<em>bobcat/syslogstream</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
<strong>bobcat</strong>(7), <strong>openlog</strong>(3), <strong>syslog</strong>(3), <strong>syslogstream</strong>(3bobcat)
<p>
<h2>BUGS</h2>
The constructor's <em>option</em> parameter is an <strong>int</strong>. Because of this,
<strong>int</strong> values rather than enumeration values are passed to the
constructor. It is the responsibility of the programmer to pass defined option
values only.
<p>
<h2>DISTRIBUTION FILES</h2>
<ul>
<li> <em>bobcat_2.20.01-x.dsc</em>: detached signature;
<li> <em>bobcat_2.20.01-x.tar.gz</em>: source archive;
<li> <em>bobcat_2.20.01-x_i386.changes</em>: change log;
<li> <em>libbobcat1_2.20.01-x_*.deb</em>: debian package holding the
libraries;
<li> <em>libbobcat1-dev_2.20.01-x_*.deb</em>: debian package holding the
libraries, headers and manual pages;
<li> <em>http://sourceforge.net/projects/bobcat</em>: public archive location;
</ul>
<p>
<h2>BOBCAT</h2>
Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.
<p>
<h2>COPYRIGHT</h2>
This is free software, distributed under the terms of the
GNU General Public License (GPL).
<p>
<h2>AUTHOR</h2>
Frank B. Brokken (<strong>f.b.brokken@rug.nl</strong>).
<p>
|