Merge lp:~tribaal/landscape-client/landscape-sysinfo-man-page into lp:~landscape/landscape-client/trunk

[Chris Glass]

This branch reuses the submitted man page and commits it as a text file (to remain consistent with how we currently generate man pages using txt2man).

I'm not entirely sure if txt2man supports some of the fancier formatting that was originally submitted - don't hesitate to let me know if you think this first branch is not good enough.

[Jerry Seutter (jseutter)]

+1 looks good

Right-justification should be turned off. There are spaces unevenly interspersed in the text.

The FILES list has a blank line under each file so it looks like the explanation could either belong to the file above or the file below. This is a minor nitpick and I don't care if it gets fixed.

review: Approve

[Thomas Herve (therve)]

[1] The different default values are not displayed properly in the man version (-c, -d, -l). I realize it's the same for the other pages, it's be great to find a fix.

[2] Actually, most of the options are not relevant to sysinfo. Maybe using BaseConfiguration instead of Configuration would fix it.

Thanks!

review: Needs Fixing

[lp:~tribaal/landscape-client/landscape-sysinfo-man-page]

582. By Chris Glass on 2012-09-20

Made landscape-sysinfo use BaseConfigruation instead of Configuration as suggested.

583. By Chris Glass on 2012-09-20

Fixed manpages displaying the default values incorrectly. This was due to linefeeds :(

584. By Chris Glass on 2012-09-20

Fixed extra whitelines in the FILES section

[Chris Glass (tribaal)]

Should be fixed

[lp:~tribaal/landscape-client/landscape-sysinfo-man-page]

585. By Chris Glass on 2012-09-20

Forward-merging trunk

[Thomas Herve (therve)]

[3] There is still one extra line in man/landscape-config.1 for the log-level option.

Looks great, +1!

review: Approve

[lp:~tribaal/landscape-client/landscape-sysinfo-man-page]

586. By Chris Glass on 2012-09-20

Fixed extra log level linefeed

=== modified file '.bzrignore'
--- .bzrignore	2012-03-22 15:11:27 +0000
+++ .bzrignore	2012-09-20 09:57:20 +0000
@@ -25,6 +25,7 @@
 man/landscape-client.1
 man/landscape-config.1
 man/landscape-message.1
+man/landscape-sysinfo.1
 smart-update/smart-update
 apt-update/apt-update
 docs

=== modified file 'Makefile'
--- Makefile	2012-05-31 00:31:39 +0000
+++ Makefile	2012-09-20 09:57:20 +0000
@@ -61,6 +61,7 @@
 	${TXT2MAN} -P Landscape -s 1 -t landscape-client < man/landscape-client.txt > man/landscape-client.1
 	${TXT2MAN} -P Landscape -s 1 -t landscape-config < man/landscape-config.txt > man/landscape-config.1
 	${TXT2MAN} -P Landscape -s 1 -t landscape-message < man/landscape-message.txt > man/landscape-message.1
+	${TXT2MAN} -P Landscape -s 1 -t landscape-sysinfo < man/landscape-sysinfo.txt > man/landscape-sysinfo.1
 
 origtarball: sdist
 	cp -f sdist/landscape-client-$(TARBALL_VERSION).tar.gz \

=== modified file 'debian/rules'
--- debian/rules	2012-09-05 15:37:17 +0000
+++ debian/rules	2012-09-20 09:57:20 +0000
@@ -77,7 +77,7 @@
 	dh_testdir
 	dh_testroot
 	dh_installdocs
-	dh_installman -p landscape-client man/landscape-client.1 man/landscape-config.1 man/landscape-message.1
+	dh_installman -p landscape-client man/landscape-client.1 man/landscape-config.1 man/landscape-message.1 man/landscape-sysinfo.1
 	dh_installchangelogs
 	dh_install --sourcedir debian/tmp/
 	dh_installinit -- start 45 2 3 4 5 . stop 15 0 1 6 .

=== modified file 'landscape/deployment.py'
--- landscape/deployment.py	2012-09-14 07:05:37 +0000
+++ landscape/deployment.py	2012-09-20 09:57:20 +0000
@@ -230,12 +230,17 @@
         @return: An L{OptionParser} preset with options that all
             landscape-related programs accept. These include
               - C{config} (C{None})
+              - C{data_path} (C{"/var/lib/landscape/client/"})
         """
         parser = OptionParser(version=VERSION)
         parser.add_option("-c", "--config", metavar="FILE",
                           help="Use config from this file (any command line "
                                "options override settings from the file) "
                                "(default: '/etc/landscape/client.conf').")
+        parser.add_option("-d", "--data-path", metavar="PATH",
+                          default="/var/lib/landscape/client/",
+                          help="The directory to store data files in "
+                               "(default: '/var/lib/landscape/client/').")
         return parser
 
     def get_config_filename(self):
@@ -278,7 +283,6 @@
 
         @return: An L{OptionParser} preset for all options
             from L{BaseConfiguration.make_parser} plus:
-              - C{data_path} (C{"/var/lib/landscape/client/"})
               - C{quiet} (C{False})
               - C{log_dir} (C{"/var/log/landscape"})
               - C{log_level} (C{"info"})
@@ -292,10 +296,6 @@
               - C{ignore_sigint} (C{False})
         """
         parser = super(Configuration, self).make_parser()
-        parser.add_option("-d", "--data-path", metavar="PATH",
-                          default="/var/lib/landscape/client/",
-                          help="The directory to store data files in "
-                               "(default: '/var/lib/landscape/client/').")
         parser.add_option("-q", "--quiet", default=False, action="store_true",
                           help="Do not log to the standard output.")
         parser.add_option("-l", "--log-dir", metavar="FILE",

=== modified file 'landscape/sysinfo/deployment.py'
--- landscape/sysinfo/deployment.py	2011-02-08 08:10:05 +0000
+++ landscape/sysinfo/deployment.py	2012-09-20 09:57:20 +0000
@@ -7,7 +7,7 @@
 from twisted.python.reflect import namedClass
 from twisted.internet.defer import Deferred, maybeDeferred
 
-from landscape.deployment import Configuration
+from landscape.deployment import BaseConfiguration
 from landscape.sysinfo.sysinfo import SysInfoPluginRegistry, format_sysinfo
 
 
@@ -15,7 +15,7 @@
                "LoggedInUsers", "LandscapeLink", "Network"]
 
 
-class SysInfoConfiguration(Configuration):
+class SysInfoConfiguration(BaseConfiguration):
     """Specialized configuration for the Landscape sysinfo tool."""
 
     default_config_filenames = ("/etc/landscape/client.conf",)

=== modified file 'man/landscape-client.1'
--- man/landscape-client.1	2012-09-18 08:57:15 +0000
+++ man/landscape-client.1	2012-09-20 09:57:20 +0000
@@ -1,5 +1,5 @@
 .\"Text automatically generated by txt2man
-.TH landscape-client 1 "18 September 2012" "" ""
+.TH landscape-client 1 "20 September 2012" "" ""
 .SH NAME
 \fBlandscape-client \fP- Landscape system client
 \fB

=== modified file 'man/landscape-config.1'
--- man/landscape-config.1	2012-09-18 08:57:15 +0000
+++ man/landscape-config.1	2012-09-20 09:57:20 +0000
@@ -1,5 +1,5 @@
 .\"Text automatically generated by txt2man
-.TH landscape-config 1 "18 September 2012" "" ""
+.TH landscape-config 1 "20 September 2012" "" ""
 .SH NAME
 \fBlandscape-config \fP- configure the Landscape management client
 \fB
@@ -42,13 +42,11 @@
 .B
 \fB-c\fP FILE, \fB--config\fP=FILE
 Use config from this file (any command line \fIoptions\fP
-override settings from the file) (default:
-'/etc/landscape/client.conf').
+override settings from the file) (default: '/etc/landscape/client.conf').
 .TP
 .B
 \fB-d\fP PATH, \fB--data-path\fP=PATH
