dvtm

Fork of dvtm, a minimal terminal multiplexer
git clone git://git.laack.co/dvtm.git
Log | Files | Refs | README | LICENSE

dvtm.1 (6285B)

      1 .Dd December 27, 2016
      2 .Dt DVTM 1
      3 .Os dvtm VERSION
      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 window below.
    120 .
    121 .It Ic Mod-K
    122 Focus window above.
    123 .
    124 .It Ic Mod-H
    125 Focus window to the left.
    126 .
    127 .It Ic Mod-L
    128 Focus window to the right.
    129 .
    130 .It Ic Mod-[0..9]
    131 Focus the [0..9]-th window.
    132 .
    133 .It Ic Mod-Tab
    134 Focus previously selected window.
    135 .
    136 .It Ic Mod-.
    137 Toggle minimization of current window.
    138 .
    139 .It Ic Mod-m
    140 Maximize current window (change to fullscreen layout).
    141 .
    142 .It Ic Shift-PageUp
    143 .It Ic Mod-PageUp
    144 Scroll up.
    145 .
    146 .It Ic Shift-PageDown
    147 .It Ic Mod-PageDown
    148 Scroll down.
    149 .
    150 .It Ic Mod-Space
    151 Toggle between defined layouts (affects all windows).
    152 .
    153 .It Ic Mod-Enter
    154 Zooms/cycles current window to/from master area.
    155 .
    156 .It Ic Mod-f
    157 Change to vertical stack tiling layout.
    158 .
    159 .It Ic Mod-b
    160 Change to bottom stack tiling layout.
    161 .
    162 .It Ic Mod-g
    163 Change to grid layout.
    164 .
    165 .It Ic Mod-s
    166 Show/hide the status bar.
    167 .
    168 .It Ic Mod-S
    169 Toggle position of the status bar between top and bottom.
    170 .
    171 .It Ic Mod-r
    172 .
    173 .It Ic Mod-^L
    174 Redraw whole screen.
    175 .
    176 .It Ic Mod-a
    177 Toggle keyboard multiplexing mode, if activated keypresses are sent to all
    178 visible windows.
    179 .
    180 .It Ic Mod-M
    181 Toggle dvtm mouse grabbing.
    182 .
    183 .It Ic Mod-e
    184 Enter copy mode (see section below for further information).
    185 .
    186 .It Ic Mod-/
    187 Enter copy mode and start searching forward (assumes a vi-like editor).
    188 .
    189 .It Ic Mod-p
    190 Paste last copied text from copy mode at current cursor position.
    191 .
    192 .It Ic Mod-?
    193 Show this manual page.
    194 .
    195 .It Ic Mod-Mod
    196 Send the Mod key.
    197 .
    198 .It Ic Mod-F[1..n]
    199 .It Ic Mod-v-[1..n]
    200 View all windows with n-th tag.
    201 .
    202 .It Ic Mod-0
    203 View all windows with any tag.
    204 .
    205 .It Ic Mod-v-Tab
    206 Toggles to the previously selected tags.
    207 .
    208 .It Ic Mod-V-[1..n]
    209 Add/remove all windows with nth tag to/from the view.
    210 .
    211 .It Ic Mod-t-[1..n]
    212 Apply nth tag to focused window.
    213 .
    214 .It Ic Mod-T-[1..n]
    215 Add/remove nth tag to/from focused window.
    216 .
    217 .It Ic Mod-q-q
    218 Quit dvtm.
    219 .El
    220 .
    221 .
    222 .Ss Mouse commands
    223 .
    224 By default dvtm captures mouse events to provide the actions listed below.
    225 Unfortunately this interferes with the standard X copy and paste mechanism.
    226 To work around this you need to hold down
    227 .Ic Shift
    228 while selecting or pasting text.
    229 Alternatively you can disable mouse support at compile time, start dvtm with the
    230 .Fl M
    231 flag or toggle mouse support during runtime with
    232 .Ic Mod-M .
    233 .
    234 .Bl -tag -width 8
    235 .It Ic Button1 click
    236 Focus window.
    237 .
    238 .It Ic Button1 double click
    239 Focus window and toggle maximization.
    240 .
    241 .It Ic Button2 click
    242 Zoom/cycle current window to/from master area.
    243 .
    244 .It Ic Button3 click
    245 Toggle minimization of current window.
    246 .El
    247 .
    248 .
    249 .Ss Copy mode
    250 .
    251 Copy mode gives easy access to past output by piping it to
    252 .Xr dvtm-editor 1 ,
    253 opening an editor.
    254 What the editor writes will be stored in an internal register and can be pasted
    255 into other clients (via
    256 .Ic Mod-p ).
    257 .
    258 .
    259 .Sh ENVIRONMENT VARIABLES
    260 .
    261 .Bl -tag -width 8
    262 .It Ev DVTM
    263 Each process spawned by dvtm will have this variable set to the dvtm version
    264 it is running under.
    265 .
    266 .It Ev DVTM_WINDOW_ID
    267 Each process also has access to its constant and unique window id.
    268 .
    269 .It Ev DVTM_CMD_FIFO
    270 If the -c command line argument was specified upon dvtm startup, this variable
    271 will be set to the file name of the named pipe. Thus allowing the process
    272 to send commands back to dvtm.
    273 .
    274 .It Ev DVTM_TERM
    275 By default dvtm uses its own terminfo file and therefore sets
    276 .Ev TERM=dvtm
    277 within the client windows. This can be overridden by setting the
    278 .Ev DVTM_TERM
    279 environment variable to a valid terminal name before launching dvtm.
    280 .
    281 .It Ev DVTM_EDITOR
    282 When entering the copymode dvtm pipes the whole scroll back buffer to
    283 .Xr dvtm-editor 1
    284 which opens the content in
    285 .Ev DVTM_EDITOR ,
    286 with fallbacks to
    287 .Ev VISUAL ,
    288 .Ev EDITOR
    289 and
    290 .Xr vi 1
    291 .Pa config.h
    292 is used instead.
    293 .El
    294 .
    295 .
    296 .Sh EXAMPLE
    297 .
    298 See the
    299 .Xr dvtm-status 1
    300 script as an example of how to display text in the status bar.
    301 .
    302 .
    303 .Sh FILES
    304 .
    305 .Nm
    306 is customized by creating a custom
    307 .Pa config.h
    308 and (re)compiling the source code.
    309 This keeps it fast, secure and simple.
    310 .
    311 .
    312 .Sh SEE ALSO
    313 .
    314 .Xr abduco 1 ,
    315 .Xr dvtm-status 1
    316 .
    317 .
    318 .Sh AUTHOR
    319 .
    320 dvtm is written
    321 .An Marc André Tanner Aq Mt mat at brain-dump.org