dvtm.1

   1 .Dd $Mdocdate: December 27 2016 $
   2 .Dt DVTM 1
   3 .Os
   4 .Sh NAME
   5 .Nm dvtm
   6 .Nd dynamic virtual terminal manager
   7 .
   8 .
   9 .Sh SYNOPSIS
  10 .
  11 .Nm
  12 .Op Fl v
  13 .Op Fl M
  14 .Op Fl m Ar modifier
  15 .Op Fl d Ar delay
  16 .Op Fl h Ar lines
  17 .Op Fl t Ar title
  18 .Op Fl s Ar status-fifo
  19 .Op Fl c Ar cmd-fifo
  20 .Op Ar command Ar ...
  21 .
  22 .
  23 .Sh DESCRIPTION
  24 .
  25 .Nm
  26 is a dynamic tiling window manager for the console.
  27 .Pp
  28 As a console window manager it tries to make it easy to work with multiple
  29 console based applications.
  30 .
  31 .Bl -tag -width 8
  32 .It Fl v
  33 Print version information to standard output and exit.
  34 .
  35 .It Fl M
  36 Toggle default mouse grabbing upon startup. Use this to allow normal mouse operation
  37 under X.
  38 .
  39 .It Fl m Ar modifier
  40 Set command modifier at runtime.
  41 .
  42 .It Fl d Ar delay
  43 Set the delay ncurses waits before deciding if a character that might be
  44 part of an escape sequence is actually part of an escape sequence.
  45 .
  46 .It Fl h Ar lines
  47 Set the scrollback history buffer size at runtime.
  48 .
  49 .It Fl t Ar title
  50 Set a static terminal
  51 .Ar title
  52 and don't change it to the one of the currently focused window.
  53 .
  54 .It Fl s Ar status-fifo
  55 Open or create the named pipe
  56 .Pa status-fifo
  57 read its content and display it in the statusbar. See the
  58 .Xr dvtm-status 1
  59 script for an usage example.
  60 .
  61 .It Fl c Ar cmd-fifo
  62 Open or create the named pipe
  63 .Pa cmd-fifo
  64 and look for commands to execute which were defined in
  65 .Pa config.h .
  66 .
  67 .It Ar command Ar ...
  68 Execute
  69 .Ar command
  70 (s), each in a separate window.
  71 .El
  72 .
  73 .
  74 .Sh USAGE
  75 .
  76 .Ss Keyboard commands
  77 .
  78 Each keybinding begins with
  79 .Ic Mod
  80 which defaults to
  81 .Ic ^g
  82 but can be changed in
  83 .Pa config.h
  84 or with the
  85 .Fl m
  86 command line option.
  87 .
  88 .Bl -tag -width 8
  89 .It Ic Mod-c
  90 Create a new shell window.
  91 .
  92 .It Ic Mod-C
  93 Create a new shell window using the current working directory of the focused window.
  94 .
  95 .It Ic Mod-x-x
  96 Close focused window.
  97 .
  98 .It Ic Mod-l
  99 Increases the master area width about 5% (all except grid and
 100 fullscreen layout).
 101 .
 102 .It Ic Mod-h
 103 Decreases the master area width about 5% (all except grid and
 104 fullscreen layout).
 105 .
 106 .It Ic Mod-i
 107 Increase number of windows displayed in the master area.
 108 .
 109 .It Ic Mod-d
 110 Decrease number of windows displayed in the master area.
 111 .
 112 .It Ic Mod-j
 113 Focus next window.
 114 .
 115 .It Ic Mod-k
 116 Focus previous window.
 117 .
 118 .It Ic Mod-J
 119 Focus next non minimized window.
 120 .
 121 .It Ic Mod-K
 122 Focus previous non minimized window.
 123 .
 124 .It Ic Mod-[0..9]
 125 Focus the [0..9]-th window.
 126 .
 127 .It Ic Mod-Tab
 128 Focus previously selected window.
 129 .
 130 .It Ic Mod-.
 131 Toggle minimization of current window.
 132 .
 133 .It Ic Mod-m
 134 Maximize current window (change to fullscreen layout).
 135 .
 136 .It Ic Shift-PageUp
 137 .It Ic Mod-PageUp
 138 Scroll up.
 139 .
 140 .It Ic Shift-PageDown
 141 .It Ic Mod-PageDown
 142 Scroll down.
 143 .
 144 .It Ic Mod-Space
 145 Toggle between defined layouts (affects all windows).
 146 .
 147 .It Ic Mod-Enter
 148 Zooms/cycles current window to/from master area.
 149 .
 150 .It Ic Mod-f
 151 Change to vertical stack tiling layout.
 152 .
 153 .It Ic Mod-b
 154 Change to bottom stack tiling layout.
 155 .
 156 .It Ic Mod-g
 157 Change to grid layout.
 158 .
 159 .It Ic Mod-s
 160 Show/hide the status bar.
 161 .
 162 .It Ic Mod-S
 163 Toggle position of the status bar between top and bottom.
 164 .
 165 .It Ic Mod-r
 166 .
 167 .It Ic Mod-^L
 168 Redraw whole screen.
 169 .
 170 .It Ic Mod-a
 171 Toggle keyboard multiplexing mode, if activated keypresses are sent to all
 172 visible windows.
 173 .
 174 .It Ic Mod-M
 175 Toggle dvtm mouse grabbing.
 176 .
 177 .It Ic Mod-e
 178 Enter copy mode (see section below for further information).
 179 .
 180 .It Ic Mod-/
 181 Enter copy mode and start searching forward (assumes a vi-like editor).
 182 .
 183 .It Ic Mod-p
 184 Paste last copied text from copy mode at current cursor position.
 185 .
 186 .It Ic Mod-?
 187 Show this manual page.
 188 .
 189 .It Ic Mod-Mod
 190 Send the Mod key.
 191 .
 192 .It Ic Mod-F[1..n]
 193 .It Ic Mod-v-[1..n]
 194 View all windows with n-th tag.
 195 .
 196 .It Ic Mod-0
 197 View all windows with any tag.
 198 .
 199 .It Ic Mod-v-Tab
 200 Toggles to the previously selected tags.
 201 .
 202 .It Ic Mod-V-[1..n]
 203 Add/remove all windows with nth tag to/from the view.
 204 .
 205 .It Ic Mod-t-[1..n]
 206 Apply nth tag to focused window.
 207 .
 208 .It Ic Mod-T-[1..n]
 209 Add/remove nth tag to/from focused window.
 210 .
 211 .It Ic Mod-q-q
 212 Quit dvtm.
 213 .El
 214 .
 215 .
 216 .Ss Mouse commands
 217 .
 218 By default dvtm captures mouse events to provide the actions listed below.
 219 Unfortunately this interferes with the standard X copy and paste mechanism.
 220 To work around this you need to hold down
 221 .Ic Shift
 222 while selecting or pasting text.
 223 Alternatively you can disable mouse support at compile time, start dvtm with the
 224 .Fl M
 225 flag or toggle mouse support during runtime with
 226 .Ic Mod-M .
 227 .
 228 .Bl -tag -width 8
 229 .It Ic Button1 click
 230 Focus window.
 231 .
 232 .It Ic Button1 double click
 233 Focus window and toggle maximization.
 234 .
 235 .It Ic Button2 click
 236 Zoom/cycle current window to/from master area.
 237 .
 238 .It Ic Button3 click
 239 Toggle minimization of current window.
 240 .El
 241 .
 242 .
 243 .Ss Copy mode
 244 .
 245 Copy mode gives easy access to past output by piping it to an editor. What
 246 ever the editor prints to stdout upon exiting will be stored in an internal
 247 register and can be pasted into other clients (via
 248 .Ic Mod-p
 249 )
 250 .
 251 .
 252 .Sh ENVIRONMENT VARIABLES
 253 .
 254 .Bl -tag -width 8
 255 .It Ev DVTM
 256 Each process spawned by dvtm will have this variable set to the dvtm version
 257 it is running under.
 258 .
 259 .It Ev DVTM_WINDOW_ID
 260 Each process also has access to its constant and unique window id.
 261 .
 262 .It Ev DVTM_CMD_FIFO
 263 If the -c command line argument was specified upon dvtm startup, this variable
 264 will be set to the file name of the named pipe. Thus allowing the process
 265 to send commands back to dvtm.
 266 .
 267 .It Ev DVTM_TERM
 268 By default dvtm uses its own terminfo file and therefore sets
 269 .Ev TERM=dvtm
 270 within the client windows. This can be overridden by setting the
 271 .Ev DVTM_TERM
 272 environment variable to a valid terminal name before launching dvtm.
 273 .
 274 .It Ev DVTM_EDITOR
 275 When entering the copymode dvtm pipes the whole scroll back buffer to
 276 .Ev DVTM_EDITOR
 277 which is launched with
 278 .Fl
 279 (indicating to read from stdin) as its only argument.
 280 If
 281 .Ev DVTM_EDITOR
 282 is not set
 283 .Ev EDITOR
 284 is checked, if this is also not set the default value specified in
 285 .Pa config.h
 286 is used instead.
 287 .El
 288 .
 289 .
 290 .Sh EXAMPLE
 291 .
 292 See the
 293 .Xr dvtm-status 1
 294 script as an example of how to display text in the status bar.
 295 .
 296 .
 297 .Sh FILES
 298 .
 299 .Nm
 300 is customized by creating a custom
 301 .Pa config.h
 302 and (re)compiling the source code.
 303 This keeps it fast, secure and simple.
 304 .
 305 .
 306 .Sh SEE ALSO
 307 .
 308 .Xr abduco 1 ,
 309 .Xr dvtm-status 1
 310 .
 311 .
 312 .Sh AUTHOR
 313 .
 314 dvtm is written
 315 .An Marc André Tanner Aq Mt mat at brain-dump.org