README 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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://libevent.org
  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 an example configuration in example_tmux.conf.
  25. A vim(1) syntax file is available at:
  26. https://github.com/keith/tmux.vim
  27. https://raw.githubusercontent.com/keith/tmux.vim/master/syntax/tmux.vim
  28. And a bash(1) completion file at:
  29. https://github.com/przepompownia/tmux-bash-completion
  30. For debugging, running tmux with -v or -vv will generate server and client log
  31. files in the current directory.
  32. tmux mailing lists are available. For general discussion and bug reports:
  33. https://groups.google.com/forum/#!forum/tmux-users
  34. And for Git commit emails:
  35. https://groups.google.com/forum/#!forum/tmux-git
  36. Bug reports, feature suggestions and especially code contributions are most
  37. welcome. Please send by email to:
  38. tmux-users@googlegroups.com
  39. This file and the CHANGES, FAQ, SYNCING and TODO files are licensed under the
  40. ISC license. All other files have a license and copyright notice at their start.
  41. -- Nicholas Marriott <nicholas.marriott@gmail.com>