Return to README CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / tmux

Annotation of embedaddon/tmux/README, revision 1.1.1.1

1.1       misho       1: Welcome to tmux!
                      2: 
                      3: tmux is a "terminal multiplexer", it enables a number of terminals (or windows)
                      4: to be accessed and controlled from a single terminal. tmux is intended to be a
                      5: simple, modern, BSD-licensed alternative to programs such as GNU screen.
                      6: 
                      7: This release runs on OpenBSD, FreeBSD, NetBSD, Linux, OS X and Solaris.
                      8: 
                      9: tmux depends on libevent 2.x. Download it from:
                     10: 
                     11:        http://libevent.org
                     12: 
                     13: It also depends on ncurses, available from:
                     14: 
                     15:        http://invisible-island.net/ncurses/
                     16: 
                     17: To build and install tmux from a release tarball, use:
                     18: 
                     19:        $ ./configure && make
                     20:        $ sudo make install
                     21: 
                     22: tmux can use the utempter library to update utmp(5), if it is installed - run
                     23: configure with --enable-utempter to enable this.
                     24: 
                     25: To get and build the latest from version control:
                     26: 
                     27:        $ git clone https://github.com/tmux/tmux.git
                     28:        $ cd tmux
                     29:        $ sh autogen.sh
                     30:        $ ./configure && make
                     31: 
                     32: For more information see http://git-scm.com. Patches should be sent by email to
                     33: the mailing list at tmux-users@googlegroups.com.
                     34: 
                     35: For documentation on using tmux, see the tmux.1 manpage. It can be viewed from
                     36: the source tree with:
                     37: 
                     38:        $ nroff -mdoc tmux.1|less
                     39: 
                     40: Some common questions are answered in the FAQ file, a rough todo list is in the
                     41: TODO file and an example configuration in example_tmux.conf.
                     42: 
                     43: A vim(1) syntax file is available at:
                     44: 
                     45:        https://github.com/ericpruitt/tmux.vim
                     46:        https://raw.githubusercontent.com/ericpruitt/tmux.vim/master/vim/syntax/tmux.vim
                     47: 
                     48: And a bash(1) completion file at:
                     49: 
                     50:        https://github.com/imomaliev/tmux-bash-completion
                     51: 
                     52: For debugging, running tmux with -v or -vv will generate server and client log
                     53: files in the current directory.
                     54: 
                     55: tmux mailing lists are available. For general discussion and bug reports:
                     56: 
                     57:        https://groups.google.com/forum/#!forum/tmux-users
                     58: 
                     59: And for Git commit emails:
                     60: 
                     61:        https://groups.google.com/forum/#!forum/tmux-git
                     62: 
                     63: Subscribe by sending an email to <tmux-users+subscribe@googlegroups.com>.
                     64: 
                     65: Bug reports, feature suggestions and especially code contributions are most
                     66: welcome. Please send by email to:
                     67: 
                     68:        tmux-users@googlegroups.com
                     69: 
                     70: This file and the CHANGES, FAQ, SYNCING and TODO files are licensed under the
                     71: ISC license. All other files have a license and copyright notice at their start.
                     72: 
                     73: -- Nicholas Marriott <nicholas.marriott@gmail.com>