]> git.saurik.com Git - apple/syslog.git/blobdiff - syslogd.tproj/syslogd.8
syslog-217.1.4.tar.gz
[apple/syslog.git] / syslogd.tproj / syslogd.8
index c2df7b856664380e669eb9c9c8a22680e15eb3aa..0d72d0d0b8a4829cc98b7783ea108050664043b6 100644 (file)
@@ -1,4 +1,4 @@
-.\"Copyright (c) 2004-2008 Apple Inc. All rights reserved.
+.\"Copyright (c) 2004-2011 Apple Inc. All rights reserved.
 .\"
 .\"@APPLE_LICENSE_HEADER_START@
 .\"
 .Op Fl d
 .Op Fl D
 .Op Fl m Ar mark_interval
-.Op Fl c Ar log_cutoff
 .Op Fl l Ar lib_path
 .Op Fl db_max Ar size
 .Op Fl utmp_ttl Ar time
-.Op Fl fs_ttl Ar time
 .Op Fl mps_limit Ar quota
 .Op Fl dup_delay Ar time
 .Op Fl module_name Li {0|1}
@@ -96,38 +94,6 @@ is specified with no arguments, mark messages will be written every 20 minutes.
 The 
 .Dq mark
 facility is disabled if the setting is zero minutes.
-.It Fl c
-Sets a cutoff filter for log priorities for messages to be retained in the log message data store.
-The value of 
-.Ar log_cutoff
-must be between 0 and 7, corresponding to log priorities LOG_EMERG or ASL_LEVEL_EMERG
-and LOG_DEBUG or ASL_LEVEL_DEBUG as defined in the 
-.Xr syslog 3
-and
-.Xr asl 3
-header files.
-Received messages with a priority or level value greater than the cutoff will not be saved in the data store.
-The default filter value is set to allow all message priorities.
-Message filtering is primarily specified by the rules in the /etc/asl.conf file.
-However, if there are no matching rules for the ASL data store in the asl.conf file,
-then all messages that are allowed by the cutoff filter are saved.
-.Pp
-Note that a this filter value may be adjusted while
-.Nm
-is running using the
-.Nm syslog
-command-line utility.
-See the
-.Xr syslog 1
-manual.
-The filter may be adjusted using the
-.Dq -c
-option.
-.It Fl l
-Specifies an alternate path for loading plug-in modules.
-By default,
-.Nm
-checks for plug-in modules in the directory /usr/lib/asl.
 .It Fl db_max
 Sets the size limit in bytes for individual files in the data store.
 The default value for
@@ -146,21 +112,20 @@ Note that if archival is enabled (see the
 .Xr aslmanager 8
 manual), these messages will be copied to an archive
 after the regular time-to-live interval, but will persist in the data store until their own expiry time.
-.It Fl fs_ttl
-Sets the time-to-live in seconds for filesystem error messages generated by the kernel.
-The default is 31622400 seconds (approximately 1 year).
-As in the case of
-.Fl utmp_ttl ,
-if archival is enabled, these messages will be copied to an archive after the regular time-to-live
-interval but will persist in the data store until their own expiry time.
 .It Fl mps_limit
-Sets the per-process quota for messages per second allowed by
+Sets the kernel quota for messages per second allowed by
 .Nm .
 Any messages in excess of the quota limit from any process are ignored.
-An error message is logged on behalf of the limited process, stating that its message quota has
+An error message is logged stating that the kernel message quota has
 been exceeded, and that remaining messages for the current second will be discarded.
 The default limit is 500 messages per second per process.
 A value of 0 turns off the quota mechanism.
+.Pp
+Note that this setting only limits the number of kernel messages that will be saved by
+.Nm .
+User processes are limited to 36000 messages per hour.
+The limit for a user process is not enforced if a remote-control ASL filter is in
+place for the process.
 .It Fl dup_delay
 Sets the time to delay for coalescing duplicate message in log files.
 If a process logs multiple messages with the same text,
@@ -243,7 +208,7 @@ module receives log messages on the UDP socket associated with the Internet sysl
 .Pp
 This module is normally enabled, but is inactive.
 The actual UDP sockets are managed by
-.Nm launched ,
+.Nm launchd ,
 and configured in the
 .Nm syslogd
 configuration file /System/Library/LaunchDaemons/com.apple.syslogd.plist.
@@ -255,6 +220,17 @@ UDP service, so no sockets are provided to the
 .Dq udp_in 
 module.
 If no sockets are provided, the module remains inactive.
+A socket may be specified by adding the following entry to the
+.Dq Sockets
+dictionary in the com.apple.syslogd.plist file.
+.Pp
+.Dl            <key>NetworkListener</key>
+.Dl            <dict>
+.Dl                    <key>SockServiceName</key>
+.Dl                    <string>syslog</string>
+.Dl                    <key>SockType</key>
+.Dl                    <string>dgram</string>
+.Dl            </dict>
 .Pp
 The module may be specifically disabled using the
 .Fl udp_in Li 0 
@@ -300,7 +276,7 @@ bsd_out module configuration file
 asl_action module configuration file
 .It Pa /var/run/syslog.pid
 process ID file
-.It Pa /var/run/log
+.It Pa /var/run/syslog
 name of the
 .Ux
 domain datagram log socket
@@ -310,6 +286,9 @@ kernel log device
 data store directory
 .It Pa /var/log/asl.archive
 default archive directory
+.It Pa /System/Library/LaunchDaemons/com.apple.syslogd.plist
+launchd configuration file for
+.Nm syslogd
 .El
 .Sh SEE ALSO
 .Xr syslog 1 ,