From 3108d80b7ef6057543c824e37ffd92646642bc3d Mon Sep 17 00:00:00 2001 From: Nicholas Marriott Date: Tue, 19 Feb 2013 23:31:04 +0000 Subject: Move NOTES->README, move Vim syntax file documentation to the file itself and otherwise tweak some bits. --- Makefile.am | 2 +- NOTES | 72 ------------------------------------------------------- README | 60 ++++++++++++++++++++++++++++++++++++++++++++++ SYNCING | 2 +- examples/tmux.vim | 14 +++++++++++ 5 files changed, 76 insertions(+), 74 deletions(-) delete mode 100644 NOTES create mode 100644 README diff --git a/Makefile.am b/Makefile.am index f89fdd79..a19a7613 100644 --- a/Makefile.am +++ b/Makefile.am @@ -6,7 +6,7 @@ dist_man1_MANS = tmux.1 # Distribution tarball options. EXTRA_DIST = \ - CHANGES FAQ NOTES TODO examples compat \ + CHANGES FAQ README TODO examples compat \ array.h compat.h tmux.h osdep-*.c dist-hook: grep "^#found_debug=" configure diff --git a/NOTES b/NOTES deleted file mode 100644 index 12922950..00000000 --- a/NOTES +++ /dev/null @@ -1,72 +0,0 @@ -Welcome to tmux! - -tmux is a "terminal multiplexer", it enables a number of terminals (or windows) -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). - -Since the 1.2 release tmux depends on libevent. Download it from: - - http://www.monkey.org/~provos/libevent/ - -To build tmux from a release tarball, do: - - $ ./configure && make - $ sudo make install - -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 - -For more information see https://sourceforge.net/scm/?type=git&group_id=200378 -and http://git-scm.com. - -For documentation on using tmux, see the tmux.1 manpage. It can be viewed from -the source tree with: - - $ 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 into runtimepath (such as - ~/.vim/syntax/tmux.vim). -- Make the filetype recognisable by adding the following to 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 .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. 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: - - 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. - --- Nicholas Marriott - -$Id$ diff --git a/README b/README new file mode 100644 index 00000000..42bfda97 --- /dev/null +++ b/README @@ -0,0 +1,60 @@ +Welcome to tmux! + +tmux is a "terminal multiplexer", it enables a number of terminals (or windows) +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). + +Since the 1.2 release tmux depends on libevent. Download it from: + + http://www.monkey.org/~provos/libevent/ + +To build tmux from a release tarball, do: + + $ ./configure && make + $ sudo make install + +To get and build the latest from version control: + + $ git clone git://git.code.sf.net/p/tmux/tmux-code tmux + $ cd tmux + $ sh autogen.sh + $ ./configure && make + +For more information see https://sourceforge.net/scm/?type=git&group_id=200378 +and http://git-scm.com. Patches should be sent by email to the mailing list at +tmux-users@lists.sourceforge.net. + +For documentation on using tmux, see the tmux.1 manpage. It can be viewed from +the source tree with: + + $ 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 and some example configurations and a Vim syntax file are in the examples +directory. + +For debugging, running tmux with -v or -vv will generate server and client log +files in the current directory. + +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: + + 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. + +-- Nicholas Marriott + +$Id$ diff --git a/SYNCING b/SYNCING index 62351b2c..eba24177 100644 --- a/SYNCING +++ b/SYNCING @@ -138,7 +138,7 @@ Release tmux for next version don't have debugging enabled, otherwise make(1) aborts when preparing the distribution. -2. Update and commit NOTES and CHANGES. The former should be checked for +2. Update and commit README and CHANGES. The former should be checked for anything outdated and updated with a list of things that might break upgrades and the latter should mention all the major changes since the last version. diff --git a/examples/tmux.vim b/examples/tmux.vim index f1a98be4..076115c1 100644 --- a/examples/tmux.vim +++ b/examples/tmux.vim @@ -3,6 +3,20 @@ " Maintainer: Tiago Cunha " Last Change: $Date: 2010-07-27 18:29:07 $ " License: This file is placed in the public domain. +" +" To install this file: +" +" - 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 +" (~/.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 .vimrc. +" if version < 600 syntax clear -- cgit From b219d54503b434f451625516ee13f3fd4bd80376 Mon Sep 17 00:00:00 2001 From: Nicholas Marriott Date: Wed, 20 Feb 2013 00:03:59 +0000 Subject: Simplify main www page. --- www/index.html.in | 101 +++++++++++++++++++----------------------------------- 1 file changed, 36 insertions(+), 65 deletions(-) diff --git a/www/index.html.in b/www/index.html.in index 36bc44c0..f8ce53a2 100644 --- a/www/index.html.in +++ b/www/index.html.in @@ -12,79 +12,50 @@

