usr/share/man/man1/byobu.1: document a sample custom script using

custom colors, LP: #568967
This commit is contained in:
Dustin Kirkland 2010-04-23 07:39:50 -05:00
commit 6b9833fecf
2 changed files with 5 additions and 0 deletions

2
debian/changelog vendored
View file

@ -1,6 +1,8 @@
byobu (2.72) unreleased; urgency=low
* usr/bin/byobu: support nethack screen mode, LP: #568751
* usr/share/man/man1/byobu.1: document a sample custom script using
custom colors, LP: #568967
-- Dustin Kirkland <kirkland@ubuntu.com> Thu, 22 Apr 2010 12:31:20 -0500

View file

@ -24,6 +24,9 @@ byobu \- wrapper script for seeding a user's byobu configuration and launching s
\fBcpu_temp\fP \- the cpu temperature in Celsius (default) or Fahrenheit, configure TEMP=F or TEMP=C in \fI$HOME/.byobu/statusrc\fP; displayed in the lower bar toward the right in yellow text on a black background; you may override the detected cpu temperature device by setting MONITORED_TEMP=/proc/acpi/whatever in \fI$HOME/.byobu/statusrc\fP
\fBcustom\fP \- user defined custom scripts; must be executable programs of any kind in \fI$HOME/.byobu/bin\fP; must be named N_NAME, where N is the frequency in seconds to refresh the status indicator, and NAME is the name of the script; N should not be less than 5 seconds; script should echo a small amount of text to standard out, standard error is discared; the indicator will be displayed in the lower panel, in inverted colors to your current background/foreground scheme, unless you manually specify the colors in your script's output; BEWARE, cpu-intensive custom scripts may impact your overall system performance and could upset your system administrator!
Example: \fI~/.byobu/bin/1000_uname\fP
#!/bin/sh
printf "\\005{= bw}%s\\005{-}" "$(uname -r)"
\fBdate\fP \- the system date in YYYY-MM-DD formate; displayed in the lower on the far right in the default text color on the default background