Source cleanups, no functional change

[dvtm.git] / dvtm.1

.TH DVTM 1 dvtm\-VERSION
.nh
.SH NAME
dvtm \- dynamic virtual terminal manager
.SH SYNOPSIS
.B dvtm
.RB [ \-v ]
.RB [ \-M ]
.RB [ \-m
.IR modifier ]
.RB [ \-d
.IR delay ]
.RB [ \-h
.IR lines ]
.RB [ \-t
.IR title ]
.RB [ \-s
.IR status-fifo ]
.RB [ \-c
.IR cmd-fifo ]
.RI [ command \ ... "" ]
.SH DESCRIPTION
dvtm is a dynamic tiling window manager for the console.
As a console window manager it tries to make it easy to work with multiple
console based applications.
.SH OPTIONS
.TP
.B \-v
Print version information to standard output and exit.
.TP
.B \-M
Toggle default mouse grabbing upon startup. Use this to allow normal mouse operation
under X.
.TP
.BI \-m \ modifier
Set command modifier at runtime.
.TP
.BI \-d \ delay
Set the delay ncurses waits before deciding if a character that might be
part of an escape sequence is actually part of an escape sequence.
.TP
.BI \-h \ lines
Set the scrollback history buffer size at runtime.
.TP
.BI \-t \ title
Set a static terminal
.I title
and don't change it to the one of the currently focused window.
.TP
.BI \-s \ status-fifo
Open or create the named pipe
.I status-fifo
read its content and display it in the statusbar. See the
.I dvtm-status
script for an usage example.
.TP
.BI \-c \ cmd-fifo
Open or create the named pipe
.I cmd-fifo
and look for commands to execute which were defined in
.IR config.h .
.TP
.IR command \ ...
Execute
.IR command (s),
each in a separate window.
.SH USAGE
.SS Keyboard commands
.TP
.B Mod
Each keybinding begins with Mod which defaults to
.BR ^g ,
but can be changed in
.I config.h
or with the
.B \-m
command line option.
.TP
.B Mod\-c
Create a new shell window.
.TP
.B Mod\-x
Close focused window.
.TP
.B Mod\-l
Increases the master area width about 5% (all except grid and
fullscreen layout).
.TP
.B Mod\-h
Decreases the master area width about 5% (all except grid and
fullscreen layout).
.TP
.B Mod\-j
Focus next window.
.TP
.B Mod\-k
Focus previous window.
.TP
.BI Mod\- n
Focus the
.IR n \-th
window.
.TP
.B Mod\-.
Toggle minimization of current window.
.TP
.B Mod\-u
Focus next non minimized window.
.TP
.B Mod\-i
Focus prev non minimized window.
.TP
.B Mod\-m
Maximize current window (change to fullscreen layout).
.TP
.B Mod\-PageUp
Scroll up.
.TP
.B Mod\-PageDown
Scroll down.
.TP
.B Mod\-Space
Toggle between defined layouts (affects all windows).
.TP
.B Mod\-Enter
Zooms/cycles current window to/from master area.
.TP
.B Mod\-t
Change to vertical stack tiling layout.
.TP
.B Mod\-b
Change to bottom stack tiling layout.
.TP
.B Mod\-g
Change to grid layout.
.TP
.B Mod\-s
Show/hide the status bar.
.TP
.B Mod\-r
Redraw whole screen.
.TP
.B Mod\-a
Toggle keyboard multiplexing mode, if activated keypresses are sent to all
visible windows.
.TP
.B Mod\-X
Lock screen.
.TP
.B Mod\-B
Toggle bell (off by default).
.TP
.B Mod\-M
Toggle dvtm mouse grabbing.
.TP
.B Mod\-v
Enter copy mode (see section below for navigation commands).
.TP
.B Mod\-/
Enter copy mode and start searching forward.
.TP
.B Mod\-?
Enter copy mode and start searching backwards.
.TP
.B Mod\-p
Paste last copied text from copy mode at current cursor position.
.TP
.B Mod\-F1
Show this manual page.
.TP
.B Mod\-Mod
Send the Mod key.
.TP
.B Mod\-q
Quit dvtm.
.SS Mouse commands
.TP
.B Copy and Paste
By default dvtm captures mouse events to provide the actions listed below.
Unfortunately this interferes with the standard X copy and paste mechanism.
To work around this you need to hold down
.B Shift
while selecting or pasting text.
Alternatively you can disable mouse support at compile time, start dvtm with the
.B -M
flag or toggle mouse support during runtime with
.BR Mod\-M .
.TP
.B Button1 click
Select window.
.TP
.B Button1 double click
Select window and toggle maximization.
.TP
.B Button2 click
Zoom/cycle current window to/from master area.
.TP
.B Button3 click
Toggle minimization of current window.
.SS Copy mode
Copy mode gives easy access to past output.
The commands use vi style keybindings and support number prefixes as
command multipliers.
.TP
.B Entering
Copy mode can be entered with
.BR Mod\-v .
.TP
.B Navigation
Once in, navigation works with vi style keybindings
.RB ( h , j , k , l , ^ , $ , g , H , M , L , G )
as well as with the
.BR Arrows / Home / End / Page-Down / Page-Up
keys.
.TP
.B Searching
Search forward with
.B /
and backwards with
.BR ? .
Jump forward to next match with
.BR n .
Jump backwards to next match with
.BR N .
.TP
.B Selecting
To start making a selection press
.B v
(similar to visual mode in vi).
.TP
.B Copying
To copy the current selection use
.BR y .
If you haven't made a selection the current line is copied.
Add a number prefix to copy n lines starting from the current line.
This command leaves the copy mode.
.TP
.B Pasting
The previously copied text can be pasted at the current cursor position
with
.BR Mod\-p .
.TP
.B Leaving
Copy mode is automatically left upon copying something. To manually
exit at any time press
.B ESC
or
.BR q .
.SH ENVIRONMENT VARIABLES
By default dvtm uses its own terminfo file and therefore sets
.BR TERM=dvtm
within the client windows. This can be overridden by setting the
.BR DVTM_TERM
environment variable to a valid terminal name before launching dvtm.
.SH EXAMPLE
See the
.I dvtm-status
script as an example of how to display text in the
status bar.
.SH CUSTOMIZATION
dvtm is customized by creating a custom
.I config.h
and (re)compiling the source code.
This keeps it fast, secure and simple.
.SH AUTHOR
dvtm is written by Marc André Tanner <mat at brain-dump.org>