vt: set TERM=dvtm[-256color] in emulation
[dvtm.git] / dvtm.1
blobb3f7f9b9b4f7e8f09dc31186bbc93a104fe560f1
1 .TH DVTM 1 dvtm\-VERSION
2 .SH NAME
3 dvtm \- dynamic virtual terminal manager
4 .SH SYNOPSIS
5 .B dvtm
6 .RB [ \-v ] \ [ \-m \ mod ] \ [ \-s \ status-fifo ] \ [cmd...]
7 .SH DESCRIPTION
8 dvtm is a dynamic tiling window manager for the console.
9 As a console window manager it tries to make it easy to work with multiple
10 console based applications.
11 .SH OPTIONS
12 .TP
13 .B \-v
14 prints version information to standard output, then exits.
15 .TP
16 .B \-m mod
17 set default modifier at runtime.
18 .TP
19 .B \-d escdelay
20 set the delay ncurses waits before deciding if a character that might be part
21 of an escape sequence is actually part of an escape sequence.
22 .TP
23 .B \-h nnn
24 set the scrollback history buffer size at runtime.
25 .TP
26 .B \-s status-fifo
27 if status-fifo is a named pipe, its content is read and displayed. See the dvtm-status script
28 for an usage example.
29 .TP
30 .B [cmd...]
31 Execute cmd after dvtm is started.
32 .SH USAGE
33 .SS Keyboard commands
34 .TP
35 .B Mod
36 Each keybinding begins with Mod which defaults to ^g but can be changed in config.h or with
37 the -m command line option.
38 .TP
39 .B Mod\-c
40 Create a new shell window.
41 .TP
42 .B Mod\-x
43 Close focused window.
44 .TP
45 .B Mod\-l
46 Increases the master area width about 5% (all except grid and fullscreen layout).
47 .TP
48 .B Mod\-h
49 Decreases the master area width about 5% (all except grid and fullscreen layout).
50 .TP
51 .B Mod\-j
52 Focus next window.
53 .TP
54 .B Mod\-k
55 Focus previous window.
56 .TP
57 .B Mod\-[1..n]
58 Focus the
59 .BR nth
60 window.
61 .TP
62 .B Mod\-.
63 Toggle minimization of current window.
64 .TP
65 .B Mod\-u
66 Focus next non minimized window.
67 .TP
68 .B Mod\-i
69 Focus prev non minimized window.
70 .TP
71 .B Mod\-m
72 Maximize current window (change to fullscreen layout).
73 .TP
74 .B Mod\-PageUp
75 Scroll up.
76 .TP
77 .B Mod\-PageDown
78 Scroll down.
79 .TP
80 .B Mod\-Space
81 Toggle between defined layouts (affects all windows).
82 .TP
83 .B Mod\-Enter
84 Zooms/cycles current window to/from master area.
85 .TP
86 .B Mod\-t
87 Change to vertical stack tiling layout.
88 .TP
89 .B Mod\-b
90 Change to bottom stack tiling layout.
91 .TP
92 .B Mod\-g
93 Change to grid layout.
94 .TP
95 .B Mod\-s
96 Shows/hides the status bar.
97 .TP
98 .B Mod\-r
99 Redraw whole screen.
101 .B Mod\-G
102 Escape the next typed key.
104 .B Mod\-a
105 Toggle keyboard multiplexing mode, if activated keypresses are sent to all non minimized windows.
107 .B Mod\-X
108 Lock screen.
110 .B Mod\-B
111 Toggle bell (off by default).
113 .B Mod\-M
114 Toggle dvtm mouse grabbing.
116 .B Mod\-v
117 Enter copy mode (see section below for navigation commands).
119 .B Mod\-/
120 Enter copy mode and start searching forward.
122 .B Mod\-?
123 Enter copy mode and start searching backwards.
125 .B Mod\-p
126 Paste last copied text from copy mode at current cursor position.
128 .B Mod\-F1
129 Show this manual page.
131 .B Mod\-q
132 Quit dvtm.
133 .SS Mouse commands
135 .B Copy and Paste
136 By default dvtm captures mouse events to provide the actions listed below. Unfortunately
137 this interferes with the standard X copy and paste mechanism. To work around this
138 you need to hold down SHIFT while selecting or pasting text. Alternatively you can
139 disable mouse support at compile time, or use Mod\-M to toggle mouse support dynamically.
141 .B Button1 click
142 Select window.
144 .B Button1 double click
145 Select window and toggle maximization.
147 .B Button2 click
148 Zooms/cycles current window to/from master area.
150 .B Button3 click
151 Toggle minimization of current window.
153 .SS Copy mode
154 Copy mode gives easy access to past output. The commands use vi style keybindings
155 and support number prefixes as command multiplier.
157 .B Entering
158 Copy mode can be entered with \fBMod\-v\fR.
160 .B Navigation
161 Once in, navigation works with vi style keybindings (\fBh,j,k,l,^,$,g,H,M,L,G\fR) as well as with the
162 \fBArrows/Home/End/Page-Down/Page-Up\fR keys.
164 .B Searching
165 Search forward with \fB/\fR and backwards with \fB?\fR. Jump forward to next match with \fBn\fR.
166 Jump backwards to next match with \fBN\fR.
168 .B Selecting
169 To start making a selection press \fBv\fR (similar to visual mode in vi).
171 .B Copying
172 To copy the current selection use \fBy\fR. If you haven't made a selection the current line is copied.
173 Add a number prefix to copy n lines starting from the current line. This command leaves the copy mode.
175 .B Pasting
176 The previously copied text can be pasted at the current cursor position with \fBMod\-p\fR.
178 .B Leaving
179 Copy mode is automatically left upon copying something. To manually exit at any
180 time press \fBESC\fR or \fBq\fR.
182 .SH EXAMPLE
184 See the dvtm-status script as an example of how to display text in the status bar.
186 .SH CUSTOMIZATION
187 dvtm is customized by creating a custom config.h and (re)compiling the source
188 code. This keeps it fast, secure and simple.
190 .SH AUTHOR
191 dvtm is written by Marc Andre Tanner <mat at brain-dump.org>