README-tmux 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. Welcome to tmux!
  2. tmux is a "terminal multiplexer", it enables a number of terminals (or windows)
  3. to be accessed and controlled from a single terminal. tmux is intended to be a
  4. simple, modern, BSD-licensed alternative to programs such as GNU screen.
  5. This release runs on OpenBSD, FreeBSD, NetBSD, Linux, OS X and Solaris.
  6. tmux depends on libevent 2.x. Download it from:
  7. http://www.monkey.org/~provos/libevent/
  8. To build tmux from a release tarball, do:
  9. $ ./configure && make
  10. $ sudo make install
  11. To get and build the latest from version control:
  12. $ git clone https://github.com/tmux/tmux.git
  13. $ cd tmux
  14. $ sh autogen.sh
  15. $ ./configure && make
  16. For more information see http://git-scm.com. Patches should be sent by email to
  17. the mailing list at tmux-users@googlegroups.com.
  18. For documentation on using tmux, see the tmux.1 manpage. It can be viewed from
  19. the source tree with:
  20. $ nroff -mdoc tmux.1|less
  21. Some common questions are answered in the FAQ file and a more extensive (but
  22. slightly out of date) guide is available in the OpenBSD FAQ at
  23. http://www.openbsd.org/faq/faq7.html#tmux. A rough todo list is in the TODO
  24. file and some example configurations and a Vim syntax file are in the examples
  25. directory.
  26. For debugging, running tmux with -v or -vv will generate server and client log
  27. files in the current directory.
  28. tmux mailing lists are available. For general discussion and bug reports:
  29. https://groups.google.com/forum/#!forum/tmux-users
  30. And for Git commit emails:
  31. https://groups.google.com/forum/#!forum/tmux-git
  32. Bug reports, feature suggestions and especially code contributions are most
  33. welcome. Please send by email to:
  34. tmux-users@googlegroups.com
  35. This file and the CHANGES, FAQ, SYNCING and TODO files are licensed under
  36. the ISC license. Files under examples/ remain copyright their authors unless
  37. otherwise stated in the file but permission has been received to distribute
  38. them with tmux. All other files have a license and copyright notice at their
  39. start.
  40. -- Nicholas Marriott <nicholas.marriott@gmail.com>