-The directory to store data files in (default:
-'/var/lib/landscape/client').
+The directory to store data files in (default: '/var/lib/landscape/client').
 .TP
 .B
 \fB-q\fP, \fB--quiet\fP
@@ -56,13 +54,11 @@
 .TP
 .B
 \fB-l\fP FILE, \fB--log-dir\fP=FILE
-The directory to write log files to (default:
-'/var/log/landscape').
+The directory to write log files to (default: '/var/log/landscape').
 .TP
 .B
 \fB--log-level\fP=LOG_LEVEL
-One of 'debug', 'info', 'warning', 'error' or 
-'critical' (default: 'info').
+One of 'debug', 'info', 'warning', 'error' or 'critical' (default: 'info').
 .TP
 .B
 \fB--ignore-sigint\fP

=== modified file 'man/landscape-config.txt'
--- man/landscape-config.txt	2012-09-18 08:57:15 +0000
+++ man/landscape-config.txt	2012-09-20 09:57:20 +0000
@@ -26,15 +26,11 @@
   --version                Show program's version number and exit.
   -h, --help               Show this help message and exit.
   -c FILE, --config=FILE   Use config from this file (any command line options
-                           override settings from the file) (default:
-                           '/etc/landscape/client.conf').
-  -d PATH, --data-path=PATH   The directory to store data files in (default:
-                           '/var/lib/landscape/client').
+                           override settings from the file) (default: '/etc/landscape/client.conf').
+  -d PATH, --data-path=PATH   The directory to store data files in (default: '/var/lib/landscape/client').
   -q, --quiet              Do not log to the standard output.
