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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
VH(1) VH(1)
NNAAMMEE
vh - volks-hypertext browser for the Jargon File
SSYYNNOOPPSSIISS
jjaarrggoonn [-cfgimrs] [-b key]
vvhh [-cfgimrs] [-b key] [document]
DDEESSCCRRIIPPTTIIOONN
This program is a handy hypertext browser, originally
written for the Jargon File but convenient for use with
text files marked up in the simple format documented
below. It allows you to page forward and back through a
document, and supports reference chasing so that you can
easily follow chains of "See" and "See also" pointers
through the text.
Normal usage is simply to type the name of your document
to the shell. Thus, `jargon' browses the Jargon File.
Interactive help explaining the keyboard commands is
available from the screen. If the program sees a mouse, a
fairly complete `point-and-shoot' interface is also avail-
able. Color will be used if it is available, but may be
suppressed with the -m option. If you are using this pro-
gram under DOS and your CGA develops snow when the video
RAM is written directly, use -s.
It is useful to know that there are two modes; one browses
the text file, the other the entry index (if you chase a
selection in the entry index you are popped to text mode
at the corresponding entry).
MMOOUUSSEE UUSSAAGGEE
The following section applies only to systems with
attached and active mice. If you are using a Mac or some
other system with a deficient mouse, the single mouse but-
ton is treated as a `left' button.
You will notice a scrollbar on the right edge of the
screen. One of the characters of the scrollbar is differ-
ent from the rest. This is called the `thumb' or `scroll
box'. As you move through the file, this gives you an
approximate indication of where you are in the file. If
the thumb is one-third of the way down the screen, you are
about one-third of the way through the file. It works in
both the text and index files.
If you have a mouse, you can click the left button
directly on a reference on the screen and jump to it. You
can also scroll or page forward or backward by clicking on
the scrollbar. There are up and down arrows above and
below the scroll bar for scrolling line by line. Clicking
on the scrollbar below the thumb will page forward, and
clicking above it will page back. You can also "drag" the
thumb by clicking on it and holding, then moving up or
UNIX 10 May 1993 1
VH(1) VH(1)
down before releasing. This allows you to jump quickly
through the file. Holding the mouse down on the arrows or
above or below the thumb will cause the scrolling or pag-
ing action to repeat until you release the button. This
is one of only two places where holding the button has any
special effect (the other is described below).
Clicking the right button will cause the program to back-
track the same way as the Esc or Backspace keys.
You may also click the left button on the function key
prompts on the bottom line to get the same effect as
pressing the function keys themselves. The ^Q (Help)
entry is special; if you click it with the mouse, it will
come up, but disappear when you let go of the mouse but-
ton. This is a feature, not a bug; if you want help to
hang out till you tell it to go away, type control-Q.
In the text file only, if you click on the main screen
(i.e. not on the scrollbar or the prompt line) outside of
a reference in curly braces, the program will page forward
one screen.
OOTTHHEERR OOPPTTIIOONNSS
The -i option enables an incremental-lookup feature (but
note that this feature may not be available in all ports).
In this mode, lookup and string search both behave like an
Emacs incremental search. That is, after you type each
letter of a key, your viewpoint moves forward to the next
key (if any) containing the substring you've already
typed. If there is no such key, the browser beeps and
drops out of incremental-lookup mode. String search works
similarly, behaving almost exactly like an Emacs ^S. As a
reminder that you're in these incremental modes, high-
lights do not light up on the screens you pass through;
when you want to leave the mode, press enter and the cur-
rent page's highlights will light up.
The -b option runs vh in batch mode to retrieve the entry
corresponding to a particular given key. The entry, if
any, is written to standard output.
The -f (filter) option accepts a list of entry headwords
on stdin and sends those entries to stdout.
Finally, the -r option picks an entry at random and sends
it to standard output. This may be useful for `fortune
cookie' applications.
IINNDDEEXX GGEENNEERRAATTIIOONN
Two data files, the default text and index for the Jargon
File, should live in /usr/local/lib/vh. To generate an
index from a new version, cd to this library directory.
Copy or move the textfile to /usr/local/lib/vh/jargon.txt
UNIX 10 May 1993 2
VH(1) VH(1)
and run the command jjaarrggoonn --gg..
For experimental purposes, it is possible to override the
default document name with a command-line argument. Thus,
assuming a file eexxaammppllee..tteexx is in proper format, you may
generate an index for _e_x_a_m_p_l_e_._t_x_t with vvhh --gg eexxaammppllee and
browse it with vvhh eexxaammppllee
When you have the `example' database ready for public use,
simply link or copy vh to the name `example'. If no argu-
ments are given, this program tries to browse a database
with the name it was invoked under.
The -c mode does some format and consistency checks on a
text/index pair. Use this if it looks as though your
lookups are landing in the wrong places; it will let you
know if your index is out of date.
TTEEXXTT FFIILLEE FFOORRMMAATT
`Proper format' means:
1. References are surrounded by {} or {{}}.
If the first character of the text file is not a `=', the
code also assumes:
2. Reference text may not begin with whitespace, single-
or double-quote, nor
end with a semicolon.
3. Reference targets begin with a `:' at the left margin
and are bounded on the right by another `:' (an optional
second `:' may follow that).
These rules are useful for filtering out false hits from
the index.
FFIILLEESS
A copy of vh called `foo' would require the following:
_/_u_s_r_/_l_o_c_a_l_/_l_i_b_/_v_h_/_f_o_o_._t_x_t Text of your document.
_/_u_s_r_/_l_o_c_a_l_/_l_i_b_/_v_h_/_f_o_o_._i_d_x Index of your document.
_._/_f_o_o_._c_u_t Where entries selected
by the ^Y (Print) com-
mand are appended to.
EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS
_V_H_P_A_T_H Search path for vh documents.
Defaults to "/usr/local/lib/vh".
BBUUGGSS
If a selection wraps around the right margin, only a mouse
UNIX 10 May 1993 3
VH(1) VH(1)
click on the part before the line wrap will chase it;
clicks on the portion trailing into the next line simply
cause a page forward. This glitch was judged more trouble
to fix than it's worth.
Use of the ESC key inhibits refresh under some curses(3)
versions; thus, you might have to do a ^L to force screen
update afterwards. Crocking around this in the obvious
way would introduce screen flicker for everybody. Use BS.
Because BSD UNIX's pseudorandom-number generator isn't
very good, the fortune-cookie mode under that UNIX isn't
either.
Output from a -f list may include alphabetical section
headers which are not, strictly speaking, part of the
desired text.
AAUUTTHHOORRSS
Concept, DOS support, and database code from the MS-DOS
`jargon' program by Raymond D. Gardner <FidoNet
1:104/89.2>; new features, docs, and curses(3)-using UNIX
code by Eric S. Raymond <esr@snark.thyrsus.com>. See
http://www.ccil.org/~esr/home.html for updates and related
resources.
SSEEEE AALLSSOO
_T_h_e _N_e_w _H_a_c_k_e_r_'_s _D_i_c_t_i_o_n_a_r_y _(_S_e_c_o_n_d _E_d_i_t_i_o_n_)_, by Eric S.
Raymond (ed.), MIT Press 1993, ISBN 0-262-68079-3. The
Jargon File (version 3.0.0), nicely typeset and bound with
additional front matter.
The Jargon File can be obtained by FTP from various
archive sites. A copy lives more or less permanently as
_p_u_b_/_j_a_r_g_o_n_?_?_?_?_?_._t_x_t at _p_r_e_p_._a_i_._m_i_t_._e_d_u (18.71.0.38), where
`?????' is replaced by the current version number. Future
updates will be made available there.
Please email your Jargon File entries and corrections to
jargon@snark.thyrsus.com.
UNIX 10 May 1993 4
|
