Add all the syslogd help text
authorEric Andersen <andersen@codepoet.org>
Fri, 28 Feb 2003 07:20:55 +0000 (07:20 -0000)
committerEric Andersen <andersen@codepoet.org>
Fri, 28 Feb 2003 07:20:55 +0000 (07:20 -0000)
sysklogd/Config.in

index 5bded06752364318f270e981db6a5069ca395676..8f7fa7fd1558bb615ecfa014d1f63b35af417643 100644 (file)
@@ -5,44 +5,79 @@
 
 menu "System Logging Utilities"
 
-config CONFIG_KLOGD
-       bool "klogd"
-       default n
-       help
-         Please submit a patch to add help text for this item.
-
-config CONFIG_LOGGER
-       bool "logger"
-       default n
-       help
-         Please submit a patch to add help text for this item.
-
 config CONFIG_SYSLOGD
        bool "syslogd"
        default n
        help
-         Please submit a patch to add help text for this item.
+         The syslogd utility is used to record logs of all the
+         significant events that occur on a system.  Every
+         message that is logged records the date and time of the
+         event, and will generally also record the name of the
+         application that generated the message.  When used in
+         conjunction with klogd, messages from the Linux kernel
+         can also be recorded.  This is terribly useful,
+         especially for finding what happened when somthing goes
+         wrong.  And something almost always will go wrong if
+         you wait long enough....
 
 config CONFIG_FEATURE_REMOTE_LOG
        bool "  Remote Log support"
        default n
        depends on CONFIG_SYSLOGD
        help
-         Please submit a patch to add help text for this item.
+         When you enable this feature, the syslogd utility can
+         be used to send system log messages to another system
+         connected via a network.  This allows the remote
+         machine to log all the system messages, which can be
+         terribly useful for reducing the number of serial
+         cables you use.  It can also be a very good security
+         measure to prevent system logs from being tampered with
+         by an intruder.
 
 config CONFIG_FEATURE_IPC_SYSLOG
        bool "  Circular Buffer support"
        default n
        depends on CONFIG_SYSLOGD
        help
-         Please submit a patch to add help text for this item.
+         When you enable this feature, the syslogd utility will
+         use a circular buffer to record system log messages.
+         When the buffer is filled it will continue to overwrite
+         the oldest messaged.  This can be very useful for
+         systems with little or no perminant storage, since
+         otherwise system logs can eventually fill up your
+         entire filesystem, which may cause your system to
+         break badly.
 
 config CONFIG_LOGREAD
        bool "  logread"
        default y
        depends on CONFIG_FEATURE_IPC_SYSLOG
        help
-         Please submit a patch to add help text for this item.
+         If you enabled Circular Buffer support, you almost
+         certainly want to enable this feature as well.  This
+         utility will allow you to read the messages that are
+         stored in the syslogd circular buffer.
+
+config CONFIG_KLOGD
+       bool "klogd"
+       default n
+       depends on CONFIG_SYSLOGD
+       help
+         klogd is a utility which which intercepts and logs all
+         messages from the Linux kernel and sends the messages
+         out to the 'syslogd' utility so they can be logged.  If
+         you wish to record the messages produced by the kernel,
+         you should enable this option.
+
+config CONFIG_LOGGER
+       bool "logger"
+       default n
+       depends on CONFIG_SYSLOGD
+       help
+         The logger utility allows you to send arbitrary text
+         messages to the 'syslogd' utility so they can be
+         logged.  This is generally used to help locate problems
+         that occur within programs and scripts.
 
 endmenu