2019-05-11 07:19:14 +00:00
|
|
|
# Welcome to tmux!
|
|
|
|
|
|
|
|
|
|
tmux is a terminal multiplexer: it enables a number of terminals to be created,
|
|
|
|
|
accessed, and controlled from a single screen. tmux may be detached from a
|
|
|
|
|
screen and continue running in the background, then later reattached.
|
|
|
|
|
|
2021-11-11 09:18:04 +00:00
|
|
|
This release runs on OpenBSD, FreeBSD, NetBSD, Linux, macOS and Solaris.
|
2019-05-11 07:19:14 +00:00
|
|
|
|
|
|
|
|
## Dependencies
|
|
|
|
|
|
2019-05-12 17:37:32 +00:00
|
|
|
tmux depends on [libevent](https://libevent.org) 2.x, available from [this
|
2019-05-11 07:19:14 +00:00
|
|
|
page](https://github.com/libevent/libevent/releases/latest).
|
|
|
|
|
|
2019-05-12 09:00:11 +00:00
|
|
|
It also depends on [ncurses](https://www.gnu.org/software/ncurses/), available
|
|
|
|
|
from [this page](https://invisible-mirror.net/archives/ncurses/).
|
2019-05-11 07:19:14 +00:00
|
|
|
|
2020-09-25 08:43:35 +00:00
|
|
|
To build tmux, a C compiler (for example gcc or clang), make, pkg-config and a
|
|
|
|
|
suitable yacc (yacc or bison) are needed.
|
2020-09-25 08:41:41 +00:00
|
|
|
|
2019-05-11 07:19:14 +00:00
|
|
|
## Installation
|
|
|
|
|
|
2020-10-01 08:01:42 +00:00
|
|
|
### Binary packages
|
|
|
|
|
|
|
|
|
|
Some platforms provide binary packages for tmux, although these are sometimes
|
|
|
|
|
out of date. Examples are listed on
|
|
|
|
|
[this page](https://github.com/tmux/tmux/wiki/Installing).
|
|
|
|
|
|
2019-05-11 07:19:14 +00:00
|
|
|
### From release tarball
|
|
|
|
|
|
|
|
|
|
To build and install tmux from a release tarball, use:
|
|
|
|
|
|
|
|
|
|
~~~bash
|
|
|
|
|
./configure && make
|
|
|
|
|
sudo make install
|
|
|
|
|
~~~
|
|
|
|
|
|
|
|
|
|
tmux can use the utempter library to update utmp(5), if it is installed - run
|
|
|
|
|
configure with `--enable-utempter` to enable this.
|
|
|
|
|
|
2020-10-01 08:01:42 +00:00
|
|
|
For more detailed instructions on building and installing tmux, see
|
|
|
|
|
[this page](https://github.com/tmux/tmux/wiki/Installing).
|
|
|
|
|
|
2019-05-11 07:19:14 +00:00
|
|
|
### From version control
|
|
|
|
|
|
2019-07-17 07:57:22 +00:00
|
|
|
To get and build the latest from version control - note that this requires
|
|
|
|
|
`autoconf`, `automake` and `pkg-config`:
|
2019-05-11 07:19:14 +00:00
|
|
|
|
|
|
|
|
~~~bash
|
|
|
|
|
git clone https://github.com/tmux/tmux.git
|
|
|
|
|
cd tmux
|
|
|
|
|
sh autogen.sh
|
|
|
|
|
./configure && make
|
|
|
|
|
~~~
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Bug reports, feature suggestions and especially code contributions are most
|
|
|
|
|
welcome. Please send by email to:
|
|
|
|
|
|
|
|
|
|
tmux-users@googlegroups.com
|
|
|
|
|
|
2019-06-01 07:07:22 +00:00
|
|
|
Or open a GitHub issue or pull request. **Please read [this
|
|
|
|
|
document](CONTRIBUTING.md) before opening an issue.**
|
2019-05-11 07:19:14 +00:00
|
|
|
|
2019-06-11 13:27:40 +00:00
|
|
|
There is [a list of suggestions for contributions](https://github.com/tmux/tmux/wiki/Contributing).
|
|
|
|
|
Please feel free to ask on the mailing list if you're thinking of working on something or need
|
|
|
|
|
further information.
|
2019-05-19 12:31:09 +00:00
|
|
|
|
2019-05-11 07:19:14 +00:00
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
For documentation on using tmux, see the tmux.1 manpage. View it from the
|
|
|
|
|
source tree with:
|
|
|
|
|
|
|
|
|
|
~~~bash
|
|
|
|
|
nroff -mdoc tmux.1|less
|
|
|
|
|
~~~
|
|
|
|
|
|
|
|
|
|
A small example configuration is in `example_tmux.conf`.
|
|
|
|
|
|
|
|
|
|
And a bash(1) completion file at:
|
|
|
|
|
|
|
|
|
|
https://github.com/imomaliev/tmux-bash-completion
|
|
|
|
|
|
2020-10-01 08:01:42 +00:00
|
|
|
For debugging, run tmux with `-v` or `-vv` to generate server and client log
|
2019-05-19 12:31:09 +00:00
|
|
|
files in the current directory.
|
2019-05-11 07:19:14 +00:00
|
|
|
|
|
|
|
|
## Support
|
|
|
|
|
|
|
|
|
|
The tmux mailing list for general discussion and bug reports is:
|
|
|
|
|
|
|
|
|
|
https://groups.google.com/forum/#!forum/tmux-users
|
|
|
|
|
|
|
|
|
|
Subscribe by sending an email to:
|
|
|
|
|
|
|
|
|
|
tmux-users+subscribe@googlegroups.com
|