tmux

-

tmux is a terminal multiplexer: it enables a number of terminals (or -windows), each running a separate program, 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.

+

tmux is a terminal multiplexer

-

The - -latest release is tmux %%VERSION%% or - -get the development version from git.

- -

tmux uses a client-server model. The server holds multiple sessions and each -window is an independent entity which may be freely linked to multiple sessions, -moved between sessions and otherwise manipulated. Each session may be attached -to (display and accept keyboard input from) multiple clients.

- -

tmux is intended to be a modern, BSD-licensed alternative to programs such -as GNU screen. Major features include:

- -
    -
  • A powerful, consistent, well-documented and easily scriptable command -interface.
    • -
  • A window may be split horizontally and vertically into panes.
    • -
  • Panes can be freely moved and resized, or arranged into preset -layouts.
    • -
  • Support for UTF-8 and 256-colour terminals.
    • -
  • Copy and paste with multiple buffers.
    • -
  • Interactive menus to select windows, sessions or clients.
    • -
  • Change the current window by searching for text in the target.
    • -
  • Terminal locking, manually or after a timeout.
    • -
  • A clean, easily extended, BSD-licensed codebase, under active -development.
    • -
+

What is a terminal multiplexer? It lets you switch easily between +several programs in one terminal, detach them (they keep running in the +background) and reattach them to a different terminal. And do a lot more. See + +the manual.

-

tmux is part of the OpenBSD base -system. The portable version is hosted on -SourceForge and runs on Linux, FreeBSD, NetBSD, Solaris and AIX. -It depends on libevent 1.4 or 2.0 and a -terminfo implementation (normally ncurses).

- -

A few people have written programs which can be used with tmux: -tmux-ruby, -tmuxinator, -tmux-applets and -teamocil. -There is a -book on tmux by Brian P Hogan.

- -
- Screenshot - Screenshot - Screenshot -
+

Download + +tmux %%VERSION%% or + +get the development version.

+ +

tmux is hosted on +SourceForge +and needs +libevent +and +ncurses +.

+ +

There are some programs to use with tmux + +on GitHub and a +book on tmux.

+ +
+ Screenshot + Screenshot + Screenshot +
- + -- cgit From e90a742db85ce7bf5ac9d1ad2fff42b7aa772cbe Mon Sep 17 00:00:00 2001 From: Nicholas Marriott Date: Wed, 20 Feb 2013 00:06:01 +0000 Subject: Tweak bold link. --- www/index.html.in | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/www/index.html.in b/www/index.html.in index f8ce53a2..c7188f03 100644 --- a/www/index.html.in +++ b/www/index.html.in @@ -31,9 +31,8 @@ background) and reattach them to a different terminal. And do a lot more. See the manual.

-

Download - -tmux %%VERSION%% or +

+Download tmux %%VERSION%% or get the development version.

-- cgit From 4621a521837d2772b6bd69b038e35391eb6f1c18 Mon Sep 17 00:00:00 2001 From: Nicholas Marriott Date: Wed, 20 Feb 2013 00:16:00 +0000 Subject: Include ML and IRC in the text. --- www/index.html.in | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/www/index.html.in b/www/index.html.in index c7188f03..c2942393 100644 --- a/www/index.html.in +++ b/www/index.html.in @@ -34,9 +34,8 @@ the manual.

Download tmux %%VERSION%% or -get the development version.

- -

tmux is hosted on +get the development version. +tmux is hosted on SourceForge and needs libevent @@ -44,6 +43,11 @@ and ncurses .

+

For support contact the +tmux-users@lists.sf.net +mailing list or IRC channel +#tmux on freenode.

+

There are some programs to use with tmux on GitHub and a -- cgit