vt: respect relative position mode when clamping cursor
[dvtm.git] / dvtm.1
blobd7560eb782f73eaf41ca3916325f218b5e2f9173
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\-q
117 Quit dvtm.
118 .SS Mouse commands
120 .B Copy and Paste
121 By default dvtm captures mouse events to provide the actions listed below. Unfortunately
122 this interferes with the standard X copy and paste mechanism. To work around this
123 you need to hold down SHIFT while selecting or pasting text. Alternatively you can
124 disable mouse support at compile time, or use Mod\-M to toggle mouse support dynamically.
126 .B Button1 click
127 Select window.
129 .B Button1 double click
130 Select window and toggle maximization.
132 .B Button2 click
133 Zooms/cycles current window to/from master area.
135 .B Button3 click
136 Toggle minimization of current window.
138 .SH EXAMPLE
140 See the dvtm-status script as an example.
142 .SH CUSTOMIZATION
143 dvtm is customized by creating a custom config.h and (re)compiling the source
144 code. This keeps it fast, secure and simple.
146 .SH AUTHOR
147 dvtm is written by Marc Andre Tanner <mat at brain-dump.org>