From 3108d80b7ef6057543c824e37ffd92646642bc3d Mon Sep 17 00:00:00 2001 From: Nicholas Marriott Date: Tue, 19 Feb 2013 23:31:04 +0000 Subject: [PATCH] Move NOTES->README, move Vim syntax file documentation to the file itself and otherwise tweak some bits. --- Makefile.am | 2 +- NOTES => README | 26 +++++++------------------- SYNCING | 2 +- examples/tmux.vim | 14 ++++++++++++++ 4 files changed, 23 insertions(+), 21 deletions(-) rename NOTES => README (75%) 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/README similarity index 75% rename from NOTES rename to README index 12922950..42bfda97 100644 --- a/NOTES +++ b/README @@ -16,15 +16,16 @@ To build tmux from a release tarball, do: $ ./configure && make $ sudo make install -To get and build the latest version control checkout: +To get and build the latest from version control: - $ git clone git://tmux.git.sourceforge.net/gitroot/tmux/tmux + $ 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. +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: @@ -34,20 +35,8 @@ the source tree with: 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. +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. @@ -64,8 +53,7 @@ welcome. Please send by email to: 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. +tmux. All other files have a license and copyright notice at their start. -- Nicholas Marriott 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