Skip to content

Commit

Permalink
chore: update manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
Perfect5th committed Jul 8, 2024
1 parent 7c5f44b commit be0bf27
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 33 deletions.
14 changes: 6 additions & 8 deletions man/landscape-client.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man
.TH landscape-client 1 "14 February 2019" "" ""
.TH landscape-client 1 "08 July 2024" "" ""
.SH NAME
\fBlandscape-client \fP- Landscape system client
\fB
Expand Down Expand Up @@ -92,14 +92,11 @@ user.
.SH EXAMPLES

To run the client in the foreground, with all logging data printed to standard
I/O:
.PP
.nf
.fam C
landscape-client
.SH I/O:

.fam T
.fi
\fBlandscape-client\fP
.RE
.PP
To run the client in the background with a particular configuration file:
.PP
.nf
Expand All @@ -108,6 +105,7 @@ To run the client in the background with a particular configuration file:

.fam T
.fi
.RS
To run the client in the foreground, with a configuration file, but overriding
the bus option:
.PP
Expand Down
12 changes: 6 additions & 6 deletions man/landscape-config.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man
.TH landscape-config 1 "11 March 2023" "" ""
.TH landscape-config 1 "08 July 2024" "" ""
.SH NAME
\fBlandscape-config \fP- configure the Landscape management client
\fB
Expand Down Expand Up @@ -116,6 +116,11 @@ The interval between
package monitor runs (default: 1800).
.TP
.B
\fB--snap-monitor-interval\fP=SNAP_MONITOR_INTERVAL
The interval between snap
monitor runs (default: 1800).
.TP
.B
\fB--apt-update-interval\fP=APT_UPDATE_INTERVAL
The interval between apt update
runs (default: 21600).
Expand All @@ -131,11 +136,6 @@ Ratio, between 0 and 1, by which to stagger various
tasks of landscape.
.TP
.B
\fB--manage-sources-list-d\fP
Repository profiles manage the files in
\(cqetc/apt/sources.list.d'.
.TP
.B
\fB--http-proxy\fP=URL
The URL of the HTTP proxy, if one is needed.
.TP
Expand Down
2 changes: 0 additions & 2 deletions man/landscape-config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ OPTIONS
persisent data.
--stagger-launch=STAGGER_RATIO Ratio, between 0 and 1, by which to stagger various
tasks of landscape.
--manage-sources-list-d Repository profiles manage the files in
'etc/apt/sources.list.d'.
--http-proxy=URL The URL of the HTTP proxy, if one is needed.
--https-proxy=URL The URL of the HTTPS proxy, if one is needed.
--access-group Suggested access group for this computer.
Expand Down
19 changes: 2 additions & 17 deletions man/landscape-sysinfo.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man
.TH landscape-sysinfo 1 "14 February 2019" "" ""
.TH landscape-sysinfo 1 "08 July 2024" "" ""
.SH NAME
\fBlandscape-sysinfo \fP- Display a summary of the current system status
\fB
Expand Down Expand Up @@ -37,21 +37,13 @@ show program's version number and exit
.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.
.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.
Expand Down Expand Up @@ -87,8 +79,6 @@ This is the default configuration with all plugins enabled:
.fam C
$ landscape-sysinfo

.nf
.fam C
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
Expand All @@ -105,8 +95,6 @@ If you want to disable the temperature and Network plugins, you could run it lik
.fam C
$ landscape-sysinfo --exclude-sysinfo-plugins=Temperature,Network

.nf
.fam C
System load: 0.3 Memory usage: 12% Processes: 88
Usage of /: 14.0% of 9.52GB Swap usage: 0% Users logged in: 1

Expand All @@ -115,12 +103,9 @@ If you want to disable the temperature and Network plugins, you could run it lik
.fam T
.fi
.SH FILES
.TP
.B
/etc/landscape/client.conf
Configuration file
.TP
.B
.PP
/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
Expand Down

0 comments on commit be0bf27

Please sign in to comment.