OSSP CVS Repository

ossp - Check-in [1017]
Not logged in
[Honeypot]  [Browse]  [Home]  [Login]  [Reports
[Search]  [Ticket]  [Timeline
  [Patchset]  [Tagging/Branching

Check-in Number: 1017
Date: 2001-Sep-14 21:22:38 (local)
2001-Sep-14 19:22:38 (UTC)
User:rse
Branch:
Comment: document syslog channel
Tickets:
Inspections:
Files:
ossp-pkg/l2/l2.pod      1.5 -> 1.6     52 inserted, 1 deleted

ossp-pkg/l2/l2.pod 1.5 -> 1.6

--- l2.pod       2001/09/14 13:26:16     1.5
+++ l2.pod       2001/09/14 19:22:38     1.6
@@ -51,9 +51,60 @@
 
 =head1 AVAILABLE CHANNEL HANDLERS
 
+=head2 Syslog Output Channel Handler (l2_handler_syslog)
+
+The Syslog output channel handler C<l2_handler_syslog> sends the
+incoming message either via syslog(3) to a local syslogd(8) or via BSD
+Syslog protocol to a remote Syslog service. It conforms to RFC 3164 (The
+BSD syslog Protocol; C. Lonvick; August 2001).
+
+It provides the following channel parameters:
+
+=over 4
+
+=item B<target> (optional, C<char *>)
+
+Sets the location of the target Syslog service. Possible values
+are C<local> (the default) or C<remote>. If C<remote> is used, the
+parameters C<remotehost> has to be set, too.
+
+=item B<remotehost> (optional, C<char *>)
+
+Host name or IP address of the remote Syslog service.
+No default exists, user has to provide value.
+
+=item B<remoteport> (optional, C<int>)     
+
+Port number of the remote SMTP service.
+Default is C<514>.
+
+=item B<localhost> (optional, C<char *>)     
+
+The name of the local host, I<without> any domain appended.
+
+=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>,
+C<lpr>, C<news>, C<uucp>, C<cron>, C<authpriv>, C<ftp>, C<ntp>,
+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 *>)     
+
+Arbitrary string identifying the program.
+There is no default, user has to provide value.
+
+=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>.
+
+=back
+
 =head2 SMTP Output Channel Handler (l2_handler_smtp)
 
-The SMTP output channel handler C<l2_channel_smtp> sends the incoming
+The SMTP output channel handler C<l2_handler_smtp> sends the incoming
 message via Simple Mail Transfer Protocol (SMTP) as an Email to a remote
 mail service. It conforms to RFC 2821 (Simple Mail Transfer Protocol; J.
 Klensin; April 2001) and RFC 2822 (Internet Message Format; P. Resnick;

CVSTrac 2.0.1