--- l2.pod 2002/07/30 19:08:24 1.13
+++ l2.pod 2003/01/06 11:41:51 1.14
@@ -1,9 +1,10 @@
##
-## OSSP l2 - Logging Library
-## Copyright (c) 2001-2002 The OSSP Project (http://www.ossp.org/)
-## Copyright (c) 2001-2002 Cable & Wireless Deutschland (http://www.cw.com/de/)
+## OSSP l2 - Flexible Logging
+## Copyright (c) 2001-2003 Cable & Wireless Deutschland GmbH
+## Copyright (c) 2001-2003 The OSSP Project (http://www.ossp.org/)
+## Copyright (c) 2001-2003 Ralf S. Engelschall <rse@engelschall.com>
##
-## This file is part of OSSP L2, a flexible logging library which
+## This file is part of OSSP l2, a flexible logging library which
## can be found at http://www.ossp.org/pkg/lib/l2/.
##
## Permission to use, copy, modify, and distribute this software for
@@ -23,7 +24,7 @@
## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
## SUCH DAMAGE.
-##
+##
## l2.pod: Unix manual page for C API
##
@@ -31,11 +32,11 @@
=head1 NAME
-B<L2> - Logging Library
+B<OSSP l2> - Flexible Logging
=head1 VERSION
-L2 L2_VERSION_STR
+OSSP l2 L2_VERSION_STR
=head1 SYNOPSIS
@@ -43,7 +44,7 @@
=head1 DESCRIPTION
-OSSP L2 is a C library providing a very flexible and sophisticated
+B<OSSP l2> is a C library providing a very flexible and sophisticated
Unix logging facility. It is based on the model of arbitrary number of
channels, stacked together in a top-down data flow tree structure with
filtering channels in internal nodes and output channels on the leave
@@ -59,19 +60,19 @@
Channels are implemented by channel handlers which can be even
customer supplied for creating own channels which seamlessly integrate
-into the framework. For convinience reasons, L2 already ships with
+into the framework. For convinience reasons, B<OSSP l2> already ships with
pre-implemented filtering (noop, filter, prefix, buffer) and output
(null, fd, file, pipe, socket, syslog, smtp) channels which already
cover mostly all use cases of logging.
A language is provided to allow for channel specification and configuration.
Thus, the channel tree can be constructed either by the API and its ANSI C
-bindings or through the use of this L2 channel definition language. Applying
+bindings or through the use of this B<OSSP l2> channel definition language. Applying
the API allows fine grained control of the channel tree. Additionally, the
API allows for a more interactive channel definition. However, using the
channel definition language to define the channel tree is more convenient,
and takes less coding effort. The channel definition language is almost
-always sufficient for an application using L2.
+always sufficient for an application using B<OSSP l2>.
=head1 LOGGING LEVELS
@@ -88,7 +89,7 @@
=head1 CHANNEL TREE SPECIFICATION
-An L2 channel tree can be descriped by a textual specification according
+An B<OSSP l2> channel tree can be descriped by a textual specification according
to the following Backus-Naur-Form (BNF):
tree ::= stream
@@ -127,7 +128,7 @@
=head1 FUNCTIONS
-The following functions are provided by the B<L2> API:
+The following functions are provided by the B<OSSP l2> API:
=head1 AVAILABLE CHANNEL HANDLERS
@@ -153,16 +154,16 @@
Host name or IP address of the remote Syslog service.
No default exists, user has to provide value.
-=item B<remoteport> (optional, C<int>)
+=item B<remoteport> (optional, C<int>)
Port number of the remote SMTP service.
Default is C<514>.
-=item B<localhost> (optional, C<char *>)
+=item B<localhost> (optional, C<char *>)
The name of the local host, I<without> any domain appended.
-=item B<facility> (optional, C<char *>)
+=item B<facility> (optional, C<char *>)
The Syslog facility used for all messages. It has to be one of the
following: C<kern>, C<user>, C<mail>, C<daemon>, C<auth>, C<syslog>,
@@ -170,12 +171,12 @@
C<security>, C<console>, C<clock>, C<local0>, C<local1>, C<local2>,
C<local3>, C<local4>, C<local5>, C<local6>, C<local7>.
-=item B<ident> (I<mandatory>, C<char *>)
+=item B<ident> (I<mandatory>, C<char *>)
Arbitrary string identifying the program.
There is no default, user has to provide value.
-=item B<logpid> (optional, C<int>)
+=item B<logpid> (optional, C<int>)
Boolean flag whether to add the Process ID (pid)
to the B<ident> tag in messages. Default is C<0>.
@@ -194,7 +195,7 @@
Attention! Commands that exit on their own and with a success return value will
not be restarted, however those returning with non-zero exit codes will be
-restarted. L2 reopens closed pipe channels due to faulted command processes in
+restarted. B<OSSP l2> reopens closed pipe channels due to faulted command processes in
this way. Should such a reconnection be required after a command's successful
self-termination, l2_channel_open() may be called again on the same pipe channel
pointer previously used. Stream logging will then write to the pipe channel
@@ -214,12 +215,12 @@
exit(1); /* failure */
The command passed to the pipe channel handler may also be stopped while still
-using a L2 stream log. If a command process is stopped no action is taken
+using a B<OSSP l2> stream log. If a command process is stopped no action is taken
until further logging occurs. As soon as the pipe channel handler receives a
message due to a l2_stream_log operation, it will attempt to restart the
stopped command process and write to its standard input. If the effort to
restart the command process fails then the command process is considered
-dead, and L2 will terminate the process and close the channel. A
+dead, and B<OSSP l2> will terminate the process and close the channel. A
l2_channel_open() will then reopen the pipe channel using configuration
information previously entered with l2_channel_configure().
@@ -229,7 +230,7 @@
=item B<command> (optional, C<char *>)
-L2 will execute the command at this user-provided path, and pipe messages to
+B<OSSP l2> will execute the command at this user-provided path, and pipe messages to
its standard input when l2_stream_log operations are called.
=back
@@ -248,7 +249,7 @@
=item B<progname> (optional, C<char *>)
-Arbitrary string identifying the program using B<OSSP L2>.
+Arbitrary string identifying the program using B<OSSP l2>.
Default is C<NULL> which means no program identification.
=item B<localhost> (optional, C<char *>)
@@ -281,7 +282,7 @@
Host name or IP address of the remote SMTP service.
No default exists, user has to provide value.
-=item B<port> (optional, C<char *>)
+=item B<port> (optional, C<char *>)
Port name or number of the remote SMTP service.
Default is C<smtp> (25).
|
