-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpwb.1
81 lines (79 loc) · 1.85 KB
/
pwb.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
.TH pwb 1 2024-02-12
.mso gproto.tmac
.nr include_flag 1
.so fork.tmac
.so pwb.1.d/prototypes.1
.SH NAME
.B pwb
\- pager with benefits: scrolling line-content manager
.so pwb.1.d/description.1
.so pwb.1.d/synopsis.1
.so pwb.1.d/print_func.1
.so pwb.1.d/exec_func.1
.so pwb.1.d/pwb_actions.1
.SH KEYMAP
.PP
There is a default keymap that recognizes and responds appropriately
to up- and down-arrow, page-up and -down, and home and end keys
presses.
This keymap can be replaced or supplemented with custom keymaps.
The navigation responses are indicated by index values as follows:
.TS
tab(|);
l l.
0|exit
1|down one line
2|up one line
3|down one page
4|up one page
5|bottom of document
6|top of document
7|execute
.TE
.PP
A keymap will be defined by an array of values consisting of keystroke
strings followed by an integer from the above list.
This is the default keymap:
.TS
tab(|);
l l l.
\(dq\q\(dq|0|# 'q' key
\(Do\(aq\(rseOB\(aq|1|# down-arrow key
\(Do\(aq\(rseOA\(aq|2|# up-arrow key
\(Do\(aq\(rse[6~\(aq|3|# page down key
\(Do\(aq\(rse[5~\(aq|4|# page up key
\(Do\(aq\(rseOF\(aq|5|# end key
\(Do\(aq\(rseOH\(aq|6|# home key
\(Do\(aq\(rscm\(aq|7|# control-m (ENTER key)
.TE
.TP
.B HINT
Control keys often emit unintuitive keystroke strings.
Use the
.B showkey -a
command to see the keystroke string of any typed key.
.SH PRINTER CALLBACK FUNCTION
.PP
The command will repeatedly a script-provided printer function to
print each line.
The print function will receive the following arguments:
.TS
tab(|);
l l l.
\(Do1|data row number|integer
\(Do2|data source name|string
\(Do3|char limit|integer
\(Do4|in focus|integer (0 not focus)
\(Do5|pwb handle name|string
\(Do6|extra data name|string
.TE
.SH EXECUTOR CALLBACK FUNCTION
.TS
tab(|);
l l l.
\(Do1|keystroke|string
\(Do2|data row number|integer
\(Do3|data source name|string
\(Do4|pwb handle name|string
\(Do5|extra data name|string
.TE