README.md
1Byobu is a GPLv3 open source text-based window manager and terminal multiplexer. It was originally designed to provide elegant enhancements to the otherwise functional, plain, practical GNU Screen, for the Ubuntu server distribution. Byobu now includes an enhanced profiles, convenient keybindings, configuration utilities, and toggle-able system status notifications for both the GNU Screen window manager and the more modern Tmux terminal multiplexer, and works on most Linux, BSD, and Mac distributions.
2
3For more information about this package, please visit:
4 http://byobu.org
5
6If *Byobu* is not packaged for your Linux or UNIX OS, or if you do not have administrative privileges in order to install Byobu, you may be able to install locally, using the following instructions...
7
8### INSTALATION
9 1. If you pull the source from the upstream bzr or git:
10
11 ` bzr branch lp:byobu && cd byobu`
12 `git clone git://github.com/dustinkirkland/byobu.git byobu-src`
13 `cd byobu-src ./debian/rules autoconf`
14
15 2. Or download the latest officially released version from:
16 https://launchpad.net/byobu/+download
17
18 3. Extract:
19
20 `tar zxvf byobu*.tar.gz && cd byobu*`
21
22 4. Configure:
23
24 `./configure --prefix="$HOME/byobu"`
25
26 ***OPTIONAL*** : You may use python from your environment, rather than from your distro
27
28 ***echo "export BYOBU_PYTHON='/usr/bin/env python'" >> $HOME/.bashrc***
29
30 5. Build:
31 `make`
32
33 6. Install:
34
35 `make install`
36
37 7. Update your `PATH` and `BYOBU_PREFIX` environment variables
38
39 `echo "export PATH=$HOME/byobu/bin:$PATH" >> $HOME/.bashrc`
40 `. $HOME/.bashrc`
41
42 8. Run:
43
44 `byobu`
45
46> Note that you will need to have a few dependencies installed:
47 * tmux >= 1.5 and screen
48 * python-newt (if you want to use Byobu's configuration utility)
49 * gsed (if your sed implementation doesn't support -i)
50
51### CONTRIBUTION
52
53You may contribute to Byobu by branching the source from Launchpad (ideally), or by forking the project on Github (less ideally):
54
55$ bzr branch lp:byobu
56
57$ git clone git://github.com/dustinkirkland/byobu.git
58
59You commit changes locally, and then propose a merge in Launchpad (ideally), or submit a pull request on Github (less ideally).
60
61As for coding standards, please use tabs, rather than spaces. Thanks!
62
63### AUTHORS
64Dustin Kirkland <kirkland@byobu.org>
65Nick Barcet <nick.barcet@ubuntu.com>
66Raphaël Pinson <raphink@ubuntu.com>
67Derek Carter <goozbach@friocorte.com>
68
69### LICENSE:
70https://github.com/dustinkirkland/byobu/blob/master/COPYING
71
72Dustin Kirkland <kirkland@byobu.org>
73
742019-11-29
75