man: manpage updates; add pages for system settings config file

6 files changed, 176 insertions, 14 deletions

diff --git a/.gitignore b/.gitignore
index a9a9ec1df1..d856d196c0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,7 +33,7 @@ docs/libnm-util/libnm-util-*.txt
 COPYING
 INSTALL
 *.pc
-man/*.[18]
+man/*.[185]
 po/*.gmo
 
 callouts/nm-dhcp-client.action
diff --git a/configure.ac b/configure.ac
index 6f00fb556e..3a5be51584 100644
--- a/configure.ac
+++ b/configure.ac
@@ -522,6 +522,8 @@ initscript/Mandriva/networkmanager
 introspection/Makefile
 man/Makefile
 man/NetworkManager.8
+man/NetworkManager.conf.5
+man/nm-system-settings.conf.5
 man/nm-tool.1
 po/Makefile.in
 policy/Makefile
diff --git a/man/Makefile.am b/man/Makefile.am
index c3000d78aa..670d9a741a 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,8 +1,12 @@
 man_MANS =				\
 	NetworkManager.8		\
+	NetworkManager.conf.5		\
+	nm-system-settings.conf.5	\
 	nm-tool.1
 
 EXTRA_DIST =				\
 	$(man_MANS)			\
 	NetworkManager.8.in		\
+	NetworkManager.conf.5.in	\
+	nm-system-settings.conf.5.in	\
 	nm-tool.1.in
diff --git a/man/NetworkManager.8.in b/man/NetworkManager.8.in
index 426cc7ba92..48683902ef 100644
--- a/man/NetworkManager.8.in
+++ b/man/NetworkManager.8.in
@@ -1,14 +1,14 @@
 .\" NetworkManager(8) manual page
 .\"
-.\" Copyright (C) 2005 - 2009 Red Hat, Inc.
+.\" Copyright (C) 2005 - 2010 Red Hat, Inc.
 .\" Copyright (C) 2005 - 2009 Novell, Inc.
 .\" Copyright (C) 2005 Robert Love
 .\"
-.TH NETWORKMANAGER "8"
+.TH NETWORKMANAGER "8" "January 29, 2010"
 .SH NAME
 NetworkManager \- network management daemon
 .SH SYNOPSIS
-.B NetworkManager [\-\-no-daemon]
+.B NetworkManager [\-\-no\-daemon] [\-\-pid\-file=<filename>] [\-\-state\-file=<filename>] [\-\-config=<filename>] [\-\-plugins=<plugin1>,plugin2>,...]
 .SH DESCRIPTION
 The \fINetworkManager\fP daemon attempts to make  networking configuration and
 operation as painless and automatic as possible by managing the primary network
@@ -18,7 +18,7 @@ connection for that device becomes available, unless that behavior is disabled.
 Information about networking is exported via a D-Bus interface to any interested
 application, providing a rich API with which to inspect and control network
 settings and operation.
-.TP
+.P
 NetworkManager will execute scripts in the /etc/NetworkManager/dispatcher.d
 directory in alphabetical order in response to network events.  Each script
 should be (a) a regular file, (b) owned by root, (c) not writable by group or
@@ -29,12 +29,12 @@ and second an action.
 .I "up"
 The interface has been activated.  The environment contains more information
 about the interface; CONNECTION_UUID contains the UUID of the connection.  Other
-variables are IP4_ADDRESS_N where N is a number from 0 to (# IPv4 addresses - 1),
+variables are IP4_ADDRESS_N where N is a number from 0 to (# IPv4 addresses \- 1),
 in the format "address/prefix gateway".  IP4_NUM_ADDRESSES contains the number
 addresses the script may expect.  IP4_NAMESERVERS contains a space-separated
 list of the DNS servers, and IP4_DOMAINS contains a space-separated list of the
 search domains.  Routes use the format IP4_ROUTE_N where N is a number from 0
-to (# IPv4 routes - 1), in the format "address/prefix next-hop metric", and
+to (# IPv4 routes \- 1), in the format "address/prefix next-hop metric", and
 IP4_NUM_ROUTES contains the number of routes to expect.  If the connection used
 DHCP for address configuration, the received DHCP configuration is passed in the
 environment using standard DHCP option names, prefixed with "DHCP4_", like
@@ -43,11 +43,11 @@ environment using standard DHCP option names, prefixed with "DHCP4_", like
 .I "down"
 The interface has been deactivated.
 .TP
-.I "vpn-up"
+.I "vpn\-up"
 A VPN connection has been activated.  The environment contains the connection
 UUID in the variable CONNECTION_UUID.
 .TP
-.I "vpn-down"
+.I "vpn\-down"
 A VPN connection has been deactivated.
 .TP
 .I "hostname"
@@ -55,21 +55,46 @@ The system hostname has been updated.  Use gethostname(2) to retrieve it.
 .SH OPTIONS
 The following options are supported:
 .TP
-.I "--no-daemon"
+.I "\-\-no-daemon"
 Do not daemonize.  This is useful for debugging, and directs log output to the
 controlling terminal in addition to syslog.
+.TP
+.I "\-\-pid\-file=<filename>"
+Specify location of a PID file.  The PID file is used for storing PID of the
+running proccess and prevents running multiple instances.
+.TP
+.I "\-\-state\-file=<filename>"
+Specify file for storing state of the NetworkManager persistently.  If not specified,
+the default value of '<LOCALSTATEDIR>/lib/NetworkManager/NetworkManager.state' is
+used; where <LOCALSTATEDIR> is dependent on your distribution (usually it's /var).
+.TP
+.I "\-\-config=<filename>"
+Specify configuration file to set up various settings for NetworkManager.  If not
+specified, the default value of '<SYSCONFDIR>/NetworkManager/NetworkManager.conf'
+is used with a fallback to the older 'nm\-system\-settings.conf' if located in
+the same directory; where <SYSCONFDIR> is dependent on your distribution (usually
+it's /etc).  See \fBNetworkManager.conf\fP(5) for more information on configuration
+file.
+.TP
+.I "\-\-plugins=<plugin1>,<plugin2>, ...
+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.
 .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
+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.
 .TP
 .I "NM_SERIAL_DEBUG"
-When set to anything, causes NetworkManager to log all serial communication to
-and from serial devices like mobile broadband 3G modems.
+(0.7.x only) When set to anything, causes NetworkManager to log all serial
+communication to and from serial devices like mobile broadband 3G modems.
 .TP
 .I "NM_PPP_DEBUG"
 When set to anything, causes NetworkManager to turn on PPP debugging in pppd,
 which logs all PPP and PPTP frames and client/server exchanges.
 .SH SEE ALSO
-.BR nm-tool (1)
+.BR nm\-tool (1),
+.BR NetworkManager.conf (5),
+
diff --git a/man/NetworkManager.conf.5.in b/man/NetworkManager.conf.5.in
new file mode 100644
index 0000000000..7eb48b6947
--- /dev/null
+++ b/man/NetworkManager.conf.5.in
@@ -0,0 +1,105 @@
+.\" NetworkManager.conf(5) manual page
+.\"
+.\" Copyright (C) 2010 Red Hat, Inc.
+.\"
+.TH "NetworkManager.conf" "5" "1 February 2010" ""
+.SH NAME
+NetworkManager.conf \- NetworkManager configuration file
+.SH SYNOPSIS
+/etc/NetworkManager/NetworkManager.conf
+.br
+or
+.br
+\fI<SYSCONFDIR>\fP/NetworkManager/NetworkManager.conf
+.br
+where <SYSCONFDIR> depends on your distribution or build.
+.SH DESCRIPTION
+.P
+.I NetworkManager.conf
+is a configuration file for NetworkManager. As the name suggests, it configures
+how NetworkManager handles system-wide connection settings. The location of
+the file may be changed through use of the "\-\-config=" argument for
+\fBNetworkManager\fP (8).
+
+It is not necessary to restart NetworkManager (for version 0.8) or nm\-system\-settings
+(for version 0.7) when making changes, as the configuration file is watched for changes
+and reloaded automatically when necessary.
+.SH "FILE FORMAT"
+.P
+The configuration file format is so-called key file (sort of ini-style format).
+It consists of sections (groups) of key-value pairs. Lines beginning with a '#' and blank
+lines are considered comments. Sections are started by a header line containing
+the section enclosed in '[' and ']', and ended implicitly by the start of
+the next section or the end of the file. Each key-value pair must be contained
+in a section.
+.br
+Minimal system settings configuration file looks like this:
+.P
+.nf
+[main]
+plugins=keyfile
+.fi
+.P
+Description of sections and available keys follows:
+.SS [main]
+This section is the only mandatory section of the configuration file.
+.TP
+.B plugins=\fIplugin1\fP,\fIplugin2\fP, ...
+List plugin names separated by ','. Plugins are used to read/write system-wide
+connection. When more plugins are specified, the connections are read from all
+listed plugins. When writing connections, the plugins will be asked to save the
+connection in the order listed here. If the first plugin cannot write out that
+connection type, or can't write out any connections, the next plugin is tried.
+If none of the plugins can save the connection, the error is returned to the user.
+.P
+.RS
+.B "Available plugins:"
+.br
+.TP 
+.I keyfile
+plugin is the generic plugin that supports all the connection types and
+capabilities that NetworkManager has. It writes files out in a .ini-style format in
+/etc/NetworkManager/system-connections. For security, it will ignore files
+that are readable or writeable by any user or group other than
+.I root
+since private keys and passphrases may be stored in plaintext inside the file.
+.TP 
+.I ifcfg\-rh
+plugin is used on the Fedora and Red Hat Enterprise Linux distributions
+to read and write configuration from the standard /etc/sysconfig/network-scripts/ifcfg-* files.
+It currently supports reading wired, WiFi, and 802.1x connections, but does not yet support reading
+or writing mobile broadband, PPPoE, or VPN connections. To allow reading and writing of these
+add \fIkeyfile\fP plugin to your configuration as well.
+.TP
+.I ifupdown
+plugin is used on the Debian and Ubuntu distributions, and reads connections from
+/etc/network/interfaces. Since it cannot write connections out (that support isn't planned),
+it is usually paired with the \fIkeyfile\fP plugin to enable saving and editing of new connections.
+The \fIifupdown\fP plugin supports basic wired and WiFi connections, including WPA-PSK.
+.TP
+.I ifcfg\-suse
+plugin is only provided for simple backward compatibility with SUSE and OpenSUSE configuration.
+Most setups should be using the \fIkeyfile\fP plugin instead. The \fIifcfg\-suse\fP plugin supports
+reading wired and WiFi connections, but does not support saving any connection types.
+.RE
+.SS [keyfile]
+This section contains keyfile-specific options and thus only has effect when using \fIkeyfile\fP plugin.
+.TP
+.B hostname=\fI<hostname>\fP
+Set a persistent hostname when using the \fIkeyfile\fP plugin.
+.SS [ifupdown]
+This section contains ifupdown-specific options and thus only has effect when using \fIifupdown\fP plugin.
+.TP
+.B managed=\fIfalse\fP | \fItrue\fP
+Controls whether interfaces listed in the 'interfaces' file are managed by NetworkManager.
+If set to \fItrue\fP, then interfaces listed in /etc/network/interfaces are managed by NetworkManager.
+If set to \fIfalse\fP, then any interface listed in /etc/network/interfaces will be
+ignored by NetworkManager. Remember that NetworkManager controls the default route,
+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.
+.SH "SEE ALSO"
+.BR http://live.gnome.org/NetworkManager/SystemSettings
+.sp
+.BR NetworkManager (8),
+.BR nm\-tool (1).
diff --git a/man/nm-system-settings.conf.5.in b/man/nm-system-settings.conf.5.in
new file mode 100644
index 0000000000..e48d0c8e65
--- /dev/null
+++ b/man/nm-system-settings.conf.5.in
@@ -0,0 +1,26 @@
+.\" nm-system-settings.conf(5) manual page
+.\"
+.\" Copyright (C) 2010 Red Hat, Inc.
+.\"
+.TH "nm-system-settings.conf" "5" "1 February 2010" ""
+.SH NAME
+nm\-system\-settings.conf \- Deprecated NetworkManager configuration file
+.SH SYNOPSIS
+/etc/NetworkManager/nm\-system\-settings.conf
+.br
+or
+.br
+\fI<SYSCONFDIR>\fP/NetworkManager/nm\-system\-settings.conf
+.br
+where <SYSCONFDIR> depends on your distribution or build.
+.SH DESCRIPTION
+.P
+.I nm\-system\-settings.conf
+is a deprecated configuration file for \fBNetworkManager\fP (5).  While this
+file can still be used, NetworkManager now defaults to reading the config
+file <SYSCONFDIR>\fP/NetworkManager/NetworkManager.conf\fP instead, falling back
+to nm\-system\-settings.conf if NetworkManager.conf does not exist.
+.SH "SEE ALSO"
+.BR NetworkManager (8),
+.BR NetworkManager.conf (5),
+.BR nm\-tool (1).