File: tkinfo.1

package info (click to toggle)
tkinfo 2.8-6
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 700 kB
  • ctags: 6
  • sloc: tcl: 11,960; makefile: 33; sh: 29
file content (184 lines) | stat: -rw-r--r-- 4,129 bytes parent folder | download | duplicates (4)
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
.TH TKINFO 1
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
.\" other parms are allowed: see man(7), man(1)

.SH NAME
tkinfo \- program to view GNU Info files

.SH SYNOPSIS
.B tkinfo
[
.B \-\-help
] [
.B \-headers 
|
.B +headers
] [
.B \-buttons 
|
.B +buttons
] [
.B \-scrollthrough
|
.B +scrollthrough
] [
.B \-pagesep
|
.B +pagesep
] [
.B \-showdir
|
.B +showdir
] [
.B \-balloons
|
.B +balloons
] [
.B \-linklook
.I type
] [
.B \-highlight
.I type
] [
.B \-searchlook
.I type
] [
.B \-geometry 
.I geom
] [
.B \-display 
.I display
] [
.B \-iconic
] [
.B \-dir
.I dir1
] [
.B \-dir
.I dir2
] ... [
.I node
]

.SH "DESCRIPTION"
.PP
.B tkinfo
is a graphical browser for documentation in the GNU Info hypertext format.

.SH OPTIONS
.TP
.B \-\-help
Produces a short help message.
.TP
.B \-/+headers
Turns on/off display of the raw info node headers in the first line of
the window. Default is on.
.TP
.B \-/+buttons
Turns on/off display of the button row. Default is on.
.TP
.B \-/+balloons
Turns on/off balloonhelp for the buttons. Default is on.
.TP
.B \-/+scrollthrough
Turns on/off jumping to the successor node when attempting to scroll
at the bottom of a node. Default is on.
.TP
.B \-/+pagesep
Turns on/off inserting of page separators when scrolling page-wise. 
Default is on.
.TP
.B \-/+showdir
Turns on/off showing the full pathname of the displayed info
file. Default is off.
.TP
.BI "\-linklook " type
Specifies how to display cross references and menu entries.  
.I type 
must be one of "color", "font", or "underline". Default is "color" on 
color displays
and "underline" on black and white displays.
.TP
.BI "\-highlight " type
Specifies how to highlight links. 
.I type 
must be one of "color", "inverse", or "underline". Default is "inverse".
.TP
.BI "\-searchlook " type
Specifies how to highlight matches after searches.
.I type 
must be one of "color", "inverse", or "underline". Default is "inverse".
.TP
.BI "\-geometry " geom
Geometry of the window. 
.I geom 
must be of the form
XxY+A+B or XxY or +A+B, where X and Y specify the size of the window
in characters and A and B the location in pixels.
.TP
.BI "\-display " display
X display to use for the 
.B tkinfo 
window.
.TP
.B \-iconic
Start the first window in iconic state.
.TP
.BI "\-dir " dir
Specifies directories to search for info files, in addition to those
contained in the INFOPATH environment variable.  The directories
specified with \-dir will be searched first, in the order given.
.TP
.I node
Specifies the info node to visit initially. Possible formats for
.I node
are:
.br
  "(filename)nodename"  most general
.br
  "(filename)"          equivalent to (filename)Top
.br
  "filename"            equivalent to (filename).
.PP
If filename is not absolute, the info directories (from INFOPATH and
\-dir) will be searched. If filename cannot be found, its lower case
version will be tried.
.PP
An alternative way to specify the node "(FILE)NODE" is with "\-file FILE
\-node NODE".
.PP
If no 
.I node
is given, the default node "(dir)Top" is used.

.SH ENVIRONMENT
.TP
.B INFOPATH
A colon (``:'') separated list of directories to search for info
files. More directories can be given with \-dir options, above. If not
set, 
.B tkinfo 
will try various standard directories that should be ok for most
systems.
.TP
.B INFOSUFFIX
A colon separated list of file suffixes to try when searching for an
info file. If not set, 
.B tkinfo
will try the suffixes "", ".info", and "\-info". In addition, 
.B tkinfo
will always automatically try the suffixes .Z, .z, and .gz and deal with
the compressed file if necessary.

.SH "SEE ALSO"
The program documents itself in the info format: start it and type
\'h\'. Customization via X resources is also documented in that way.
.PP
You can get additional information and the latest version of 
.B tkinfo
on the WWW at http://math-www.uni-paderborn.de/~axel/tkinfo/

.SH AUTHOR
This manual page was written by Craig Sanders <cas@taz.net.au> for
the Debian GNU/Linux system and released under the GNU General Public License.
Some changes were made by Axel Boldt <axelboldt@yahoo.com>.