dvtm

dynamic virtual terminal manager - with my changes
git clone https://pi.duncano.de/git/dvtm.git
Log | Files | Refs | README | LICENSE

commit fa9d946d25148f9a365aaeee791bf6018417e44a
parent cf967ef47903647376673cb5d2cd0396aeab4ce7
Author: Marc André Tanner <mat@brain-dump.org>
Date:   Thu,  5 Jan 2017 16:37:50 +0100

Slightly tweak manual pages

Diffstat:
dvtm-editor.1 | 50++++++++++++++++++++++++++++++--------------------
dvtm-pager.1 | 43+++++++++++++++++++------------------------
dvtm.1 | 4++--
3 files changed, 51 insertions(+), 46 deletions(-)

diff --git a/dvtm-editor.1 b/dvtm-editor.1 @@ -1,6 +1,6 @@ -.Dd $Mdocdate: December 27 2016 $ +.Dd December 27, 2016 .Dt DVTM-EDITOR 1 -.Os +.Os dvtm VERSION .Sh NAME .Nm dvtm-editor .Nd make a text editor act as a filter @@ -18,24 +18,23 @@ The .Nm is a file buffering utility used by the .Xr 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. +terminal multiplexer to implement its copy mode. It reads the standard input and saves it to a temporary +file, then opens an editor according to the +.Sx "ENVIRONMENT VARIABLES" . .Pp -Once the editor quits, if the file was not saved, +If the invoked editor terminates with a non-zero exit status or +the file modification time remains unchanged, .Nm -does not output anything. Otherwise, it output the content of the temporary +does not output anything. Otherwise, it outputs the content of the modified temporary file to stdout. .Pp +All command line arguments are forwarded verbatim. .Xr dvtm 1 -will remove the escape sequences such as colouring and cursor control before to -write to -.Nm . -.Pp -.Cm ARGS -are passed to the selected editor. This is used by -.Xr dvtm 1 -to jump to current line number. +uses this to adjust the initial view port by passing +.Sy +n , +meaning the start of line +.Sy n +should be displayed. . . .Sh ENVIRONMENT VARIABLES @@ -43,7 +42,7 @@ to jump to current line number. .Nm will try to find the user editor by checking these variables in order: . -.Bl -tag -width 8 +.Bl -tag -width indent .It Ev DVTM_EDITOR Permitting to invoke an editor specific to dvtm, or set particular flags. . @@ -54,16 +53,27 @@ and .Ev EDITOR . .El .Pp -If no editor is found, the +If no editor is found, .Xr vi 1 -editor is used. +is used. . . .Sh FILES . The temporary files are created according to the template: -.Pa /tmp/dvtm-editor.XXXXXX +.Pa /tmp/dvtm-editor.XXXXXX . +.Pp +.Pa /dev/tty +is opened to obtain a controlling tty which is used for the standard input/output +streams of the invoked editor. +. +.Sh NOTES . +Using +.Xr vis 1 +as editor is particularly convenient because +.Ic :wq! +in visual mode will reduce the file to the currently active selection(s). . .Sh SEE ALSO . @@ -74,5 +84,5 @@ The temporary files are created according to the template: . .Sh AUTHOR . -dvtm is written +dvtm is written by .An Marc André Tanner Aq Mt mat at brain-dump.org diff --git a/dvtm-pager.1 b/dvtm-pager.1 @@ -1,6 +1,6 @@ -.Dd $Mdocdate: January 03 2017 $ +.Dd January 03, 2017 .Dt DVTM-PAGER 1 -.Os +.Os dvtm VERSION .Sh NAME .Nm dvtm-pager .Nd select apropriate pager for dvtm @@ -14,46 +14,41 @@ ARGS... . .Sh DESCRIPTION . -The .Nm -is an utility used by +is an utility used by the .Xr dvtm 1 -for choosing apropriate pager to displaying the scrollback history. -.Pp -It starts the pager with -.Cm ARGS , -sending all scrollback to its standard input. -.Nm -does not output anything. Otherwise, it output the content of the temporary -file to stdout. +terminal multiplexer to display its scrollback history using a suitable pager. .Pp +The invoked pager is expected to display the data sent to its standard input. +The data stream might contain ANSI color escape sequence. +All command line arguments are forwarded verbatim. .Xr dvtm 1 -will preserve the escape sequences such as colouring and cursor control while -sending the scrollback to -.Nm . -.Pp +uses this to adjust the initial view port by passing +.Sy +n , +meaning the start of line +.Sy n +should be displayed. . . .Sh ENVIRONMENT VARIABLES . .Nm -will try to find the user pager by checking these variables in order: +will try to find the preferred pager by checking these variables in order: . -.Bl -tag -width 8 +.Bl -tag -width indent .It Ev DVTM_PAGER -Permitting to invoke an editor specific to dvtm, or set particular flags such as +Permitting to invoke a pager specific to dvtm, or set particular flags such as .Fl R for .Xr less 1 . . .It Ev PAGER -Falling back to global defaults: -.Ev PAGER . +Falling back to the default pager. .El .Pp -If no pager is found, the +If none of these variables are set, .Xr less 1 -pager is used. +is used. . . .Sh SEE ALSO @@ -65,5 +60,5 @@ pager is used. . .Sh AUTHOR . -dvtm is written +dvtm is written by .An Marc André Tanner Aq Mt mat at brain-dump.org diff --git a/dvtm.1 b/dvtm.1 @@ -1,6 +1,6 @@ -.Dd $Mdocdate: December 27 2016 $ +.Dd December 27, 2016 .Dt DVTM 1 -.Os +.Os dvtm VERSION .Sh NAME .Nm dvtm .Nd dynamic virtual terminal manager