← Back to branch summary

~kirkland/byobu/trunk

« back to all changes in this revision

Viewing changes to usr/share/man/man1/byobu-ugraph.1

  • Committer: kirkland at ubuntu
  • Date: 2023-11-22 22:45:43 UTC
  • Revision ID: kirkland@ubuntu.com-20231122224543-v5igclwtj4xga8tm
Permanently moved Byobu source code repository to https://github.com/dustinkirkland/byobu

Show diffs side-by-side

added added

removed removed

Lines of Context:
usr/share/man/man1/byobu-ugraph.1
1
 
.TH byobu-ugraph 1 "16 Dec 2013" byobu "byobu"
2
 
.SH NAME
3
 
\fBbyobu\-ugraph\fP \- helper script for notification history graphs
4
 
 
5
 
.SH DESCRIPTION
6
 
\fBbyobu\-ugraph\fP is a helper script that can be used to create history graphs
7
 
 
8
 
.SH USAGE
9
 
\fBbyobu\-ugraph\fP [options] [command [args...]]
10
 
 
11
 
.SH OPTIONS
12
 
  -f <file>   : File to read data points from.  (only required if no command specified).
13
 
  -h          : Show this help.
14
 
  -m <num>    : Minimum value (default=$min_default).
15
 
  -n          : Supress output of newline character.
16
 
  -p <points> : Specify number of data points in graph (default=$points_default).
17
 
  -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.
18
 
  -t <theme>  : 'byobu-ulevel' theme to use (default=$theme_default).
19
 
  -x <num>    : Maximum value (default=$max_default).
20
 
 
21
 
.SH EXAMPLES
22
 
Using byobu-ugraph to run a command, rotate log and display graph.
23
 
 
24
 
Here we specify a command to display available memory.  Trailing echo adds a required newline Note no filename specified.
25
 
 
26
 
    byobu-ugraph "(/usr/lib/byobu/mem_used | sed -e 's/% //g';echo)"
27
 
 
28
 
Using byobu-ugraph just to rotate log and display the graph
29
 
 
30
 
    file=/tmp/load.dat
31
 
    awk '{ print $1}' /proc/loadavg >> $file
32
 
    # Note: we need to specify what we consider to be a "reasonable" maximum load
33
 
    byobu-ugraph -m 3.0 -f $file
34
 
 
35
 
.SH NOTES
36
 
 
37
 
If you specify 'command', care must be taken with shell quoting to avoid expansion prior to this script running the command.
38
 
 
39
 
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.
40
 
 
41
 
.SH SEE ALSO
42
 
 
43
 
\fBbyobu\fP(1)
44
 
 
45
 
.TP
46
 
\fIhttp://byobu.org\fP
47
 
.PD
48
 
 
49
 
.SH AUTHOR
50
 
This utility was written by James Hunt <james.hunt@canonical.com>, and this manpage was written by Dustin Kirkland <kirkland@byobu.org> 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.
51
 
 
52
 
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.