Make some tweaks to NOTES and add a paragraph on git rather than huge PATCHES

file.
This commit is contained in:
Nicholas Marriott
2012-10-05 09:05:44 +01:00
parent 3a545376f0
commit 8249fbfb60
2 changed files with 21 additions and 177 deletions

45
NOTES
View File

@ -5,9 +5,7 @@ to be accessed and controlled from a single terminal. tmux is intended to be a
simple, modern, BSD-licensed alternative to programs such as GNU screen.
This release runs on OpenBSD, FreeBSD, NetBSD, Linux and OS X and may still
run on Solaris and AIX (although they haven't been tested in a while). It is
usable, although there remain a number of missing features and some remaining
bugs are expected.
run on Solaris and AIX (although they haven't been tested in a while).
If upgrading from 1.5, PLEASE NOTE:
- The word-separators window option is now a session option.
@ -25,57 +23,56 @@ To build tmux from a release tarball, do:
$ ./configure && make
$ sudo make install
To build from a version control checkout, the configure script must be
generated by running:
To get and build the latest version control checkout:
$ git clone git://tmux.git.sourceforge.net/gitroot/tmux/tmux
$ cd tmux
$ sh autogen.sh
$ ./configure && make
tmux consists of a server part and multiple clients. The server is created when
required and runs continuously unless killed by the user. Clients access the
server through a socket in /tmp. Multiple sessions may be created on a single
server and attached to a number of clients. Each session may then have a number
of windows and windows may be linked to a number of sessions. Commands are
available to create, rename and destroy windows and sessions; to attach and
detach sessions from client terminals; to set configuration options; to split
windows into several simultaneously displayed panes; and to bind and unbind
command keys (invoked preceded by a prefix key, by default ctrl-b). Please see
the tmux(1) man page for further information.
For more information see https://sourceforge.net/scm/?type=git&group_id=200378
and http://git-scm.com.
A more extensive, but rough, todo list is included in the TODO file.
For documentation on using tmux, see the tmux.1 manpage. It can be viewed from
the source tree with:
tmux also depends on several features of the client terminal (TERM), if these
are missing it may refuse to run, or not behave correctly.
$ nroff -mdoc tmux.1|less
Some common questions are answered in the FAQ file and a more extensive (but
slightly out of date) guide is available in the OpenBSD FAQ at
http://www.openbsd.org/faq/faq7.html#tmux. A rough todo list is in the TODO
file.
A Vim syntax file is available in the examples directory. To install it:
- Drop the file in the syntax directory in your runtimepath (such as
- Drop the file in the syntax directory into runtimepath (such as
~/.vim/syntax/tmux.vim).
- Make the filetype recognisable by adding the following to filetype.vim
in your runtimepath (~/.vim/filetype.vim):
(~/.vim/filetype.vim):
augroup filetypedetect
au BufNewFile,BufRead .tmux.conf*,tmux.conf* setf tmux
augroup END
- Switch on syntax highlighting by adding "syntax enable" to your vimrc file.
- Switch on syntax highlighting by adding "syntax enable" to .vimrc.
For debugging, running tmux with -v or -vv will generate server and client log
files in the current directory.
tmux mailing lists are available; visit:
tmux mailing lists are available. The visit:
https://sourceforge.net/mail/?group_id=200378
Bug reports, feature suggestions and especially code contributions are most
welcome. Please send by email to:
nicm@users.sf.net
tmux-users@lists.sourceforge.net
This file and the CHANGES, FAQ and TODO files are licensed under the ISC
license. Files under examples/ remain copyright their authors unless otherwise
stated in the file but permission has been received to distribute them with
tmux. All other files have a license and copyright notice at their
start. Please contact me with any queries.
start.
-- Nicholas Marriott <nicm@users.sf.net>