-  -l FILE, --log-dir=FILE   The directory to write log files to (default:
-                           '/var/log/landscape').
-  --log-level=LOG_LEVEL    One of 'debug', 'info', 'warning', 'error' or 
-                           'critical' (default: 'info').
+  -l FILE, --log-dir=FILE   The directory to write log files to (default: '/var/log/landscape').
+  --log-level=LOG_LEVEL    One of 'debug', 'info', 'warning', 'error' or 'critical' (default: 'info').
   --ignore-sigint          Ignore interrupt signals.
   --ignore-sigusr1         Ignore SIGUSR1 signal to rotate logs.
   -a NAME, --account-name=NAME   The account this computer belongs to.

=== modified file 'man/landscape-message.1'
--- man/landscape-message.1	2012-09-18 08:57:15 +0000
+++ man/landscape-message.1	2012-09-20 09:57:20 +0000
@@ -1,5 +1,5 @@
 .\"Text automatically generated by txt2man
-.TH landscape-message 1 "18 September 2012" "" ""
+.TH landscape-message 1 "20 September 2012" "" ""
 .SH NAME
 \fBlandscape-message \fP- Send a message to the landscape web interface
 \fB

=== added file 'man/landscape-sysinfo.1'
--- man/landscape-sysinfo.1	1970-01-01 00:00:00 +0000
+++ man/landscape-sysinfo.1	2012-09-20 09:57:20 +0000
@@ -0,0 +1,132 @@
+.\"Text automatically generated by txt2man
+.TH landscape-sysinfo 1 "20 September 2012" "" ""
+.SH NAME
+\fBlandscape-sysinfo \fP- Display a summary of the current system status
+\fB
+.SH SYNOPSIS
+.nf
+.fam C
+
+\fBlandscape-sysinfo\fP [\fIoptions\fP]
+
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+
+\fBlandscape-sysinfo\fP is a utility that displays information about the computer it is run
+on. This information is displayed upon login for console users
+(ssh and terminal login supported) and can also be seen at anytime
+by just calling \fBlandscape-sysinfo\fP from the command line.
+.PP
+The information displayed at login time is updated by update-motd. On
+systems where update-motd is not available, such as Ubuntu Dapper or
+Hardy, the output of \fBlandscape-sysinfo\fP is not included.
+.PP
+The output of \fBlandscape-sysinfo\fP can be controlled by enabling or
+disabling its plugins. See below how to do that.
+.PP
+If the system load is higher than the number of cores, as determined by the
+count of processor lines in /proc/cpuinfo, then
+\fBlandscape-sysinfo\fP will not run at login time. This is to prevent it from
+potentially making a bad situation worse by interfering with what could be an
+administrator logging in to try to fix the problem causing the high load.
+.SH OPTIONS
+.TP
+.B
+\fB--version\fP
+show program's version number and exit
+.TP
+.B
+\fB-h\fP, \fB--help\fP
+show this help message and exit
+.TP
+.B
+\fB-c\fP FILE, \fB--config\fP=FILE
+Use config from this file (any command line \fIoptions\fP
+override settings from the file) (default: '/etc/landscape/client.conf').
+.TP
+.B
+\fB-d\fP PATH, \fB--data-path\fP=PATH
+The directory to store data files in (default: '/var/lib/landscape/client/').
+.TP
+.B
+\fB--sysinfo-plugins\fP=PLUGIN_LIST
+Comma-delimited list of sysinfo plugins to use.
+Default is to use all plugins.
+.TP
+.B
+\fB--exclude-sysinfo-plugins\fP=PLUGIN_LIST
+Comma-delimited list of sysinfo plugins to NOT use.
+This always take precedence over plugins to include.
+.RE
+.PP
+Default plugins: Load, Disk, Memory, Temperature, Processes, LoggedInUsers,
+LandscapeLink, Network
+.SH CONFIGURATION FILE
+
+Any of the long command-line \fIoptions\fP can be used as a configuration directive
+in that configuration file, under the section [sysinfo], by replacing the hyphen
+(-) with an underscore (_).
+.PP
+For example, to disable the LandscapeLink and Temperature plugins
+without having to use the command line option, the following can be added to
+/etc/landscape/client.conf:
+.PP
+.nf
+.fam C
+    [sysinfo]
+    exclude_sysinfo_plugins = Temperature, LandscapeLink
+
+
+.fam T
+.fi
+.SH EXAMPLES
+
+This is the default configuration with all plugins enabled:
+.PP
+.nf
+.fam C
+    $ landscape-sysinfo
+      System load:    0.66               Processes:             242
+      Usage of /home: 72.0% of 27.50GB   Users logged in:       1
+      Memory usage:   31%                IP address for wlan0:  10.0.1.6
+      Swap usage:     0%                 IP address for virbr0: 192.168.122.1
+      Temperature:    47 C
+
+      => There is 1 zombie process.
+
+      Graph this data and manage this system at https://landscape.canonical.com/
+
+.fam T
+.fi
+If you want to disable the temperature and Landscape plugins, you could run it like this:
+.PP
+.nf
+.fam C
+    $ landscape-sysinfo --exclude-sysinfo-plugins=Temperature,LandscapeLink
+      System load:    1.08               Processes:             242
+      Usage of /home: 72.0% of 27.50GB   Users logged in:       1
+      Memory usage:   31%                IP address for wlan0:  10.0.1.6
+      Swap usage:     0%                 IP address for virbr0: 192.168.122.1
+
+      => There is 1 zombie process.
+
+.fam T
+.fi
+.SH FILES
+.TP
+.B
+/etc/landscape/client.conf
+Configuration file
+.TP
+.B
+/var/log/landscape/sysinfo.log
+Log file for when the tool is run as root. This file will usually be empty,
+unless something wrong happened. In that case, it will have more information
+about the problem.
+When a regular non-root user runs the tool, the log file is ~/.landscape/sysinfo.log.
+.SH SEE ALSO
+\fBlandscape-client\fP(1)
+\fBupdate-motd\fP(5)

