Document automatic-rename.

2 files changed, 26 insertions, 10 deletions

diff --git a/TODO b/TODO
index 88b6bd70..3fc90ed7 100644
--- a/TODO
+++ b/TODO
@@ -70,21 +70,19 @@
   errors better
 - would be nice if tmux could be the shell (tmux attach, but hard link to tmux
   binary as "tmuxsh" or wrapper script?) -- problems with tty dev permeissions
-- 88 colour support; new grid cell flag, and 256<->88 88<->16 translation tables
 - UTF-8 combining characters don't work. store in one cell - pointer to table
   of chains. bit of a hack and would mean max of 65536 per screen. OR maybe
   utf8 should work differently; could store as multiple cells, 1 of width >0
   and n of width 0, then translate cursor indexes on-the-fly would need to
   adjust all cursor movement and also handle different width lines properly.
 - support other mouse modes (highlight etc) and use it in copy mode 
+
+(hopefully) for 0.8, in no particular order:
+- key to switch to copy mode from scroll mode
+- attach should have a flag to create session if it doesn't exist
 - swap-pane-up, swap-pane-down (maybe move-pane-*)
 - move-pane (to window) (maybe break-pane?)
 - $TMUX should contain socket path
-- rules to colour windows in status line based on name/title
-- key to switch to copy mode from scroll mode
-- attach should have a flag to create session if it doesn't exist
-- key to switch to copy mode from scroll mode
-- attach should have a flag to create session if it doesn't exist
-
-(hopefully) for 0.7, in no particular order:
-- document automatic-rename
+- 88 colour support; new grid cell flag, and 256<->88 88<->16 translation tables
+- some fix for SF feature request 2527847 - now remain-by-default has gone
+  cannot control it per-session
diff --git a/tmux.1 b/tmux.1
index fe33bba7..50ea02dd 100644
--- a/tmux.1
+++ b/tmux.1
@@ -1,4 +1,4 @@
-.\" $Id: tmux.1,v 1.79 2009-02-07 08:22:11 nicm Exp $
+.\" $Id: tmux.1,v 1.80 2009-02-07 08:35:26 nicm Exp $
 .\"
 .\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
 .\"
@@ -980,6 +980,24 @@ current window, rather than the smallest session to which it is attached.
 The window may resize when the current window is changed on another sessions;
 this option is good for full-screen programs which support SIGWINCH and poor for
 interactive programs such as shells.
+.It Xo Ic automatic-rename
+.Op Ic on | Ic off
+.Xc
+Control automatic window renaming.
+When this setting is enabled,
+.Nm
+will attempt - on supported platforms - to rename the window to reflect the
+command currently running in it.
+This flag is automatically disabled for an individual window when a name
+is specified at creation with
+.Ic new-window or
+.Ic new-session ,
+or later with
+.Ic rename-window .
+It may be switched off globally with:
+.Bd -literal -offset indent
+set-window-option -g automatic-rename off
+.Ed
 .It Ic clock-mode-colour Ar colour
 Set clock colour.
 .It Xo Ic clock-mode-style