Provided by: byobu_3.5-0ubuntu1_all bug

NAME

       byobu  -  wrapper  script  for seeding a user's byobu configuration and
       launching screen

DESCRIPTION

       byobu is a script that launches GNU screen in the byobu  configuration.
       This enables the display of system information and status notifications
       within two lines at the bottom of the screen session. It  also  enables
       multiple   tabbed   terminal   sessions,   accessible   through  simple
       keystrokes.

STATUS NOTIFICATIONS

       byobu supports a number of unique and interesting status  notifications
       across  the  lowest  two lines in the screen.  Each status notification
       item  is  independently  configurable,  enabled  and  disabled  by  the
       configuration utility.  The guide below helps identify each status item
       (in alphabetical order):

       apport - symbol displayed if  there  are  pending  crash  reports;  {!}
       symbol  displayed  on  the  lower  bar  toward the left, in black on an
       orange background

       arch - system architecture; displayed on the lower bar toward the left,
       in the default text color on the default background color

       battery  -  battery  information;  display  on the lower bar toward the
       right; |-| indicates discharging, |+| indicates charging, |=| indicates
       fully  charged;   when  charging  or  discharging,  the current battery
       capacity as a percentage is displayed;  the colours green, yellow,  and
       red are used to give further indication of the battery's charge state

       services  -  users  can configure a list of services to monitor, define
       the SERVICES variable in $HOME/.byobu/status, a whitespace separated of
       services,  each  service  should  include the init name of the service,
       then a pipe, and then an abbreviated name or  symbol  to  display  when
       running;  displayed  in  the  lower  bar toward the center in cyan on a
       white background

       cpu_count - the number of cpu's or cores on the  system;  displayed  in
       the lower bar toward the right in the default text color on the default
       background, followed by a trailing 'x'

       cpu_freq - the current frequency of the cpu in GHz;  displayed  in  the
       lower bar toward the right in white text on a light blue background

       cpu_temp  -  the  cpu  temperature  in Celsius (default) or Fahrenheit,
       configure TEMP=F or TEMP=C in $HOME/.byobu/statusrc; 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 $HOME/.byobu/statusrc

       custom  -  user  defined custom scripts; must be executable programs of
       any kind in $HOME/.byobu/bin; 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;  the  script
       should  echo  a small amount of text to standard out, standard error is
       discarded; 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: ~/.byobu/bin/1000_uname
           #!/bin/sh
           printf "\005{= bw}%s\005{-}" "$(uname -r)"

       date - 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

       disk  -  total  disk  space  available  and  total used on / directory;
       displayed in the lower bar on the far right in white text  on  a  light
       purple  background;  override  the  default  directory by specifying an
       alternate    mount    point    with     MONITORED_DISK=/wherever     in
       $HOME/.byobu/statusrc

       disk_io  -  instantaneous read/write througput in kB/s or MB/s over the
       last 3 seconds; displayed in the lower bar toward the  right  in  white
       text  on  a  light purple background with a leading '<' sign indicating
       'read speed' and  '>'  sign  indicating  'write  speed';  override  the
       default   monitored   disk  by  specifying  an  alternate  device  with
       MONITORED_disk=/dev/sdb in $HOME/.byobu/statusrc

       ec2_cost - an estimation of the cost of the current boot of the  system
       in  terms  of  the Amazon EC2 billing model; displayed in the lower bar
       toward the right in green text  on  a  black  background;  there  is  a
       leading  '~'  to  indicate that this is an estimation, and the monetary
       units are US Dollars '$'

       rcs_cost - an estimation of the cost of the current boot of the  system
       in  terms of the Rackspace Cloud Server billing model; displayed in the
       lower bar toward the right in green text on a black  background;  there
       is  a  leading  '~'  to  indicate  that  this is an estimation, and the
       monetary units are US Dollars '$'

       fan_speed -  cpu  or  system  fan  speed  as  reported  by  lm-sensors;
       displayed  in  the  lower  bar toward the right in black text on a grey
       background; there is a trailing 'rpm' for units

       hostname - the hostname of the system; displayed in the  upper  bar  on
       the  far  right  in  bold  black  text on a grey background; there is a
       leading '@' symbol if the username status is also enabled

       ip_address - the IPv4 address of the system  in  dotted  decimal  form;
       displayed  in  the  upper  bar on the far right in bold black text on a
       grey background;  you can override and display  your  IPv6  address  by
       setting 'IPV6=1' in $HOME/.byobu/statusrc

       load_average  -  the  system  load  average  over  the  last  1 minute;
       displayed in the lower bar toward the right in black text on  a  yellow
       background

       logo  -  an  approximation  of  the  current  operating  system's logo;
       displayed in the lower bar on the far left; you may customize this logo
       by setting a chosen logo in $HOME/.byobu/logo, or you may override this
       with LOGO=:-D in $HOME/.byobu/statusrc

       mail - system mail for the current user; the letter '[M]' is  displayed
       in the lower bar toward the left in black text on a grey background

       mem_available  - total memory available in the system; displayed in the
       lower bar toward the right in white text on a green background

       mem_used - total memory used in the system as a percentage of the total
       memory  available; displayed in the lower bar toward the right in white
       text on a green background with a trailing '%' sign

       menu - a simple indicator directing new users to use the F9  keybinding
       to access the byobu menu

       network  - instantaneous upload/download bandwidth in [GMk]bps over the
       last 3 seconds; displayed in the lower bar toward the  right  in  white
       text on a purple background with a leading '^' sign indicating 'up' and
       'v'  sign  indicating  'down';  override  the  default   interface   by
       specifying  an  alternate  interface  with  MONITORED_NETWORK=eth1, and
       override  the  default  units  (bits)   with   NETWORK_UNITS=bytes   in
       $HOME/.byobu/statusrc

       processes  - total number of processes running on the system; displayed
       in the lower bar in white text on  a  dark  yellow  background  with  a
       trailing '&' indicating 'background processes'

       reboot_required  -  symbol  present if a reboot is required following a
       system update; displayed  in  the  lower  bar  white  text  on  a  blue
       background  by  the  symbol  '(R)';  additionally, reboot_required will
       print '<F5>' in white text on a blue background, if Byobu requires  you
       to reload your profile to affect some changes.

       release  -  distribution  and  version  information  about  the release
       running  on  the  current  system  as  reported  by  lsb_release(1)  or
       /etc/issue;  displayed  in  the lower bar in bold black text toward the
       left on a grey background; you may override the detected  release  with
       DISTRO=Whatever in $HOME/.byobu/statusrc

       time  -  the system time in HH:MM:SS format; displayed in the lower bar
       on the far right in the default text and default background colors

       time_utc - the UTC system time in HH:MMformat; displayed in  the  lower
       bar on the far right in dark text on a light background

       updates_available  -  the  number  of  updates available on the system;
       displayed in the lower bar toward the right in  white  text  on  a  red
       background  with  a  trailing  '!'  sign;  if  any  updates  are marked
       'security updates',  then  there  will  be  a  total  of  two  trailing
       exclamation points, '!!'

       uptime  -  the  total  system  uptime since last boot; displayed in the
       lower bar toward the right in blue text on a grey background

       users - the number of remote users logged into  the  system  via  sshd,
       empty  if  0  users; displayed in the lower bar toward the right in red
       text on a grey background with a trailing '#' sign

       whoami - the name of the user who owns the screen session; displayed in
       the  upper  bar  toward  the  far  right  in  bold black text on a grey
       background

       wifi_quality - the connection rate  and  signal  quality  of  the  wifi
       connection;  displayed  in the lower bar toward the right in black text
       on a cyan background; the connection rate is in 'Mb/s' and  the  signal
       quality is as a percentage with a trailing '%'