=== added file 'man/landscape-sysinfo.txt'
--- man/landscape-sysinfo.txt	1970-01-01 00:00:00 +0000
+++ man/landscape-sysinfo.txt	2012-09-20 09:57:20 +0000
@@ -0,0 +1,98 @@
+NAME
+  landscape-sysinfo - Display a summary of the current system status
+
+SYNOPSIS
+
+  landscape-sysinfo [options]
+
+DESCRIPTION
+
+landscape-sysinfo is a utility that displays information about the computer it is run
+on. This information is displayed upon login for console users
+(ssh and terminal login supported) and can also be seen at anytime
+by just calling landscape-sysinfo from the command line.
+
+The information displayed at login time is updated by update-motd. On
+systems where update-motd is not available, such as Ubuntu Dapper or
+Hardy, the output of landscape-sysinfo is not included.
+
+The output of landscape-sysinfo can be controlled by enabling or
+disabling its plugins. See below how to do that.
+
+If the system load is higher than the number of cores, as determined by the
+count of processor lines in /proc/cpuinfo, then
+landscape-sysinfo will not run at login time. This is to prevent it from
+potentially making a bad situation worse by interfering with what could be an
+administrator logging in to try to fix the problem causing the high load.
+
+OPTIONS
+  --version             show program's version number and exit
+  -h, --help            show this help message and exit
+  -c FILE, --config=FILE    
+                        Use config from this file (any command line options
+                        override settings from the file) (default: '/etc/landscape/client.conf').
+  -d PATH, --data-path=PATH     
+                        The directory to store data files in (default: '/var/lib/landscape/client/').
+  --sysinfo-plugins=PLUGIN_LIST     
+                        Comma-delimited list of sysinfo plugins to use.
+                        Default is to use all plugins.
+  --exclude-sysinfo-plugins=PLUGIN_LIST     
+                        Comma-delimited list of sysinfo plugins to NOT use.
+                        This always take precedence over plugins to include.
+
+Default plugins: Load, Disk, Memory, Temperature, Processes, LoggedInUsers,
+LandscapeLink, Network
+
+CONFIGURATION FILE
+
+Any of the long command-line options can be used as a configuration directive
+in that configuration file, under the section [sysinfo], by replacing the hyphen
+(-) with an underscore (_).
+
+For example, to disable the LandscapeLink and Temperature plugins
+without having to use the command line option, the following can be added to
+/etc/landscape/client.conf:
+
+    [sysinfo]
+    exclude_sysinfo_plugins = Temperature, LandscapeLink
+
+
+EXAMPLES
+
+This is the default configuration with all plugins enabled:
+
+    $ landscape-sysinfo
+      System load:    0.66               Processes:             242
+      Usage of /home: 72.0% of 27.50GB   Users logged in:       1
+      Memory usage:   31%                IP address for wlan0:  10.0.1.6
+      Swap usage:     0%                 IP address for virbr0: 192.168.122.1
+      Temperature:    47 C
+
+      => There is 1 zombie process.
+
+      Graph this data and manage this system at https://landscape.canonical.com/
+
+If you want to disable the temperature and Landscape plugins, you could run it like this:
+
+    $ landscape-sysinfo --exclude-sysinfo-plugins=Temperature,LandscapeLink
+      System load:    1.08               Processes:             242
+      Usage of /home: 72.0% of 27.50GB   Users logged in:       1
+      Memory usage:   31%                IP address for wlan0:  10.0.1.6
+      Swap usage:     0%                 IP address for virbr0: 192.168.122.1
+
+      => There is 1 zombie process.
+
+FILES
+/etc/landscape/client.conf  
+Configuration file
+
+/var/log/landscape/sysinfo.log  
+Log file for when the tool is run as root. This file will usually be empty,
+unless something wrong happened. In that case, it will have more information
+about the problem.
+When a regular non-root user runs the tool, the log file is ~/.landscape/sysinfo.log.
+
+SEE ALSO
+landscape-client(1)
+update-motd(5)
+