| 1 |
<html> |
| 2 |
<head> |
| 3 |
<title>command line options</title> |
| 4 |
</head> |
| 5 |
<body> |
| 6 |
|
| 7 |
<h1 align="center">command line options<br />>======================<</h1> |
| 8 |
|
| 9 |
<p> |
| 10 |
[This file lists all available command line options for netrik invocation. See |
| 11 |
index.txt or <a href="index.html">index.html</a> for an overview of |
| 12 |
available netrik documentation.] |
| 13 |
</p> |
| 14 |
|
| 15 |
<p> |
| 16 |
Note: netrik is still in early developement state; options are subject to |
| 17 |
changes. |
| 18 |
</p> |
| 19 |
|
| 20 |
<dl><dt> |
| 21 |
--no-term-width |
| 22 |
</dt><dd> |
| 23 |
When using the pager, this causes a page that contains extremely long words |
| 24 |
to be rendered wider than the screen, instead of breaking the word. Note |
| 25 |
however that side scrolling isn't implemented yet -- you won't be able to |
| 26 |
see the end of the line when using this option... In dump mode, this option |
| 27 |
causes usage of the default width of 80 columns instead of what the terminal |
| 28 |
definiton says. (Words are always broken in dump mode.) |
| 29 |
|
| 30 |
</dd><dt> |
| 31 |
--fussy-html |
| 32 |
</dt><dd> |
| 33 |
Abort on any HTML syntax errors or warnings encountered. A short error |
| 34 |
description is printed. (This description may not be terribly useful at |
| 35 |
times...) This mode is primarily intended for HTML debugging. (Note however |
| 36 |
that netrik may oversee some errors; but most are reported.) |
| 37 |
|
| 38 |
</dd><dt> |
| 39 |
--clean-html |
| 40 |
</dt><dd> |
| 41 |
Do not abort on HTML syntax errors. Error descriptions are printed for every |
| 42 |
syntax error (or warning), but netrik tries to parse the page anyhow. |
| 43 |
Workarounds are used for some typical syntax errors (e.g. unescaped '<' or |
| 44 |
'&' characters); other errors are ignored. After the whole page is loaded, |
| 45 |
if some error(s) were found, a warning message is printed (according to the |
| 46 |
severity of the worst encountered bug), and the pager starts after a |
| 47 |
keypress. |
| 48 |
|
| 49 |
</dd><dt> |
| 50 |
--valid-html |
| 51 |
</dt><dd> |
| 52 |
This mode is identical to --clean-html, except that netrik doesn't pause |
| 53 |
after loading completes, if only warnings were generated but no real errors |
| 54 |
were encountered. (i.e. constructs that are discouraged in the standard, but |
| 55 |
strictly speaking are valid.) |
| 56 |
|
| 57 |
</dd><dt> |
| 58 |
--broken-html (default) |
| 59 |
</dt><dd> |
| 60 |
This mode is identical to --valid-html, except that netrik also doesn't |
| 61 |
pause if only simple errors with known workaround were encountered, which |
| 62 |
probably won't disturb layouting. Usage should be avoided if possible. (See |
| 63 |
<a href="syntax_error.html">syntax_error.*</a> for details.) |
| 64 |
|
| 65 |
</dd><dt> |
| 66 |
--ignore-broken |
| 67 |
</dt><dd> |
| 68 |
In this mode no warning is showm for any syntax errors, even if they might |
| 69 |
cause heavily broken layouting. Don't use! |
| 70 |
|
| 71 |
</dd><dt> |
| 72 |
--debug |
| 73 |
</dt><dd> |
| 74 |
Before displaying (or dumping) the page, some intermediate layouting stages |
| 75 |
are shown. (This output is described in the <a href="../README">README</a>.) Try it -- it's quite |
| 76 |
intersting to watch netrik work :-) It can be also useful to find HTML errors |
| 77 |
in a page, as it dumps the page while loading/parsing it. |
| 78 |
|
| 79 |
(This option is not available if compiled with --disable-debug to ./configure) |
| 80 |
|
| 81 |
</dd><dt> |
| 82 |
--warn-unknown |
| 83 |
</dt><dd> |
| 84 |
Issue a warning when encountering an unknown HTML element or attribute. This |
| 85 |
is probably only useful for debugging purposes, as there are quite a lot of |
| 86 |
(legal) HTML facilities netrik doesn't know. |
| 87 |
|
| 88 |
</dd><a name="dump" id="dump"><dt> |
| 89 |
--dump |
| 90 |
</dt><dd> |
| 91 |
Just dump the file given as argument to the screen and quit, instead of |
| 92 |
starting the pager. (The page is layouted correctly.) |
| 93 |
|
| 94 |
You may want to give the <a hrfe="#bw">--bw option</a> also (see below), which will ensure the |
| 95 |
dump is plain text without any control sequences. |
| 96 |
|
| 97 |
</dd></a><dt> |
| 98 |
--no-proxy |
| 99 |
</dt><dd> |
| 100 |
Ignore the "http_proxy" and "HTTP_PROXY" environment variables with |
| 101 |
--builtin-http. (No effect on wget!) |
| 102 |
|
| 103 |
</dd><dt> |
| 104 |
--no-builtin-http |
| 105 |
</dt><dd> |
| 106 |
Use wget to retrieve pages from a HTTP server, instead of the builtin HTTP |
| 107 |
handling code. Note that HTTP redirects in most cases cause relative links |
| 108 |
in the page to be broken when using wget. The builtin HTTP code seems to |
| 109 |
work good now; using wget shouldn't be necessary. (FTP pages however are |
| 110 |
always loaded via wget.) |
| 111 |
|
| 112 |
</dd><dt> |
| 113 |
--no-anchor-offset |
| 114 |
</dt><dd> |
| 115 |
When jumping to an anchor (following a link with a fragment identifiert), |
| 116 |
the page will be scrolled (if possible) so that the anchor will stand just |
| 117 |
below the screen top. (In the second line, which is the first line in which |
| 118 |
links can be activated.) By default, the anchor is at about 1/5 of the |
| 119 |
screen height below the top. |
| 120 |
|
| 121 |
</dd><dt> |
| 122 |
--cursor-keys |
| 123 |
</dt><dd> |
| 124 |
Use the arrow keys to move the cursor, instead of the lynx-like navigation used |
| 125 |
by default. (This is useful for blind users, as it allows using the "flash |
| 126 |
cursor" keys found on braille displays.) |
| 127 |
|
| 128 |
</dd><dt> |
| 129 |
--xterm |
| 130 |
</dt><dd> |
| 131 |
Assume the terminal has xterm-like attribute handling. (i.e. needs a workaround |
| 132 |
to display a bright background color.) |
| 133 |
|
| 134 |
This setting is used automatically if the terminal type (ERM environment |
| 135 |
variable) contains the string "xterm", so you only need to set it manually if |
| 136 |
you have some other terminal that also needs that workaround or if you have set |
| 137 |
--console in \fBnetrikrc\fP(5) and need to override that. |
| 138 |
|
| 139 |
Note that this workaround works *only* on xterm (and maybe some other |
| 140 |
terminals), but not on linux console, so you can't just set it categorically! |
| 141 |
|
| 142 |
</dd><dt> |
| 143 |
--console |
| 144 |
</dt><dd> |
| 145 |
Assume the terminal doesn't need and understand the xterm workaround for |
| 146 |
bright background colors. (See above.) |
| 147 |
|
| 148 |
</dd><dt> |
| 149 |
--dark-background |
| 150 |
</dt><dd> |
| 151 |
Use the color definitions from \fIcolors-dark.c\fP (formerly |
| 152 |
\fIcolors.alt.c\fP). A black background will be used (even if the terminal uses |
| 153 |
a bright background by default!), and a set of foreground colors which look |
| 154 |
very nice on black backgound. (But would be unusable on bright background.) |
| 155 |
|
| 156 |
This is the default now. |
| 157 |
|
| 158 |
</dd><dt> |
| 159 |
--bright-background |
| 160 |
</dt><dd> |
| 161 |
Use color definitions from \fIcolors-bright.c\fP (formerly |
| 162 |
\fIcolors.default.c\fP). The terminal's default colors will be used for |
| 163 |
background and normal text, and an alternative color scheme suitable for bright |
| 164 |
background will be used for other text types. |
| 165 |
|
| 166 |
Use this if you have a terminal with bright background (like most xterms), and |
| 167 |
also want to stick to that in \fBnetrik\fP. |
| 168 |
|
| 169 |
Note that this can be used on a terminal with dark background as well; some |
| 170 |
colors are somewhat hard to read, however. |
| 171 |
|
| 172 |
</dd><dt> |
| 173 |
--no-force-colors |
| 174 |
</dt><dd> |
| 175 |
Use terminal's default colors even with --dark-background, instead of forcing |
| 176 |
usage of \fBnetrik\fP's default text colors (white on black for normal text). |
| 177 |
This is useful if you use the default (dark) colors and your terminal has a |
| 178 |
black background anyways -- forcing the default colors is only a waste of time in |
| 179 |
this situation. |
| 180 |
|
| 181 |
</dd><a name="bw" id="bw"><dt> |
| 182 |
--bw |
| 183 |
</dt><dd> |
| 184 |
Start up in b/w mode. Useful to avoid the warning about missing color |
| 185 |
capabilities if you really have a terminal not capable of switching text |
| 186 |
colors. Also useful together with <a href="#dump">--dump</a> option. |
| 187 |
|
| 188 |
</dd></a><dt> |
| 189 |
--color |
| 190 |
</dt><dd> |
| 191 |
Undo --bw option. |
| 192 |
|
| 193 |
</dd></dl> |
| 194 |
|
| 195 |
|
| 196 |
</body> |
| 197 |
</html> |