search

martanne / dvtm

dvtm brings the concept of tiling window management, popularized by X11-window managers like dwm to the console. As a console window manager it tries to make it easy to work with multiple console based programs.
MIT License
848 stars 105 forks source link

Adding dvtm-pager.1 and dvtm-editor.1 #52

Closed ghost closed 7 years ago

ghost commented 7 years ago 
mandoc -T html dvtm-pager.1
mandoc -T html dvtm-editor.1
DVTM-PAGER(1) General Commands Manual DVTM-PAGER(1)

NAME

dvtm-pager — select apropriate pager for dvtm

SYNOPSIS

dvtm-pager ARGS...

DESCRIPTION

The dvtm-pager is an utility used by dvtm(1) for choosing apropriate pager to displaying the scrollback history.
It starts the pager with ARGS, sending all scrollback to its standard input. dvtm-pager does not output anything. Otherwise, it output the content of the temporary file to stdout.

dvtm(1) will preserve the escape sequences such as colouring and cursor control while sending the scrollback to dvtm-pager.

ENVIRONMENT VARIABLES

dvtm-pager will try to find the user pager by checking these variables in order:
DVTM_PAGER
Permitting to invoke an editor specific to dvtm, or set particular flags such as -R for less(1).
PAGER
Falling back to global defaults: PAGER.
If no pager is found, the less(1) pager is used.

SEE ALSO

less(1), dvtm(1), dvtm-editor(1)

AUTHOR

dvtm is written Marc André Tanner <mat at brain-dump.org>
January 3, 2017 Linux 4.8.4-1-ARCH

DVTM-EDITOR(1) General Commands Manual DVTM-EDITOR(1)

NAME

dvtm-editor — make a text editor act as a filter

SYNOPSIS

dvtm-editor ARGS...

DESCRIPTION

The dvtm-editor is a file buffering utility used by the dvtm(1) terminal multiplexer. It reads the standard input and save it to a temporary file, then opens an editor according to the environment variables. The file can be edited and saved.
Once the editor quits, if the file was not saved, dvtm-editor does not output anything. Otherwise, it output the content of the temporary file to stdout.
dvtm(1) will remove the escape sequences such as colouring and cursor control before to write to dvtm-editor.
ARGS are passed to the selected editor. This is used by dvtm(1) to jump to current line number.

ENVIRONMENT VARIABLES

dvtm-editor will try to find the user editor by checking these variables in order:
DVTM_EDITOR
Permitting to invoke an editor specific to dvtm, or set particular flags.
VISUAL, EDITOR
Falling back to global defaults: VISUAL and EDITOR.
If no editor is found, the vi(1) editor is used.

FILES

The temporary files are created according to the template: /tmp/dvtm-editor.XXXXXX

SEE ALSO

vi(1), dvtm(1), dvtm-pager(1)

AUTHOR

dvtm is written Marc André Tanner <mat at brain-dump.org>
December 27, 2016 Linux 4.8.4-1-ARCH
ghost commented 7 years ago

I hope it is ok. If not, do not hesitate to ask for adjustment.