docs/130075: [patch] Changes to handbook syslogd section

Wed Dec 31 11:40:01 UTC 2008

>Number:         130075
>Category:       docs
>Synopsis:       [patch] Changes to handbook syslogd section
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Dec 31 11:40:01 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator:     Gavin Atkinson
>Release:        FreeBSD 7.0-STABLE amd64
>Organization:
>Environment:
System: FreeBSD buffy.york.ac.uk 7.0-STABLE FreeBSD 7.0-STABLE #3: Fri Jun 20 09:21:51 UTC 2008 root at buffy.york.ac.uk:/usr/obj/usr/src/sys/GENERIC amd64

>Description:
	I've made a few changes to the new syslogd chapter.  Firstly,
there is some confusion in the current article between the client and
server sections - there is talk about how to configure the server in
the client section.  This also contains incorrect info - the rc.conf
settings in the client section, for example, are really the ones that
should be used on the server.

Also, where info is relevant to both the server and client
configuration, I've moved the details into the server section as it
comes first.  As it was, various details were only explained the second
time they came up.

Lastly, I've just clarified a couple of bits, and added further info.

>How-To-Repeat:
	N/A
>Fix:

--- handbook-syslog.diff begins here ---
Index: doc/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml
===================================================================
RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml,v
retrieving revision 1.113
diff -u -r1.113 chapter.sgml
--- doc/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml	26 Dec 2008 03:19:02 -0000	1.113
+++ doc/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml	30 Dec 2008 14:37:15 -0000
@@ -5040,6 +5040,26 @@
         be logged to the file specified previously,
 	<filename>/var/log/logclient.log</filename>.</para>
 
+      <para>The server machine must also have the following listing
+	placed inside <filename>/etc/rc.conf</filename>:</para>
+
+      <programlisting>syslogd_enable="YES"
+syslogd_flags="-a logclient.example.com -vv"</programlisting>
+
+      <para>The first option will enable the <command>syslogd</command>
+	daemon on boot up, and the second option allows data from the
+	specified client to be accepted on this server.  The latter
+	part, using <option>-vv</option>, will increase the verbosity
+	of logged messages.  This is extremely useful for tweaking
+	facilities as administrators are able to see what type of
+	messages are being logged under which facility.</para>
+
+      <para>Multiple <option>-a</option> options may be specified to
+	allow logging from multiple clients.  <acronym>IP</acronym>
+	addresses and whole netblocks may also be specified, see the
+	&man.syslog.3; manual page for a full list of possible
+	options.</para>
+
       <para>Finally, the log file should be created.  The method used
 	does not matter, but &man.touch.1; works great for situations
 	such as this:</para>
@@ -5066,7 +5086,7 @@
 	to a logging server in addition to keeping local copies.</para>
 
       <para>Similar to log servers, clients must also meet a few minimum
-	requirements.</para>
+	requirements:</para>
  
       <itemizedlist>
 	<listitem>
@@ -5088,20 +5108,18 @@
       </itemizedlist>
 
       <para>Client configuration is a bit more relaxed when compared
-	to that of the servers.  The client machine must also have the
+	to that of the servers.  The client machine must have the
 	following listing placed inside
 	<filename>/etc/rc.conf</filename>:</para>
 
       <programlisting>syslogd_enable="YES"
-syslogd_flags="-a logclient.example.com -vv"</programlisting>
+syslogd_flags="-s -vv"</programlisting>
 
-      <para>The first option will enable the <command>syslogd</command>
-	daemon on boot up, and the second line allows data from the
-	client to be accepted on this server.  The latter part, using
-	<option>-vv</option>, will increase the verbosity of logged
-	messages.  This is extremely useful for tweaking facilities as
-	administrators are able to see what type of messages are being
-	logged under which facility.</para>
+      <para>As before, these entries will enable the
+	<command>syslogd</command> daemon on boot up, and increases
+	the verbosity of logged messages.  The <option>-s</option>
+	option prevents logs from being accepted by this client from
+	other hosts.</para>
 
       <para>Facilities describe the system part for which a message
 	is generated.  For an example, <acronym>ftp</acronym> and
@@ -5128,14 +5146,15 @@
       <screen>&prompt.root; <userinput>/etc/rc.d/syslogd restart</userinput></screen>
 
       <para>To test that log messages are being sent across the network,
-	use &man.logger.1; to send a message to
+	use &man.logger.1; on the client to send a message to
 	<command>syslogd</command>:</para>
 
       <screen>&prompt.root; <userinput>logger "Test message from logclient"</userinput></screen>
 
-      <para>This message should now exist in
-	<filename>/var/log/messages</filename> on both the client
-	and the server.</para>
+      <para>This message should now exist both in
+	<filename>/var/log/messages</filename> on the client, and
+	<filename>/var/log/logclient.log</filename> on the
+	log server.</para>
     </sect2>
 
     <sect2>
--- handbook-syslog.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted:

