* usr/share/man/man1/byobu-ugraph.1, usr/share/man/man1/byobu-

ulevel.1, usr/share/man/man1/Makefile.am: - add manpages, silences lintian warning
2025-08-14 18:57:20 -07:00 · 2013-12-16 20:24:24 -06:00 · 2013-12-16 20:24:24 -06:00 · a50152b1f6
commit a50152b1f6
parent ce9a25e7ad
4 changed files with 138 additions and 1 deletions
--- a/usr/share/man/man1/Makefile.am
+++ b/usr/share/man/man1/Makefile.am
@ -1 +1 @@
-man_MANS = byobu.1 byobu-config.1 byobu-ctrl-a.1 byobu-disable.1 byobu-disable-prompt.1 byobu-enable.1 byobu-enable-prompt.1 byobu-export.1 byobu-janitor.1 byobu-keybindings.1 byobu-launch.1 byobu-launcher.1 byobu-launcher-install.1 byobu-launcher-uninstall.1 byobu-layout.1  byobu-prompt.1 byobu-quiet.1 byobu-reconnect-sockets.1 byobu-screen.1 byobu-select-backend.1 byobu-select-profile.1 byobu-select-session.1 byobu-shell.1 byobu-silent.1 byobu-status.1 byobu-status-detail.1 byobu-tmux.1
+man_MANS = byobu.1 byobu-config.1 byobu-ctrl-a.1 byobu-disable.1 byobu-disable-prompt.1 byobu-enable.1 byobu-enable-prompt.1 byobu-export.1 byobu-janitor.1 byobu-keybindings.1 byobu-launch.1 byobu-launcher.1 byobu-launcher-install.1 byobu-launcher-uninstall.1 byobu-layout.1  byobu-prompt.1 byobu-quiet.1 byobu-reconnect-sockets.1 byobu-screen.1 byobu-select-backend.1 byobu-select-profile.1 byobu-select-session.1 byobu-shell.1 byobu-silent.1 byobu-status.1 byobu-status-detail.1 byobu-tmux.1 byobu-ugraph.1 byobu-ulevel.1
--- a/usr/share/man/man1/byobu-ugraph.1
+++ b/usr/share/man/man1/byobu-ugraph.1
@ -0,0 +1,52 @@
+.TH byobu-ugraph 1 "16 Dec 2013" byobu "byobu"
+.SH NAME
+\fBbyobu\-ugraph\fP \- helper script for notification history graphs
+
+.SH DESCRIPTION
+\fBbyobu\-ugraph\fP is a helper script that can be used to create history graphs
+
+.SH USAGE
+\fBbyobu\-ugraph\fP [options] [command [args...]]
+
+.SH OPTIONS
+  -f <file>   : File to read data points from.  (only required if no command specified).
+  -h          : Show this help.
+  -m <num>    : Minimum value (default=$min_default).
+  -n          : Supress output of newline character.
+  -p <points> : Specify number of data points in graph (default=$points_default).
+  -r          : Do not rotate file <file> (default is to rotate).  Option implies file <file> should not be written to so a command cannot follow script options in this case.
+  -t <theme>  : 'byobu-ulevel' theme to use (default=$theme_default).
+  -x <num>    : Maximum value (default=$max_default).
+
+.SH EXAMPLES
+Using byobu-ugraph to run a command, rotate log and display graph.
+
+Here we specify a command to display available memory.  Trailing echo adds a required newline Note no filename specified.
+
+    byobu-ugraph "(/usr/lib/byobu/mem_used | sed -e 's/% //g';echo)"
+
+Using byobu-ugraph just to rotate log and display the graph
+
+    file=/tmp/load.dat
+    awk '{ print $1}' /proc/loadavg >> $file
+    # Note: we need to specify what we consider to be a "reasonable" maximum load
+    byobu-ugraph -m 3.0 -f $file
+
+.SH NOTES
+
+If you specify 'command', care must be taken with shell quoting to avoid expansion prior to this script running the command.
+
+If '-r' is not specified, the file <file> will be rotated such that at most <points> lines are retained on each invocation of this script.
+
+.SH SEE ALSO
+
+\fBbyobu\fP(1)
+
+.TP
+\fIhttp://byobu.co\fP
+.PD
+
+.SH AUTHOR
+This utility was written by James Hunt <james.hunt@canonical.com>, and this manpage was written by Dustin Kirkland <kirkland@byobu.co> for Ubuntu systems (but may be used by others).  Permission is granted to copy, distribute and/or modify this document and the utility under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation.
+
+The complete text of the GNU General Public License can be found in \fI/usr/share/common-licenses/GPL\fP on Debian/Ubuntu systems, or in \fI/usr/share/doc/fedora-release-*/GPL\fP on Fedora systems, or on the web at \fIhttp://www.gnu.org/licenses/gpl.txt\fP.
--- a/usr/share/man/man1/byobu-ulevel.1
+++ b/usr/share/man/man1/byobu-ulevel.1
@ -0,0 +1,82 @@
+.TH byobu-ulevel 1 "16 Dec 2013" byobu "byobu"
+.SH NAME
+\fBbyobu\-ulevel \fP \- helper script for notification level indicators
+
+.SH DESCRIPTION
+\fBbyobu\-ulevel\fP is a helper script that can be used to create history graphs with UTF8 characters
+
+.SH USAGE
+\fBbyobu\-ulevel \fP [options] -c <current_num>
+
+\fBbyobu\-ulevel \fP [options] <current_num>
+
+\fBbyobu\-ulevel \fP <current_num>
+
+.SH OPTIONS
+ -a          : Accessibility mode: only output ASCII.  (Also enabled if variable '$a11y_variable' set).
+ -b          : Display current value as space if zero, rather than lowest 'value' of theme.
+ -c <num>    : Current value of your indicator.
+ -d          : Enable debug output.
+ -e <int>    : Number of decimal places to use for accessibility mode (default=$default_decimal_places).
+ -h          : Show this help.
+ -i          : Invert colour scheme (rating themes only).
+ -l          : List available themes. If '-t' also specified, show all values for specified theme.
+ -m <num>    : Minimum value (default=$min_default).
+ -n          : Supress output of newline character.
+ -p          : Permissive mode - if current value out of bounds, set it to the nearest bound (min or max).
+ -q          : Suppress messages (requires '-t').
+ -r          : Reverse 'direction' of display (rating theme only).
+ -t <theme>  : Name of theme (default=$theme_default).
+ -u <chars>  : Specify a user theme (2 or more values).
+ -w <int>    : Width of rating theme (default=$width_default).
+ -x <num>    : Maximum value (default=$max_default).
+
+.SH EXAMPLES
+Display character representing 27% using default theme.
+  byobu-ulevel 27
+
+As above.
+  byobu-ulevel -c 27
+
+Example showing floating-point and negative values.
+  byobu-ulevel -c 1.100001 -m -5.00234 -x 2.71828 -t dice_6
+
+Use accessibility mode to display a percentage value (rounded to nearest percentage)
+  byobu-ulevel -m -22.613 -x 5.00212 -c 0.10203 -a -e 0
+
+Display value using a "rating theme" (displayed left-to-right).
+  byobu-ulevel -c 83 -t stars_2
+
+Display right-to-left inverted "rating theme".
+  byobu-ulevel -c 60 -t diamonds_2 -ri
+
+Display all glyphs in 'solid_numbers_a_10' theme.
+  byobu-ulevel -l -t solid_numbers_a_10
+
+Display a user-specified rating theme 10 glyphs wide.
+  byobu-ulevel -c 666.321 -m -273.15 -x 1370 -u "· ☢" -w 10
+
+A multi-element user theme (this prints 'e').
+  byobu-ulevel -c 50 -u "a b c d e f g h i j"
+
+.SH NOTES
+Arguments of type "<int>" denote an integer value, whereas arguments of type "<num>" denotes either an integer or a floating-point number.
+
+The final '_<number>' in a theme name denotes the number of glyphs in it.
+
+"Rating themes" are those with only 2 values.
+
+The <chars> argument to '-u' must contain space-delimited characters.
+
+.SH SEE ALSO
+
+\fBbyobu\fP(1)
+
+.TP
+\fIhttp://byobu.co\fP
+.PD
+
+.SH AUTHOR
+This utility was written by James Hunt <james.hunt@canonical.com>, and this manpage was written by Dustin Kirkland <kirkland@byobu.co> for Ubuntu systems (but may be used by others).  Permission is granted to copy, distribute and/or modify this document and the utility under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation.
+
+The complete text of the GNU General Public License can be found in \fI/usr/share/common-licenses/GPL\fP on Debian/Ubuntu systems, or in \fI/usr/share/doc/fedora-release-*/GPL\fP on Fedora systems, or on the web at \fIhttp://www.gnu.org/licenses/gpl.txt\fP.