File: options.in

package info (click to toggle)
netrik 1.16.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 3,272 kB
  • ctags: 729
  • sloc: ansic: 6,657; sh: 994; makefile: 114
file content (195 lines) | stat: -rw-r--r-- 7,604 bytes parent folder | download
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
$#<html>
$#<head>
$#<title>command line options</title>
$#</head>
$#<body>

$#<h1 align="center">command line options<br />>======================&lt;</h1>
�  command line options
�>======================<

[This file lists all available command line options for netrik invocation. See
index.txt or $$<a href="index.html">$$index.html$$</a>$$ for an overview of
available netrik documentation.]

Note: netrik is still in early development state; options are subject to
changes.

$#<dl><dt>
��--no-term-width
$#</dt><dd>
��   When using the pager, this causes a page that contains extremely long words
��   to be rendered wider than the screen, instead of breaking the word. Note
��   however that side scrolling isn't implemented yet -- you won't be able to
��   see the end of the line when using this option... In dump mode, this option
��   causes usage of the default width of 80 columns instead of what the terminal
��   definiton says. (Words are always broken in dump mode.)
��
$#</dd><dt>
��--fussy-html
$#</dt><dd>
��   Abort on any HTML syntax errors or warnings encountered. A short error
��   description is printed. (This description may not be terribly useful at
��   times...) This mode is primarily intended for HTML debugging. (Note however
��   that netrik may oversee some errors; but most are reported.)
��
$#</dd><dt>
��--clean-html
$#</dt><dd>
��   Do not abort on HTML syntax errors. Error descriptions are printed for every
��   syntax error (or warning), but netrik tries to parse the page anyhow.
��   Workarounds are used for some typical syntax errors (e.g. unescaped '<' or
��   '&' characters); other errors are ignored. After the whole page is loaded,
��   if some error(s) were found, a warning message is printed (according to the
��   severity of the worst encountered bug), and the pager starts after a
��   keypress.
��
$#</dd><dt>
��--valid-html
$#</dt><dd>
��   This mode is identical to --clean-html, except that netrik doesn't pause
��   after loading completes, if only warnings were generated but no real errors
��   were encountered. (i.e. constructs that are discouraged in the standard, but
��   strictly speaking are valid.)
��
$#</dd><dt>
��--broken-html   (default)
$#</dt><dd>
��   This mode is identical to --valid-html, except that netrik also doesn't
��   pause if only simple errors with known workaround were encountered, which
��   probably won't disturb layouting. Usage should be avoided if possible. (See
��   $$<a$+href="syntax_error.html">$$syntax_error.*$$</a>$$ for details.)
��
$#</dd><dt>
��--ignore-broken
$#</dt><dd>
��   In this mode no warning is showm for any syntax errors, even if they might
��   cause heavily broken layouting. Don't use!
��
$#</dd><dt>
��--debug
$#</dt><dd>
��   Before displaying (or dumping) the page, some intermediate layouting stages
��   are shown. (This output is described in the $$<a$+href="../README">$$README$$</a>$$.) Try it -- it's quite
��   intersting to watch netrik work :-) It can be also useful to find HTML errors
��   in a page, as it dumps the page while loading/parsing it.
��
��   (This option is not available if compiled with --disable-debug to ./configure)
��
$#</dd><dt>
��--warn-unknown
$#</dt><dd>
��   Issue a warning when encountering an unknown HTML element or attribute. This
��   is probably only useful for debugging purposes, as there are quite a lot of
��   (legal) HTML facilities netrik doesn't know.
��
$#</dd><a name="dump" id="dump"><dt>
��--dump
$#</dt><dd>
��   Just dump the file given as argument to the screen and quit, instead of
��   starting the pager. (The page is layouted correctly.)
��   
��   You may want to give the $$<a$+hrfe="#bw">$$--bw option$$</a>$$ also (see below), which will ensure the
��   dump is plain text without any control sequences.
��   
$#</dd></a><dt>
��--no-proxy
$#</dt><dd>
��   Ignore the "http_proxy" and "HTTP_PROXY" environment variables with
��   --builtin-http. (No effect on wget!)
��
$#</dd><dt>
��--no-builtin-http
$#</dt><dd>
��   Use wget to retrieve pages from a HTTP server, instead of the builtin HTTP
��   handling code. Note that HTTP redirects in most cases cause relative links
��   in the page to be broken when using wget. The builtin HTTP code seems to
��   work good now; using wget shouldn't be necessary. (FTP pages however are
��   always loaded via wget.)
��
$#</dd><dt>
��--no-anchor-offset
$#</dt><dd>
��   When jumping to an anchor (following a link with a fragment identifiert),
��   the page will be scrolled (if possible) so that the anchor will stand just
��   below the screen top. (In the second line, which is the first line in which
��   links can be activated.) By default, the anchor is at about 1/5 of the
��   screen height below the top.
��
$#</dd><dt>
��--cursor-keys
$#</dt><dd>
��   Use the arrow keys to move the cursor, instead of the lynx-like navigation used
��   by default. (This is useful for blind users, as it allows using the "flash
��   cursor" keys found on braille displays.)
��
$#</dd><dt>
��--xterm
$#</dt><dd>
��   Assume the terminal has xterm-like attribute handling. (i.e. needs a workaround
��   to display a bright background color.)
��   
��   This setting is used automatically if the terminal type ($TERM environment
��   variable) contains the string "xterm", so you only need to set it manually if
��   you have some other terminal that also needs that workaround or if you have set
��   --console in \fBnetrikrc\fP(5) and need to override that.
��   
��   Note that this workaround works *only* on xterm (and maybe some other
��   terminals), but not on linux console, so you can't just set it categorically!
��
$#</dd><dt>
��--console
$#</dt><dd>
��   Assume the terminal doesn't need and understand the xterm workaround for
��   bright background colors. (See above.)
��
$#</dd><dt>
��--dark-background
$#</dt><dd>
��   Use the color definitions from \fIcolors-dark.c\fP (formerly
��   \fIcolors.alt.c\fP). A black background will be used (even if the terminal uses
��   a bright background by default!), and a set of foreground colors which look
��   very nice on black backgound. (But would be unusable on bright background.)
��   
��   This is the default now.
��
$#</dd><dt>
��--bright-background
$#</dt><dd>
��   Use color definitions from \fIcolors-bright.c\fP (formerly
��   \fIcolors.default.c\fP). The terminal's default colors will be used for
��   background and normal text, and an alternative color scheme suitable for bright
��   background will be used for other text types.
��   
��   Use this if you have a terminal with bright background (like most xterms), and
��   also want to stick to that in \fBnetrik\fP.
��   
��   Note that this can be used on a terminal with dark background as well; some
��   colors are somewhat hard to read, however.
��
$#</dd><dt>
��--no-force-colors
$#</dt><dd>
��   Use terminal's default colors even with --dark-background, instead of forcing
��   usage of \fBnetrik\fP's default text colors (white on black for normal text).
��   This is useful if you use the default (dark) colors and your terminal has a
��   black background anyways -- forcing the default colors is only a waste of time in
��   this situation.
��
$#</dd><a name="bw" id="bw"><dt>
��--bw
$#</dt><dd>
��   Start up in b/w mode. Useful to avoid the warning about missing color
��   capabilities if you really have a terminal not capable of switching text
��   colors. Also useful together with $$<a$+href="#dump">$$--dump$$</a>$$ option.
��
$#</dd></a><dt>
��--color
$#</dt><dd>
��   Undo --bw option.
��
$#</dd></dl>


$#</body>
$#</html>