man: add logging control options
authorDan Williams <dcbw@redhat.com>
Thu, 8 Apr 2010 16:16:27 +0000 (09:16 -0700)
committerDan Williams <dcbw@redhat.com>
Thu, 8 Apr 2010 16:16:27 +0000 (09:16 -0700)
man/Makefile.am
man/NetworkManager.8.in
man/NetworkManager.conf.5.in

index 670d9a7..7cbc5a1 100644 (file)
@@ -10,3 +10,6 @@ EXTRA_DIST =                          \
        NetworkManager.conf.5.in        \
        nm-system-settings.conf.5.in    \
        nm-tool.1.in
+
+CLEANFILES = $(man_MANS)
+
index 2de7c26..4cd64c7 100644 (file)
@@ -8,7 +8,7 @@
 .SH NAME
 NetworkManager \- network management daemon
 .SH SYNOPSIS
-.B NetworkManager [\-\-no\-daemon] [\-\-pid\-file=<filename>] [\-\-state\-file=<filename>] [\-\-config=<filename>] [\-\-plugins=<plugin1>,plugin2>,...]
+.B NetworkManager [\-\-no\-daemon] [\-\-pid\-file=<filename>] [\-\-state\-file=<filename>] [\-\-config=<filename>] [\-\-plugins=<plugin1>,plugin2>,...] [\-\-log-level=<level>] [\-\-log-domain=<domain1>,<domain2>,...]
 .SH DESCRIPTION
 The \fINetworkManager\fP daemon attempts to make  networking configuration and
 operation as painless and automatic as possible by managing the primary network
@@ -81,11 +81,23 @@ List plugins used to manage system-wide connection settings.   This list has
 preference over plugins specified in the configuration file.  Currently supported
 plugins are: keyfile, ifcfg\-rh, ifcfg\-suse, ifupdown.
 See \fBNetworkManager.conf\fP(5) for more information on the plugins.
+.TP
+.I "\-\-log-level=<level>
+Sets how much information NetworkManager sends to the log destination (usually
+syslog's "daemon" facility).  By default, only informational, warning, and error
+messages are logged.  See \fBNetworkManager.conf\fP(5) for more information on
+log levels and domains.
+.TP
+.I "\-\-log-domains=<domain1>,<domain2>, ...
+Sets which operations are logged to the log destination (usually syslog).  By
+default, most domains are logging-enabled.  See \fBNetworkManager.conf\fP(5) for
+more information on log levels and domains.
 .SH DEBUGGING
 The following environment variables are supported to help debugging.  When used
 in conjunction with the "\-\-no\-daemon" option (thus echoing PPP and DHCP helper
 output to stdout) these can quickly help pinpoint the source of connection
-issues.
+issues.  Also see the \-\-log- and \-\-log-domains to enable debug logging inside
+NetworkManager itself.
 .TP
 .I "NM_PPP_DEBUG"
 When set to anything, causes NetworkManager to turn on PPP debugging in pppd,
index 3de2738..783bafb 100644 (file)
@@ -97,6 +97,26 @@ ignored by NetworkManager. Remember that NetworkManager controls the default rou
 so because the interface is ignored, NetworkManager may assign the default route to
 some other interface.
 When the option is missing, \fIfalse\fP value is taken as default.
+.SS [logging]
+This section controls NetworkManager's logging.  Any settings here are
+overridden by the --log-level and --log-domain command-line options.
+.TP
+.B level=\fI<level>\fP
+One of [ERR, WARN, INFO, DEBUG].  The ERR level logs only critical errors.  WARN
+logs warnings that may reflect operation.  INFO logs various informational
+messages that are useful for tracking state and operations.  DEBUG enables
+verbose logging for debugging purposes.  Subsequent levels also log all messages
+from earlier levels; thus setting the log level to INFO also logs error and
+warning messages.
+.TP
+.B domains=\fI<domain1>,<domain2>, ...\fP
+The following log domains are available: [NONE, HW, RKILL, ETHER, WIFI, BT, MB,
+DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT,
+USER_SET, SYS_SET, SUSPEND, CORE, DEVICE, OLPC].  When "NONE" is given by itself,
+logging is disabled.  MB = Mobile Broadband, USER_SET = user settings operations
+and communication, SYS_SET = system settings service operations, OLPC = OLPC
+Mesh device operations, CORE = core daemon operations, DEVICE = activation and
+general interface operations.
 .SH "SEE ALSO"
 .BR http://live.gnome.org/NetworkManager/SystemSettings
 .sp