WINDOWS

       Each  open  window  in the screen session is displayed in the upper bar
       toward the far left.  These are numbered, and include indicators as  to
       activity  in  the  window  (see  "activity"  in  screen(1)  for  symbol
       definitions).  The current active window is  highlighted  by  inverting
       the background/text from the rest of the window bar.

       Users   can   create  a  list  of  windows  to  launch  at  startup  in
       ~/.byobu/windows.  This file is the same syntax  as  ~/.screenrc,  each
       line  specifying  a  window using the "screen" command, as described in
       screen(1).

       User can also launch Byobu with unique window sets.   Users  can  store
       these as ~/.byobu/windows.[NAME], and launch Byobu with the environment
       variable BYOBU_WINDOWS.

       For example:
         $ cat ~/.byobu/windows.ssh_sessions
         screen -t localhost bash
         screen -t aussie ssh root@aussie
         screen -t beagle ssh root@beagle
         screen -t collie ssh root@collie
         $ BYOBU_WINDOWS=ssh_sessions byobu

UNITS OF MEASURE

       byobu uses binary for capacity measurements of  KB,  MB,  GB,  and  TB.
       This  means  multiples  of  1024  rather  than  multiples  of  1000, in
       accordance with JEDEC Standard 100B.01 for  disk  and  memory  capacity
       measurements.  See:
        * http://en.wikipedia.org/wiki/JEDEC_memory_standards

       byobu  uses  decimal for measurements of network data transfer, meaning
       multiple of 1000, rather than 1024.  See:
        * http://en.wikipedia.org/wiki/Data_rate_units

KEYBINDINGS

       byobu keybindings can be user defined in  /usr/share/byobu/keybindings/
       (or within .screenrc if byobu-export was used). The common key bindings
       are:

       F2 - Create a new window

       F3 - Move to previous window

       F4 - Move to next window

       F5 - Reload profile

       F6 - Detach from this session

       F7 - Enter copy/scrollback mode

       F8 - Re-title a window

       F9 - Configuration Menu

       F12 -  Lock this terminal

       Ctrl-a $ - show detailed status

       Ctrl-a R - Reload profile

       Ctrl-a ! - Toggle key bindings on and off

       Ctrl-a k - Kill the current window

       Ctrl-a  ~  -  Write  the  current   window's   scrollback   buffer   to
       /var/run/screen/S-$USER/byobu-exchange

BUGS

       PuTTY users have reported that the F2, F3, and F4 shortcut keys are not
       working properly.  PuTTY sends the same escape sequences as  the  linux
       console  for  F1-F4  by default.  You can fix this problem in the PuTTY
       config,  Terminal  ->  Keyboard  ->  Function  keys:  Xterm  R6.   See:
       http://www.mail-archive.com/screen-users@gnu.org/msg01525.html

       Mac OSX terminal users have reported 'flashing text'.  You can fix this
       in the advanced settings of the  terminal  application,  with  'Declare
       Terminal As: xterm-color'.

       Users of a non-UTF8 locale (such as cs_CZ charset ISO-8859-2), may need
       to add "defutf8 off" to ~/.screenrc, if some characters  are  rendering
       as "?".

SEE ALSO

       screen(1),   byobu-config,  byobu-export,  byobu-status,  byobu-status-
       detail
       http://launchpad.net/byobu

AUTHOR

       This   manpage   and   the  utility  was  written  by  Dustin  Kirkland
       <kirkland@canonical.com>  for  Ubuntu  systems  (but  may  be  used  by
       others).   Permission is granted to copy, distribute and/or modify this
       document under the terms of the GNU General Public License,  Version  3
       published by the Free Software Foundation.

       On  Debian systems, the complete text of the GNU General Public License
       can be found in /usr/share/common-licenses/GPL.