[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[screen-devel] Improved table rendering for the manual page
|
From: |
Marcin Cieslak |
|
Subject: |
[screen-devel] Improved table rendering for the manual page |
|
Date: |
Fri, 25 May 2018 21:01:50 +0000 |
Hello,
thanks for merging my fixes to the manual page. Here is more,
this time I have improved the way the manual page looks after
converting to printable format (PostScript, PDF).
Most changes improve the way the tables are built.
All changes are available as the "fix-man" branch from this repo:
http://repo.or.cz/screen/saper.git
I attach the manual page formatted as PDF with the changes below.
One more remark:
A manpage includes a reference to the current screen version
number. We probably need to update for every release...
Below I include a log of all changes not to spam the mailing
list of single patches.
Pozdrawiam serdecznie,
Marcin
- Log -----------------------------------------------------------------
commit 85a0d1de14d3d2a667ba4da9131a2b52678241df
Author: Marcin Cieślak <address@hidden>
Date: Fri, 25 May 2018 20:43:15 +0200
URL: <http://repo.or.cz/screen/saper.git/85a0d1de14d3d2a6>
manpage: Print = instead of double horizontal line
"Keypad =" table entry had a double horizontal line instead of a single "="
when printed with troff.
From "Tbl -- A Program to Format Tables" by M. E. Lesk:
Single column horizontal lines
-- An input table entry containing only the character (...) = is
taken to be a single or double line extending the full width of the
column. Such lines are extended to meet horizontal or vertical
lines adjoining this column. To obtain these characters explicitly
in a column, either precede them by \& or follow them by a space
before the usual tab or newline.
---
src/doc/screen.1 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/doc/screen.1 b/src/doc/screen.1
index 9c3bb46f4bcb..697fd568277f 100644
--- a/src/doc/screen.1
+++ b/src/doc/screen.1
@@ -4859,7 +4859,7 @@ Keypad + f+ + \e033Ok
Keypad \- f\- \- \e033Om
Keypad * f* * \e033Oj
Keypad / f/ / \e033Oo
-Keypad = fq = \e033OX
+Keypad = fq \&= \e033OX
Keypad . f. . \e033On
Keypad , f, , \e033Ol
Keypad enter fe \e015 \e033OM
commit c84f2b9569d0e7eece6b0a4dbd8884900be937ff
Author: Marcin Cieślak <address@hidden>
Date: Fri, 25 May 2018 21:20:32 +0200
URL: <http://repo.or.cz/screen/saper.git/c84f2b9569d0e7ee>
manpage: add vertical space after bindkey examples
bindkey examples seem to be glued to their following descriptions.
This looks bad in the printable versions, so give it some space.
Alternatively we could possibly reverse the indentation and use
something like this:
bindkey -d
Show all of the default key bindings.
but this is inconsistent with other examples.
---
src/doc/screen.1 | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/doc/screen.1 b/src/doc/screen.1
index 697fd568277f..5e7680b87d0f 100644
--- a/src/doc/screen.1
+++ b/src/doc/screen.1
@@ -1153,23 +1153,27 @@ Here are some examples of keyboard bindings:
.nf
bindkey \-d
.fi
+.sp
Show all of the default key bindings. The application mode entries
are marked with [A].
.sp
.nf
bindkey \-k k1 select 1
.fi
+.sp
Make the "F1" key switch to window one.
.sp
.nf
bindkey \-t foo stuff barfoo
.fi
+.sp
Make "foo" an abbreviation of the word "barfoo". Timeout is disabled
so that users can type slowly.
.sp
.nf
bindkey "\e024" mapdefault
.fi
+.sp
This key-binding makes \*Q^T\*U an escape character for key-bindings. If
you did the above \*Qstuff barfoo\*U binding, you can enter the word
\*Qfoo\*U by typing \*Q^Tfoo\*U. If you want to insert a \*Q^T\*U
@@ -1178,6 +1182,7 @@ you have to press the key twice (i.e., escape the escape
binding).
.nf
bindkey \-k F1 command
.fi
+.sp
Make the F11 (not F1!) key an alternative screen
escape (besides ^A).
.RE
commit 7fa749f297fb4f6e478e4812f0398a7e30e31846
Author: Marcin Cieślak <address@hidden>
Date: Fri, 25 May 2018 21:41:44 +0200
URL: <http://repo.or.cz/screen/saper.git/7fa749f297fb4f6e>
manpage: Remove horizontal lines on large tables
Remove "allbox" tbl option from large keybinding table.
When formatting for print, large tbl tables need to be handled
specially to split nicely across the pages; instead we
just add horizontal lines and we let them overflow the pages.
The input translation table seems to fit nicely on one page
and is left as is with the "allbox" option.
---
src/doc/screen.1 | 117 +++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 113 insertions(+), 4 deletions(-)
diff --git a/src/doc/screen.1 b/src/doc/screen.1
index 5e7680b87d0f..9ae7e01ae03f 100644
--- a/src/doc/screen.1
+++ b/src/doc/screen.1
@@ -436,36 +436,45 @@ The following table shows the default key bindings. The
trailiing
commas in boxes with multiple keystroke entries are separators,
not part of the bindings.
.TS
-allbox tab(;);
+tab(;);
lb l l.
+_
C-a ';(select);T{
Prompt for a window name or number to switch to.
T}
+_
C-a \[dq];(windowlist -b);T{
Present a list of all windows for selection.
T}
+_
C-a \fIdigit\fP;(select 0-9);T{
Switch to window number 0 \- 9
T}
+_
C-a -;(select -);T{
Switch to window number 0 \- 9, or to the blank window.
T}
+_
C-a tab;(focus);T{
Switch the input focus to the next region.
See also \fIsplit, remove, only\fP.
T}
+_
C-a C-a;(other);T{
Toggle to the window displayed previously.
Note that this binding defaults to the command character typed twice,
unless overridden. For instance, if you use the option \*Q\fB\-e]x\fP\*U,
this command becomes \*Q]]\*U.
T}
+_
C-a a ;(meta);T{
Send the command character (C-a) to window. See \fIescape\fP command.
T}
+_
C-a A;(title);T{
Allow the user to enter a name for the current window.
T}
+_
T{
C-a b,
.br
@@ -473,9 +482,11 @@ C-a C-b
T};(break);T{
Send a break to window.
T}
+_
C-a B;(pow_break);T{
Reopen the terminal line and send a break.
T}
+_
T{
C-a c,
.br
@@ -483,9 +494,11 @@ C-a C-c
T};(screen);T{
Create a new window with a shell and switch to that window.
T}
+_
C-a C\fP;(clear);T{
Clear the screen.
T}
+_
T{
C-a d,
.br
@@ -495,9 +508,11 @@ Detach
.I screen
from this terminal.
T}
+_
C-a D D;(pow_detach);T{
Detach and logout.
T}
+_
T{
C-a f,
.br
@@ -505,20 +520,25 @@ C-a C-f\fP
T};(flow);T{
Toggle flow \fIon\fP, \fIoff\fP or \fIauto\fP.
T}
+_
C-a F;(fit);T{
Resize the window to the current region size.
T}
+_
C-a C-g;(vbell);T{
Toggles
.I screen's
visual bell mode.
T}
+_
C-a h;(hardcopy);T{
Write a hardcopy of the current window to the file \*Qhardcopy.\fIn\fP\*U.
T}
+_
C-a H;(log);T{
Begins/ends logging of the current window to the file \*Qscreenlog.\fIn\fP\*U.
T}
+_
T{
C-a i,
.br
@@ -526,6 +546,7 @@ C-a C-i
T};(info);T{
Show info about this window.
T}
+_
T{
C-a k,
.br
@@ -533,6 +554,7 @@ C-a C-k
T};(kill);T{
Destroy current window.
T}
+_
T{
C-a l,
.br
@@ -540,11 +562,13 @@ C-a C-l
T};(redisplay);T{
Fully refresh current window.
T}
+_
C-a L;(login);T{
Toggle this windows login slot. Available only if
.I screen
is configured to update the utmp database.
T}
+_
T{
C-a m,
.br
@@ -552,9 +576,11 @@ C-a C-m
T};(lastmsg);T{
Repeat the last message displayed in the message line.
T}
+_
C-a M;(monitor);T{
Toggles monitoring of the current window.
T}
+_
T{
C-a space,
.br
@@ -564,9 +590,11 @@ C-a C-n
T};(next);T{
Switch to the next window.
T}
+_
C-a N;(number);T{
Show the number (and title) of the current window.
T}
+_
T{
C-a backspace,
.br
@@ -578,6 +606,7 @@ C-a C-p
T};(prev);T{
Switch to the previous window (opposite of \fBC-a n\fP).
T}
+_
T{
C-a q,
.br
@@ -585,10 +614,12 @@ C-a C-q
T};(xon);T{
Send a control-q to the current window.
T}
+_
C-a Q;(only);T{
Delete all regions but the current one.
See also \fIsplit, remove, focus\fP.
T}
+_
T{
C-a r,
.br
@@ -597,6 +628,7 @@ T};(wrap);T{
Toggle the current window's line-wrap setting (turn the current window's
automatic margins on and off).
T}
+_
T{
C-a s,
.br
@@ -604,10 +636,12 @@ C-a C-s;
T};(xoff);T{
Send a control-s to the current window.
T}
+_
C-a S;(split);T{
Split the current region horizontally into two new ones.
See also \fIonly, remove, focus\fP.
T}
+_
T{
C-a t,
.br
@@ -615,9 +649,11 @@ C-a C-t
T};(time);T{
Show system information.
T}
+_
C-a v;(version);T{
Display the version and compilation date.
T}
+_
C-a C-v;(digraph);T{
Enter digraph.
T}
@@ -628,16 +664,20 @@ C-a C-w
T};(windows);T{
Show a list of window.
T}
+_
C-a W;(width);T{
Toggle 80/132 columns.
T}
+_
C-a x \fRor\fP C-a C-x;(lockscreen);T{
Lock this terminal.
T}
+_
C-a X\fP ;(remove);T{
Kill the current region.
See also \fIsplit, only, focus\fP.
T}
+_
T{
C-a z,
.br
@@ -647,22 +687,28 @@ Suspend
.IR screen .
Your system must support BSD-style job-control.
T}
+_
C-a Z;(reset);T{
Reset the virtual terminal to its \*Qpower-on\*U values.
T}
+_
C-a .;(dumptermcap);T{
Write out a \*Q.termcap\*U file.
T}
+_
C-a ?;(help);T{
Show key bindings.
T}
+_
C-a \e;(quit);T{
Kill all windows and terminate
.IR screen .
T}
+_
C-a :;(colon);T{
Enter command line mode.
T}
+_
T{
C-a [,
.br
@@ -672,6 +718,7 @@ C-a esc
T};(copy);T{
Enter copy/scrollback mode.
T}
+_
T{
C-a C-],
.br
@@ -680,6 +727,7 @@ T};(paste .);T{
Write the contents of the paste buffer to the stdin queue of the
current window.
T}
+_
T{
C-a {\fP,
.br
@@ -687,29 +735,37 @@ C-a }
T};(history);T{
Copy and paste a previous (command) line.
T}
+_
C-a >;(writebuf);T{
Write paste buffer to a file.
T}
+_
C-a <;(readbuf);T{
Reads the screen-exchange file into the paste buffer.
T}
+_
C-a =;(removebuf);T{
Removes the file used by \fBC-a <\fP and \fPC-a >\fP.
T}
+_
C-a ,;(license);T{
Shows where
.I screen
comes from, where it went to and why you can use it.
T}
+_
C-a _;(silence);T{
Start/stop monitoring the current window for inactivity.
T}
+_
C-a |;(split -v);T{
Split the current region vertically into two new ones.
T}
+_
C-a *;(displays);T{
Show a listing of all currently attached displays.
T}
+_
.TE
.SH CUSTOMIZATION
@@ -1400,62 +1456,82 @@ window and its history into the paste buffer. In this
mode a vi-like
The editor's movement keys are:
.TS
-allbox tab(@);
+tab(@);
l l.
+_
T{
\fBh\fP, \fBC-h\fP,
.br
\fBleft arrow\fP
address@hidden the cursor left.
+_
T{
\fBj\fP, \fBC-n\fP,
.br
\fBdown arrow\fP
address@hidden the cursor down.
+_
T{
\fBk\fP, \fBC-p\fP,
.br
\fBup arrow\fP
address@hidden the cursor up.
+_
T{
\fBl\fP ('el'),
.br
\fBright arrow\fP
address@hidden the cursor right.
+_
\fB0\fP (zero) address@hidden to the leftmost column.
+_
\fB+\fP and address@hidden one line up and down.
+_
\fBH\fP, \fBM\fP and address@hidden
move the cursor to the leftmost column
of the top, center or bottom line of the window.
T}
+_
\fB|address@hidden to the specified absolute column.
+_
\fBg\fP or address@hidden to the beginning of the buffer.
+_
\fBG\fP or address@hidden
moves to the specified absolute line (default: end of buffer).
T}
+_
address@hidden to the specified percentage of the buffer.
+_
\fB^\fP or address@hidden
move to the leftmost column, to the first or last
non-whitespace character on the line.
T}
+_
\fBw\fP, \fBb\fP, and address@hidden the cursor word by word.
+_
\fBB\fP, address@hidden the cursor WORD by WORD (as in vi).
+_
\fBf/F\fP, \fBt/address@hidden
move the cursor forward/backward to the next occurence of the
target. (eg, '3fy' will move the cursor to the 3rd 'y' to the right.)
T}
+_
\fB;\fP and \fB,address@hidden
Repeat the last f/F/t/T command in the same/opposite direction.
T}
+_
\fBC-e\fP and address@hidden
scroll the display up/down by one line
while preserving the cursor position.
T}
+_
\fBC-u\fP and address@hidden
scroll the display up/down by the specified amount of
lines while preserving the cursor position. (Default: half screen-full).
T}
+_
\fBC-b\fP and address@hidden the display up/down a full screen.
+_
.TE
.\"\fBf\fP,\fBt\fP, \fBF\fP, address@hidden
.\"move the cursor forward/backward to the next occurence of the target.
@@ -1827,22 +1903,34 @@ This is most useful for multiuser sessions.
The following keys can be used in displays list:
.PP
.TS
-allbox tab(@);
+tab(@);
l l.
+_
\fBk\fP, \fBC-p\fP, or address@hidden up one line.
+_
\fBj\fP, \fBC-n\fP, or address@hidden down one line.
+_
\fBC-a\fP or address@hidden to the first line.
+_
\fBC-e\fP or address@hidden to the last line.
+_
\fBC-u\fP or address@hidden one half page up or down.
+_
\fBC-b\fP or address@hidden one full page up or down.
+_
address@hidden
Move to the selected line. Available
when \*Qmousetrack\*U is set to on.
T}
+_
address@hidden the list
+_
address@hidden that display
+_
address@hidden detach that display
+_
\fBC-g\fP, \fBenter\fP, or address@hidden the list
+_
.TE
.PP
The following is an example of what \*Qdisplays\*U could look like:
@@ -3628,31 +3716,52 @@ and downwards.
The following keys are used to navigate in \*Qwindowlist\*U:
.TS
-allbox tab(@);
+tab(@);
l l.
+_
\fBk\fP, \fBC-p\fP, or address@hidden up one line.
+_
\fBj\fP, \fBC-n\fP, or address@hidden down one line.
+_
\fBC-g\fP or address@hidden windowlist.
+_
\fBC-a\fP or address@hidden to the first line.
+_
\fBC-e\fP or address@hidden to the last line.
+_
\fBC-u\fP or address@hidden one half page up or down.
+_
\fBC-b\fP or address@hidden one full page up or down.
+_
address@hidden the number keys, move to the selected line.
+_
address@hidden
Move to the selected line. Available when
\*Qmousetrack\*U is set to \*Qon\*U
T}
+_
\fB/address@hidden
+_
address@hidden search in the forward direction.
+_
address@hidden search in the backward direction.
+_
address@hidden MRU.
+_
address@hidden group nesting.
+_
address@hidden window view.
+_
\fBC-h\fP or address@hidden out the group.
+_
\fB,address@hidden numbers with the previous window.
+_
address@hidden numbers with the next window.
+_
address@hidden that window.
+_
\fBspace\fP or address@hidden that window.
+_
.TE
.sp 1
The table format can be changed with the \fBstring\fP and
commit d7cd3b8cac76060dff5593900ef91332969909a7
Author: Marcin Cieślak <address@hidden>
Date: Fri, 25 May 2018 21:48:14 +0200
URL: <http://repo.or.cz/screen/saper.git/d7cd3b8cac76060d>
manpage: explain flow control state indicators with a table
---
src/doc/screen.1 | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
diff --git a/src/doc/screen.1 b/src/doc/screen.1
index 9ae7e01ae03f..955c83ec26bc 100644
--- a/src/doc/screen.1
+++ b/src/doc/screen.1
@@ -2430,15 +2430,16 @@ the cursor position in the form \*Q(column,row)\*U
starting with \*Q(1,1)\*U,
the terminal width and height plus the size of the scrollback buffer in lines,
like in \*Q(80,24)+50\*U, the current state of window XON/XOFF flow control
is shown like this (See also section FLOW CONTROL):
-
-.nf
- +flow automatic flow control, currently on.
- \-flow automatic flow control, currently off.
- +(+)flow flow control enabled. Agrees with automatic control.
- \-(+)flow flow control disabled. Disagrees with automatic control.
- +(\-)flow flow control enabled. Disagrees with automatic control.
- \-(\-)flow flow control disabled. Agrees with automatic control.
-.fi
+.TS
+allbox tab(@);
+l l.
address@hidden flow control, currently on.
address@hidden flow control, currently off.
++(+)address@hidden control enabled. Agrees with automatic control.
+\-(+)address@hidden control disabled. Disagrees with automatic control.
++(\-)address@hidden control enabled. Disagrees with automatic control.
+\-(\-)address@hidden control disabled. Agrees with automatic control.
+.TE
The current line wrap setting (`+wrap' indicates enabled, `\-wrap' not) is
also shown. The flags `ins', `org', `app', `log', `mon' or `nored' are
commit a569564eeaaf994b29c5f03b813b21e9abfd562d
Author: Marcin Cieślak <address@hidden>
Date: Fri, 25 May 2018 21:51:20 +0200
URL: <http://repo.or.cz/screen/saper.git/a569564eeaaf994b>
manpage: keep nonblock and status parameters on the same line
---
src/doc/screen.1 | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/doc/screen.1 b/src/doc/screen.1
index 955c83ec26bc..4365ea801b9a 100644
--- a/src/doc/screen.1
+++ b/src/doc/screen.1
@@ -2859,7 +2859,7 @@ the default is \fBon\fP.
Switch to the next window.
This command can be used repeatedly to cycle through the list of windows.
.RE
-.TP
+.PP
.B nonblock
.RB [ on | off | \fInumsecs ]
.RS 0
@@ -3406,7 +3406,7 @@ to use system commands such as \*Qcat\*U or \*Qtail -f\*U.
Select whether you want to see the copyright notice during startup.
Default is `on', as you probably noticed.
.RE
-.TP
+.PP
.BR "status " [ top | up | down | bottom ]
.RB [ left | right ]
.RS 0
commit 199702c8416bce526ad0ffb2c95b755f2dda11b4
Author: Marcin Cieślak <address@hidden>
Date: Fri, 25 May 2018 21:52:49 +0200
URL: <http://repo.or.cz/screen/saper.git/199702c8416bce52>
manpage: Indent both examples for readreg
---
src/doc/screen.1 | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/doc/screen.1 b/src/doc/screen.1
index 4365ea801b9a..6536fcb5e403 100644
--- a/src/doc/screen.1
+++ b/src/doc/screen.1
@@ -3072,7 +3072,7 @@ window (using register p, where a copy remains):
.PP
.nf
C-a : readreg p /etc/passwd
-C-a : paste p
+ C-a : paste p
.fi
.RE
.TP
commit 5e8a9358087717c66fed1fb4cb2d48b48e317ad0
Author: Marcin Cieślak <address@hidden>
Date: Fri, 25 May 2018 22:01:21 +0200
URL: <http://repo.or.cz/screen/saper.git/5e8a9358087717c6>
manpage: Use monospaced font to render example of "displays"
---
src/doc/screen.1 | 2 ++
1 file changed, 2 insertions(+)
diff --git a/src/doc/screen.1 b/src/doc/screen.1
index 6536fcb5e403..5448adf3eab1 100644
--- a/src/doc/screen.1
+++ b/src/doc/screen.1
@@ -1936,10 +1936,12 @@ _
The following is an example of what \*Qdisplays\*U could look like:
.RS
.nf
+\fC
xterm 80x42 jnweiger@/dev/ttyp4 0(m11) &rWx
facit 80x24 mlschroe@/dev/ttyhf nb 11(tcsh) rwx
xterm 80x42 jnhollma@/dev/ttyp5 0(m11) &R.x
(A) (B) (C) (D) (E) (F)(G) (H)(I)
+\fR
.fi
.RE
.PP
commit 68878d0ffe6e75794f1eda5047f9cc47bf11d0c6
Author: Marcin Cieślak <address@hidden>
Date: Fri, 25 May 2018 22:48:25 +0200
URL: <http://repo.or.cz/screen/saper.git/68878d0ffe6e7579>
manpage: Explain window permissions in a table
---
src/doc/screen.1 | 35 +++++++++++++++++------------------
1 file changed, 17 insertions(+), 18 deletions(-)
diff --git a/src/doc/screen.1 b/src/doc/screen.1
index 5448adf3eab1..ec06e43df701 100644
--- a/src/doc/screen.1
+++ b/src/doc/screen.1
@@ -1964,24 +1964,23 @@ The available modes are "nb", "NB", "Z<", "Z>", and
"BL".
.IP
(H) Whether the window is shared
.IP
-(I) Window permissions. Made up of three characters:
-.PP
-.RS
-.nf
- (1st character)
- \fB\-\fR : no read
- \fBr\fR : read
- \fBR\fR : read only due to foreign wlock
- (2nd character)
- \fB\-\fR : no write
- \fB.\fR : write suppressed by foreign wlock
- \fBw\fR : write
- \fBW\fR : own wlock
- (3rd character)
- \fB\-\fR : no execute
- \fBx\fR : execute
-.fi
-.RE
+(I) Window permissions. Made up of three characters.
+.TS
+allbox tab(:);
+csssss
+cs cs cs
+l l l l l l.
+Window permissions indicators
+1st character:2nd character:3rd character
+\fB\-\fR:no read:\fB\-\fR:no write:\fB\-\fR:no execute
+\fBr\fR:read:\fBw\fR:write:\fBx\fR:execute
+::\fBW\fR:own wlock::
+.T&
+lsssss
+l l l l l l.
+Indicators of permissions suppressed by a foreign wlock
+\fBR\fR:read only:\fB.\fR:no write::
+.TE
.PP
.RS
\*Qdisplays\*U needs a region size of at least 10 characters wide and 5
characters high in
-----------------------------------------------------------------------
Summary of changes:
src/doc/screen.1 | 186 ++++++++++++++++++++++++++++++++++++++---------
1 file changed, 151 insertions(+), 35 deletions(-)
repo.or.cz automatic notification. Contact project admin address@hidden
if you want to unsubscribe, or site admin address@hidden if you receive
no reply.
--
screen/saper.git ("GNU Screen")
screen.pdf
Description: Adobe PDF document
smime.p7s
Description: S/MIME Cryptographic Signature
- [screen-devel] Improved table rendering for the manual page,
Marcin Cieslak <=