~ubuntu-branches/ubuntu/natty/iselect/natty

« back to all changes in this revision

Viewing changes to iselect.1

  • Committer: Bazaar Package Importer
  • Author(s): Denis Barbier
  • Date: 2001-12-17 00:02:42 UTC
  • Revision ID: james.westby@ubuntu.com-20011217000242-smpz9z44fopf4sm1
Tags: 1.2.0-5
* New maintainer (closes: Bug#119088).
* Prevent crash with empty input (closes: Bug#81159).
* Make /usr/share/doc/iselect/examples/scvs/scvs work with Term::ANSIColor
  instead of Term::Cap, and another fix was applied to deal with new
  versions of File::PathConvert (closes: Bug#98547).
* Add a keystroke to clear marks (closes: Bug#63156).
* Upgraded to standards version 3.5.6
* Remove Emacs crap from debian/changelog

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.rn '' }`
2
 
''' $RCSfile$$Revision$$Date$
3
 
'''
4
 
''' $Log$
5
 
'''
6
 
.de Sh
 
1
.\" Automatically generated by Pod::Man v1.3, Pod::Parser v1.13
 
2
.\"
 
3
.\" Standard preamble:
 
4
.\" ========================================================================
 
5
.de Sh \" Subsection heading
7
6
.br
8
7
.if t .Sp
9
8
.ne 5
11
10
\fB\\$1\fR
12
11
.PP
13
12
..
14
 
.de Sp
 
13
.de Sp \" Vertical space (when we can't use .PP)
15
14
.if t .sp .5v
16
15
.if n .sp
17
16
..
18
 
.de Ip
19
 
.br
20
 
.ie \\n(.$>=3 .ne \\$3
21
 
.el .ne 3
22
 
.IP "\\$1" \\$2
23
 
..
24
 
.de Vb
 
17
.de Vb \" Begin verbatim text
25
18
.ft CW
26
19
.nf
27
20
.ne \\$1
28
21
..
29
 
.de Ve
 
22
.de Ve \" End verbatim text
30
23
.ft R
31
24
 
32
25
.fi
33
26
..
34
 
'''
35
 
'''
36
 
'''     Set up \*(-- to give an unbreakable dash;
37
 
'''     string Tr holds user defined translation string.
38
 
'''     Bell System Logo is used as a dummy character.
39
 
'''
 
27
.\" Set up some character translations and predefined strings.  \*(-- will
 
28
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 
29
.\" double quote, and \*(R" will give a right double quote.  | will give a
 
30
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
 
31
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
 
32
.\" expand to `' in nroff, nothing in troff, for use with C<>.
40
33
.tr \(*W-|\(bv\*(Tr
 
34
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
41
35
.ie n \{\
42
 
.ds -- \(*W-
43
 
.ds PI pi
44
 
.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
45
 
.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
46
 
.ds L" ""
47
 
.ds R" ""
48
 
'''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
49
 
'''   \*(L" and \*(R", except that they are used on ".xx" lines,
50
 
'''   such as .IP and .SH, which do another additional levels of
51
 
'''   double-quote interpretation
52
 
.ds M" """
53
 
.ds S" """
54
 
.ds N" """""
55
 
.ds T" """""
56
 
.ds L' '
57
 
.ds R' '
58
 
.ds M' '
59
 
.ds S' '
60
 
.ds N' '
61
 
.ds T' '
 
36
.    ds -- \(*W-
 
37
.    ds PI pi
 
38
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 
39
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 
40
.    ds L" ""
 
41
.    ds R" ""
 
42
.    ds C` ""
 
43
.    ds C' ""
62
44
'br\}
63
45
.el\{\
64
 
.ds -- \(em\|
65
 
.tr \*(Tr
66
 
.ds L" ``
67
 
.ds R" ''
68
 
.ds M" ``
69
 
.ds S" ''
70
 
.ds N" ``
71
 
.ds T" ''
72
 
.ds L' `
73
 
.ds R' '
74
 
.ds M' `
75
 
.ds S' '
76
 
.ds N' `
77
 
.ds T' '
78
 
.ds PI \(*p
 
46
.    ds -- \|\(em\|
 
47
.    ds PI \(*p
 
48
.    ds L" ``
 
49
.    ds R" ''
79
50
'br\}
80
 
.\"     If the F register is turned on, we'll generate
81
 
.\"     index entries out stderr for the following things:
82
 
.\"             TH      Title 
83
 
.\"             SH      Header
84
 
.\"             Sh      Subsection 
85
 
.\"             Ip      Item
86
 
.\"             X<>     Xref  (embedded
87
 
.\"     Of course, you have to process the output yourself
88
 
.\"     in some meaninful fashion.
89
 
.if \nF \{
90
 
.de IX
91
 
.tm Index:\\$1\t\\n%\t"\\$2"
 
51
.\"
 
52
.\" If the F register is turned on, we'll generate index entries on stderr for
 
53
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 
54
.\" entries marked with X<> in POD.  Of course, you'll have to process the
 
55
.\" output yourself in some meaningful fashion.
 
56
.if \nF \{\
 
57
.    de IX
 
58
.    tm Index:\\$1\t\\n%\t"\\$2"
92
59
..
93
 
.nr % 0
94
 
.rr F
 
60
.    nr % 0
 
61
.    rr F
95
62
.\}
96
 
.TH ISELECT 1 "EN" "31/Mar/99" "Ralf S. Engelschall"
97
 
.UC
98
 
.if n .hy 0
 
63
.\"
 
64
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 
65
.\" way too many mistakes in technical documents.
 
66
.hy 0
99
67
.if n .na
100
 
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
101
 
.de CQ          \" put $1 in typewriter font
102
 
.ft CW
103
 
'if n "\c
104
 
'if t \\&\\$1\c
105
 
'if n \\&\\$1\c
106
 
'if n \&"
107
 
\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
108
 
'.ft R
109
 
..
110
 
.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
111
 
.       \" AM - accent mark definitions
112
 
.bd B 3
113
 
.       \" fudge factors for nroff and troff
114
 
.if n \{\
115
 
.       ds #H 0
116
 
.       ds #V .8m
117
 
.       ds #F .3m
118
 
.       ds #[ \f1
119
 
.       ds #] \fP
120
 
.\}
121
 
.if t \{\
122
 
.       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
123
 
.       ds #V .6m
124
 
.       ds #F 0
125
 
.       ds #[ \&
126
 
.       ds #] \&
127
 
.\}
128
 
.       \" simple accents for nroff and troff
129
 
.if n \{\
130
 
.       ds ' \&
131
 
.       ds ` \&
132
 
.       ds ^ \&
133
 
.       ds , \&
134
 
.       ds ~ ~
135
 
.       ds ? ?
136
 
.       ds ! !
137
 
.       ds /
138
 
.       ds q
139
 
.\}
140
 
.if t \{\
141
 
.       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
142
 
.       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
143
 
.       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
144
 
.       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
145
 
.       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
146
 
.       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
147
 
.       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
148
 
.       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
149
 
.       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
150
 
.\}
151
 
.       \" troff and (daisy-wheel) nroff accents
 
68
.\"
 
69
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 
70
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 
71
.    \" fudge factors for nroff and troff
 
72
.if n \{\
 
73
.    ds #H 0
 
74
.    ds #V .8m
 
75
.    ds #F .3m
 
76
.    ds #[ \f1
 
77
.    ds #] \fP
 
78
.\}
 
79
.if t \{\
 
80
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 
81
.    ds #V .6m
 
82
.    ds #F 0
 
83
.    ds #[ \&
 
84
.    ds #] \&
 
85
.\}
 
86
.    \" simple accents for nroff and troff
 
87
.if n \{\
 
88
.    ds ' \&
 
89
.    ds ` \&
 
90
.    ds ^ \&
 
91
.    ds , \&
 
92
.    ds ~ ~
 
93
.    ds /
 
94
.\}
 
95
.if t \{\
 
96
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 
97
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 
98
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 
99
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 
100
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 
101
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 
102
.\}
 
103
.    \" troff and (daisy-wheel) nroff accents
152
104
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
153
105
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
154
 
.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
155
 
.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
156
 
.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
157
 
.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
158
106
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
159
107
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
160
108
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
162
110
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
163
111
.ds ae a\h'-(\w'a'u*4/10)'e
164
112
.ds Ae A\h'-(\w'A'u*4/10)'E
165
 
.ds oe o\h'-(\w'o'u*4/10)'e
166
 
.ds Oe O\h'-(\w'O'u*4/10)'E
167
 
.       \" corrections for vroff
 
113
.    \" corrections for vroff
168
114
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
169
115
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
170
 
.       \" for low resolution devices (crt and lpr)
 
116
.    \" for low resolution devices (crt and lpr)
171
117
.if \n(.H>23 .if \n(.V>19 \
172
118
\{\
173
 
.       ds : e
174
 
.       ds 8 ss
175
 
.       ds v \h'-1'\o'\(aa\(ga'
176
 
.       ds _ \h'-1'^
177
 
.       ds . \h'-1'.
178
 
.       ds 3 3
179
 
.       ds o a
180
 
.       ds d- d\h'-1'\(ga
181
 
.       ds D- D\h'-1'\(hy
182
 
.       ds th \o'bp'
183
 
.       ds Th \o'LP'
184
 
.       ds ae ae
185
 
.       ds Ae AE
186
 
.       ds oe oe
187
 
.       ds Oe OE
 
119
.    ds : e
 
120
.    ds 8 ss
 
121
.    ds o a
 
122
.    ds d- d\h'-1'\(ga
 
123
.    ds D- D\h'-1'\(hy
 
124
.    ds th \o'bp'
 
125
.    ds Th \o'LP'
 
126
.    ds ae ae
 
127
.    ds Ae AE
188
128
.\}
189
129
.rm #[ #] #H #V #F C
 
130
.\" ========================================================================
 
131
.\"
 
132
.IX Title "ISELECT 1"
 
133
.TH ISELECT 1 "2001-12-17" "EN" "Ralf S. Engelschall"
 
134
.UC
190
135
.SH "NAME"
191
 
iSelect -- Interactive Selection Tool
 
136
iSelect \*(-- Interactive Selection Tool
192
137
.SH "SYNOPSIS"
193
 
\fBiselect\fR
194
 
[\fB\-d\fR \fISTR\fR,\fISTR\fR]
 
138
.IX Header "SYNOPSIS"
 
139
\&\fBiselect\fR
 
140
[\fB\-d\fR \fI\s-1STR\s0\fR,\fI\s-1STR\s0\fR]
195
141
[\fB\-c\fR]
196
142
[\fB\-f\fR]
197
143
[\fB\-a\fR]
198
144
[\fB\-e\fR]
199
 
[\fB\-p\fR \fINUM\fR]
200
 
[\fB\-k\fR \fIKEY\fR[:\fIOKEY\fR]]
 
145
[\fB\-p\fR \fI\s-1NUM\s0\fR]
 
146
[\fB\-k\fR \fI\s-1KEY\s0\fR[:\fI\s-1OKEY\s0\fR]]
201
147
[\fB\-m\fR]
202
 
[\fB\-n\fR \fISTR\fR]
203
 
[\fB\-t\fR \fISTR\fR]
 
148
[\fB\-n\fR \fI\s-1STR\s0\fR]
 
149
[\fB\-t\fR \fI\s-1STR\s0\fR]
204
150
[\fB\-S\fR]
205
151
[\fB\-K\fR]
206
152
[\fB\-P\fR]
207
 
[\fB\-Q\fR \fISTR\fR]
 
153
[\fB\-Q\fR \fI\s-1STR\s0\fR]
208
154
[\fIline1\fR \fIline2\fR ...]
209
155
.PP
210
 
\fBiselect\fR
 
156
\&\fBiselect\fR
211
157
[\fB\-V\fR]
212
158
.SH "VERSION"
213
 
1.2.0 (31-Mar-1999)
 
159
.IX Header "VERSION"
 
160
1.2.0 (31\-Mar\-1999)
214
161
.SH "DESCRIPTION"
 
162
.IX Header "DESCRIPTION"
215
163
.Sh "Intend"
 
164
.IX Subsection "Intend"
216
165
iSelect is an interactive line selection tool for \s-1ASCII\s0 files, operating via a
217
166
full-screen Curses-based terminal session. It can be used either as an user
218
 
interface frontend controlled by a Bourne-Shell, Perl or other type of script
 
167
interface frontend controlled by a Bourne\-Shell, Perl or other type of script
219
168
backend as its wrapper or in batch as a pipe filter (usually between \fIgrep\fR
220
169
and the final executing command). In other words: iSelect was designed to be
221
170
used for any types of interactice line-based selections.
222
171
.Sh "Input Data"
 
172
.IX Subsection "Input Data"
223
173
Input is read either from the command line (\fIline1\fR \fIline2\fR ...) where each
224
174
argument corresponds to one buffer line or from \fIstdin\fR (when no arguments
225
175
are given) where the buffer lines are determined according to the newline
227
177
.PP
228
178
You can additionally let substrings displayed in Bold mode for non-selectable
229
179
lines (because the selectable lines are always displayed bold) by using the
230
 
construct ``\f(CW<b>\fR...\f(CW</b>\fR'\*(R' as in \s-1HTML\s0.
 
180
construct ``\f(CW\*(C`<b>\*(C'\fR...\f(CW\*(C`</b>\*(C'\fR'' as in \s-1HTML\s0.
231
181
.Sh "Selections"
 
182
.IX Subsection "Selections"
232
183
The selection is either just a single line (default) or multiple lines (option
233
 
\fB\-m\fR). Per default no lines are selectable. If a line contains the string
234
 
``\f(CW<s>\fR'\*(R' (or a string with different delimiters configured via
 
184
\&\fB\-m\fR). Per default no lines are selectable. If a line contains the string
 
185
``\f(CW\*(C`<s>\*(C'\fR'' (or a string with different delimiters configured via
235
186
option \fB\-d\fR) at any position this string is stripped and the line is
236
187
selectable. Its result (printed to \fIstdout\fR) is the line contents itself (but
237
 
without the ``\f(CW<s>\fR'\*(R' string of course). If option \fB\-a\fR is used all
 
188
without the ``\f(CW\*(C`<s>\*(C'\fR'' string of course). If option \fB\-a\fR is used all
238
189
lines are selectable and their result is again the line itself, i.e. using
239
 
option \fB\-a\fR is the same as adding ``\f(CW<s>\fR'\*(R' to every line of the
 
190
option \fB\-a\fR is the same as adding ``\f(CW\*(C`<s>\*(C'\fR'' to every line of the
240
191
input data.  When you want a specific result (i.e. not just the line contents
241
 
itself), you have to use the special variant ``\f(CW<s:result text>\fR'\*(R'
242
 
which results in the output ``\f(CWresult text\fR'\*(R' when the corresponding line is
 
192
itself), you have to use the special variant ``\f(CW\*(C`<s:result text>\*(C'\fR''
 
193
which results in the output ``\f(CW\*(C`result text\*(C'\fR'' when the corresponding line is
243
194
selected.
244
195
.PP
245
 
When you use a specific result via ``\f(CW<s:result text>\fR'\*(R' the \fIresult
246
 
text\fR can contain ``\f(CW%s[query text]s\fR'\*(R' and ``\f(CW%s[query text]S\fR'\*(R'
 
196
When you use a specific result via ``\f(CW\*(C`<s:result text>\*(C'\fR'' the \fIresult
 
197
text\fR can contain ``\f(CW\*(C`%s[query text]s\*(C'\fR'' and ``\f(CW\*(C`%s[query text]S\*(C'\fR''
247
198
constructs. For every such construct an interactive query is done and the
248
 
result replaces the construct.  The ``\f(CW%s[query text]S\fR'\*(R' construct is like
249
 
``\f(CW%s[query text]s\fR'\*(R' except that the empty string as the query result is not
 
199
result replaces the construct.  The ``\f(CW\*(C`%s[query text]S\*(C'\fR'' construct is like
 
200
``\f(CW\*(C`%s[query text]s\*(C'\fR'' except that the empty string as the query result is not
250
201
accepted on input.
251
202
.PP
252
203
The Curses-based full-screen selection is always done via \fI/dev/tty\fR, because
253
204
the \fIstdin\fR and \fIstdout\fR filehandles are usually tied to the input and
254
205
output data streams.
255
206
.Sh "Output Data"
256
 
The output is the line itself or the string given with ``\f(CW<s:result
257
 
text>\fR'\*(R'.  When multiple line selection mode (option \fB\-m\fR) is used the
 
207
.IX Subsection "Output Data"
 
208
The output is the line itself or the string given with ``\f(CW\*(C`<s:result
 
209
text>\*(C'\fR''.  When multiple line selection mode (option \fB\-m\fR) is used the
258
210
output is all selected lines theirself or their configured result strings.
259
211
Output always is written to \fIstdout\fR.
260
212
.SH "OPTIONS"
 
213
.IX Header "OPTIONS"
261
214
.Sh "Input Options"
 
215
.IX Subsection "Input Options"
262
216
These options control how \fIiSelect\fR parses its input.
263
 
.Ip "\fB\-d\fR \fI\s-1STR\s0\fR, \fB--delimiter=\fR\fI\s-1STR\s0\fR" 4
264
 
Sets the delimiters for the selection tags. The default is `\f(CW<,>\fR\*(R',
265
 
i.e. the selection tags have to read ``\f(CW<s>\fR'\*(R' and ``\f(CW<s:result
266
 
text>\fR'\*(R'
267
 
.Ip "\fB\-c\fR, \fB--strip-comments\fR" 4
 
217
.IP "\fB\-d\fR \fI\s-1STR\s0\fR, \fB\-\-delimiter=\fR\fI\s-1STR\s0\fR" 4
 
218
.IX Item "-d STR, --delimiter=STR"
 
219
Sets the delimiters for the selection tags. The default is `\f(CW\*(C`<,>\*(C'\fR',
 
220
i.e. the selection tags have to read ``\f(CW\*(C`<s>\*(C'\fR'' and ``\f(CW\*(C`<s:result
 
221
text>\*(C'\fR''
 
222
.IP "\fB\-c\fR, \fB\-\-strip\-comments\fR" 4
 
223
.IX Item "-c, --strip-comments"
268
224
Strips all sharp comment lines from the input buffer before parsing.
269
 
.Ip "\fB\-f\fR, \fB--force-browse\fR" 4
 
225
.IP "\fB\-f\fR, \fB\-\-force\-browse\fR" 4
 
226
.IX Item "-f, --force-browse"
270
227
Browse always, i.e. even when the input buffer contains no or only one line.
271
 
.Ip "\fB\-a\fR, \fB--all-select\fR" 4
 
228
.IP "\fB\-a\fR, \fB\-\-all\-select\fR" 4
 
229
.IX Item "-a, --all-select"
272
230
Force all lines to be selectable.
273
 
.Ip "\fB\-e\fR, \fB--exit-no-select\fR" 4
 
231
.IP "\fB\-e\fR, \fB\-\-exit\-no\-select\fR" 4
 
232
.IX Item "-e, --exit-no-select"
274
233
Exit immediately if no lines are selectable. In this case not even the Curses
275
234
screen is initialized.
276
235
.Sh "Display Options"
277
 
.Ip "\fB\-p\fR \fI\s-1NUM\s0\fR, \fB--position=\fR\fI\s-1NUM\s0\fR" 4
 
236
.IX Subsection "Display Options"
 
237
.IP "\fB\-p\fR \fI\s-1NUM\s0\fR, \fB\-\-position=\fR\fI\s-1NUM\s0\fR" 4
 
238
.IX Item "-p NUM, --position=NUM"
278
239
Sets the cursor position to line \fI\s-1NUM\s0\fR.
279
 
.Ip "\fB\-k\fR \fI\s-1KEY\s0\fR[:\fI\s-1OKEY\s0\fR], \fB--key=\fR\fI\s-1KEY\s0[:\fI\s-1OKEY\s0\fR]\fR" 4
280
 
Defines an additional input key. Per default \fI\s-1OKEY\s0\fR is \f(CWRETURN\fR, i.e.  for
281
 
instance \fB\-kf\fR defines another selection key `\f(CWf\fR\*(R'.
282
 
.Ip "\fB\-m\fR, \fB--multi-line\fR" 4
 
240
.IP "\fB\-k\fR \fI\s-1KEY\s0\fR[:\fI\s-1OKEY\s0\fR], \fB\-\-key=\fR\fIKEY[:\fI\s-1OKEY\s0\fI]\fR" 4
 
241
.IX Item "-k KEY[:OKEY], --key=KEY[:OKEY]"
 
242
Defines an additional input key. Per default \fI\s-1OKEY\s0\fR is \f(CW\*(C`RETURN\*(C'\fR, i.e.  for
 
243
instance \fB\-kf\fR defines another selection key `\f(CW\*(C`f\*(C'\fR'.
 
244
.IP "\fB\-m\fR, \fB\-\-multi\-line\fR" 4
 
245
.IX Item "-m, --multi-line"
283
246
Enable multi-line selection where you can select more then one line via \s-1SPACE\s0
284
247
key.
285
 
.Ip "\fB\-n\fR \fI\s-1STR\s0\fR, \fB--name=\fR\fI\s-1STR\s0\fR" 4
 
248
.IP "\fB\-n\fR \fI\s-1STR\s0\fR, \fB\-\-name=\fR\fI\s-1STR\s0\fR" 4
 
249
.IX Item "-n STR, --name=STR"
286
250
Sets the name string, displayed flush left at the bottom of the
287
251
browser window.
288
 
.Ip "\fB\-t\fR \fI\s-1STR\s0\fR, \fB--title=\fR\fI\s-1STR\s0\fR" 4
 
252
.IP "\fB\-t\fR \fI\s-1STR\s0\fR, \fB\-\-title=\fR\fI\s-1STR\s0\fR" 4
 
253
.IX Item "-t STR, --title=STR"
289
254
Sets the title bar string, displayed centered at the bottom of the
290
255
browser window.
291
256
.Sh "Output Options"
292
 
.Ip "\fB\-S\fR, \fB--strip-result\fR" 4
 
257
.IX Subsection "Output Options"
 
258
.IP "\fB\-S\fR, \fB\-\-strip\-result\fR" 4
 
259
.IX Item "-S, --strip-result"
293
260
Strip all leading and trailing whitespaces from the result string.
294
 
.Ip "\fB\-K\fR, \fB--key-result\fR" 4
 
261
.IP "\fB\-K\fR, \fB\-\-key\-result\fR" 4
 
262
.IX Item "-K, --key-result"
295
263
Prefix the result string (given on \fIstdout\fR) with the corresponding selection
296
 
key which was used. This usually is \f(CWRETURN\fR or \f(CWKEY_RIGHT\fR but can be any
 
264
key which was used. This usually is \f(CW\*(C`RETURN\*(C'\fR or \f(CW\*(C`KEY_RIGHT\*(C'\fR but can be any
297
265
of the additional keys defined by option \fB\-k\fR.  When you use \fB\-kf\fR and
298
 
select a line \f(CWFoo Bar\fR with key `\f(CWf\fR\*(R' the result string is ``\f(CWf:Foo
299
 
Bar\fR'\*(R'.
300
 
.Ip "\fB\-P\fR, \fB--position-result\fR" 4
 
266
select a line \f(CW\*(C`Foo Bar\*(C'\fR with key `\f(CW\*(C`f\*(C'\fR' the result string is ``\f(CW\*(C`f:Foo
 
267
Bar\*(C'\fR''.
 
268
.IP "\fB\-P\fR, \fB\-\-position\-result\fR" 4
 
269
.IX Item "-P, --position-result"
301
270
Prefix the result string (given on \fIstdout\fR) with the corresponding cursor
302
271
position followed by a colon. When you selected line \fIN\fR and this line has
303
 
the result \f(CWFoo Bar\fR configured the result string is ``\f(CWN:Foo Bar\fR'\*(R'.
304
 
.Ip "\fB\-Q\fR \fI\s-1STR\s0\fR, \fB--quit-result=\fR\fI\s-1STR\s0\fR" 4
 
272
the result \f(CW\*(C`Foo Bar\*(C'\fR configured the result string is ``\f(CW\*(C`N:Foo Bar\*(C'\fR''.
 
273
.IP "\fB\-Q\fR \fI\s-1STR\s0\fR, \fB\-\-quit\-result=\fR\fI\s-1STR\s0\fR" 4
 
274
.IX Item "-Q STR, --quit-result=STR"
305
275
Sets the result string on quit. Default is the empty string.
306
276
.Sh "Giving Feedback"
307
 
.Ip "\fB\-V\fR, \fB--version\fR" 4
 
277
.IX Subsection "Giving Feedback"
 
278
.IP "\fB\-V\fR, \fB\-\-version\fR" 4
 
279
.IX Item "-V, --version"
308
280
Displays version identification string.
309
281
.SH "KEYSTROKES"
 
282
.IX Header "KEYSTROKES"
310
283
.Sh "Cursor Movement"
 
284
.IX Subsection "Cursor Movement"
311
285
Use these to browse through the selection list.
312
286
.PP
313
287
.Vb 6
319
293
\&  G ............. Goto last line
320
294
.Ve
321
295
.Sh "Line Selection"
 
296
.IX Subsection "Line Selection"
322
297
Use these to select one line and exit in standard mode or one or more lines in
323
298
multi-line mode.
324
299
.PP
325
 
.Vb 3
 
300
.Vb 4
326
301
\&  RETURN ........ Select line and exit
327
302
\&  CURSOR-RIGHT .. Select line and exit
328
303
\&  SPACE ......... Select line and stay (multi-line mode only)
 
304
\&  C ............. Clear current marks (multi-line mode only)
329
305
.Ve
 
306
Note: the \f(CW\*(C`C\*(C'\fR keystroke is a Debian extension to iSelect 1.2.0, which
 
307
has been reported to Ralf S. Engelschall.
330
308
.Sh "Others"
 
309
.IX Subsection "Others"
331
310
Use these to quit iSelect or to show its help and
332
311
version page.
333
312
.PP
338
317
\&  v ............. Version Page
339
318
.Ve
340
319
.SH "EXAMPLE"
 
320
.IX Header "EXAMPLE"
341
321
As an example we present a real-life situation where iSelect can enhance an
342
322
existing functionality. We define two Bash functions (for your
343
 
\fI$HOME/.bashrc\fR file) which enhance the built-in `\fIcd\fR\*(R' command of the
 
323
\&\fI$HOME/.bashrc\fR file) which enhance the built-in `\fIcd\fR' command of the
344
324
shell.
345
325
.PP
346
326
.Vb 7
365
345
\&     PS1="\eu@\eh:$PWD\en:> "
366
346
\& }
367
347
.Ve
368
 
This new `\fIcd\fR\*(R' command is compatible with Bashs built-in variant for the case
 
348
This new `\fIcd\fR' command is compatible with Bashs built-in variant for the case
369
349
where the specified directory actually exists. When it doesn't, the original
370
 
`\fIcd\fR\*(R' would immediately give an error (assuming we have no \fICDPATH\fR
 
350
`\fIcd\fR' would immediately give an error (assuming we have no \fI\s-1CDPATH\s0\fR
371
351
variable defined).  Here this enhanced version tries harder. First it searches
372
352
for such a directory in a previously built (via \fIcds\fR) \fI$HOME/.cdpaths\fR
373
353
files. When no line was found, iSelect just returns the given directory as the
374
 
default result and `\fIcd\fR\*(R' then fails as usual with an error message. When
 
354
default result and `\fIcd\fR' then fails as usual with an error message. When
375
355
only one directory was found, iSelect directly results this particular line to
376
 
`\fIcd\fR\*(R'. And only when more then one directory was found, iSelect opens its
 
356
`\fIcd\fR'. And only when more then one directory was found, iSelect opens its
377
357
Curses-based selection screen and lets the user choose interactively between
378
 
those directories. The chosen directory is then finally given to `\fIcd\fR\*(R'.
 
358
those directories. The chosen directory is then finally given to `\fIcd\fR'.
379
359
.PP
380
360
For more useful examples on how to use iSelect, see the \fIcontrib/\fR directory
381
361
of the iSelect distribution tarball.
382
362
.SH "AUTHOR"
383
 
.PP
 
363
.IX Header "AUTHOR"
384
364
.Vb 3
385
365
\&  Ralf S. Engelschall
386
366
\&  rse@engelschall.com
387
367
\&  www.engelschall.com
388
368
.Ve
389
369
.SH "SEE ALSO"
390
 
.PP
 
370
.IX Header "SEE ALSO"
391
371
.Vb 1
392
372
\&  iSelect Home: http://www.engelschall.com/sw/iselect/
393
373
.Ve
394
 
 
395
 
.rn }` ''
396
 
.IX Title "ISELECT 1"
397
 
.IX Name "iSelect - Interactive Selection Tool"
398
 
 
399
 
.IX Header "NAME"
400
 
 
401
 
.IX Header "SYNOPSIS"
402
 
 
403
 
.IX Header "VERSION"
404
 
 
405
 
.IX Header "DESCRIPTION"
406
 
 
407
 
.IX Subsection "Intend"
408
 
 
409
 
.IX Subsection "Input Data"
410
 
 
411
 
.IX Subsection "Selections"
412
 
 
413
 
.IX Subsection "Output Data"
414
 
 
415
 
.IX Header "OPTIONS"
416
 
 
417
 
.IX Subsection "Input Options"
418
 
 
419
 
.IX Item "\fB\-d\fR \fI\s-1STR\s0\fR, \fB--delimiter=\fR\fI\s-1STR\s0\fR"
420
 
 
421
 
.IX Item "\fB\-c\fR, \fB--strip-comments\fR"
422
 
 
423
 
.IX Item "\fB\-f\fR, \fB--force-browse\fR"
424
 
 
425
 
.IX Item "\fB\-a\fR, \fB--all-select\fR"
426
 
 
427
 
.IX Item "\fB\-e\fR, \fB--exit-no-select\fR"
428
 
 
429
 
.IX Subsection "Display Options"
430
 
 
431
 
.IX Item "\fB\-p\fR \fI\s-1NUM\s0\fR, \fB--position=\fR\fI\s-1NUM\s0\fR"
432
 
 
433
 
.IX Item "\fB\-k\fR \fI\s-1KEY\s0\fR[:\fI\s-1OKEY\s0\fR], \fB--key=\fR\fI\s-1KEY\s0[:\fI\s-1OKEY\s0\fR]\fR"
434
 
 
435
 
.IX Item "\fB\-m\fR, \fB--multi-line\fR"
436
 
 
437
 
.IX Item "\fB\-n\fR \fI\s-1STR\s0\fR, \fB--name=\fR\fI\s-1STR\s0\fR"
438
 
 
439
 
.IX Item "\fB\-t\fR \fI\s-1STR\s0\fR, \fB--title=\fR\fI\s-1STR\s0\fR"
440
 
 
441
 
.IX Subsection "Output Options"
442
 
 
443
 
.IX Item "\fB\-S\fR, \fB--strip-result\fR"
444
 
 
445
 
.IX Item "\fB\-K\fR, \fB--key-result\fR"
446
 
 
447
 
.IX Item "\fB\-P\fR, \fB--position-result\fR"
448
 
 
449
 
.IX Item "\fB\-Q\fR \fI\s-1STR\s0\fR, \fB--quit-result=\fR\fI\s-1STR\s0\fR"
450
 
 
451
 
.IX Subsection "Giving Feedback"
452
 
 
453
 
.IX Item "\fB\-V\fR, \fB--version\fR"
454
 
 
455
 
.IX Header "KEYSTROKES"
456
 
 
457
 
.IX Subsection "Cursor Movement"
458
 
 
459
 
.IX Subsection "Line Selection"
460
 
 
461
 
.IX Subsection "Others"
462
 
 
463
 
.IX Header "EXAMPLE"
464
 
 
465
 
.IX Header "AUTHOR"
466
 
 
467
 
.IX Header "SEE ALSO"
468