NETRIKRC(5)

🌸 NETRIKRC — the netrik config file, bestie edition 🌸

okay so this is the manual page for netrikrc (that's the netrik configuration file, section 5 of the File Formats Manual, iykyk 💅). sit down, grab a strawberry, we're gonna go through it together. no cap.

---

✨ NAME ✨

netrikrc — the netrik configuration file 🎀

---

💖 DESCRIPTION 💖

Netrik(1) is gonna read the file ~/.netrikrc (that's the file .netrikrc in your home directory, bestie — your very own home folder) if it's there, and it grabs the default settings from it. if it's not there? no drama, it just moves on.

the structure is literally so simple it's giving icon status: every option you can hand to netrik on the command line, you can also list in this file. that's it. just drop all the options you want (including the leading --) in here, one per line. one. per. line. 🫶

and because every option also has an inverted version (usually --no-foo instead of --foo, but there are a few exceptions — we don't talk about those), you can still override the defaults from this file by passing command line options. the command line wins, periodt. 👑

oh and you can also put a URL in the config file! just pop it on a line with no options next to it. it becomes your home page: it gets loaded when no other file is given when you run netrik, and it gets ignored otherwise. main character home page energy. ✨

---

🌈 OPTIONS 🌈

Note: netrik is still in early development state; options are subject to changes. (yes this is in the original, and yes we're keeping it, the dev said what the dev said 😭)

• --force-colors — forces netrik's default text colors (white on black for normal text) even if your terminal has its own defaults. without this option, netrik tries to adopt the terminal's defaults instead. (so it keeps that light background most xterms are rocking. 💅)
• --no-term-width — when you're using the pager, this makes a page that has extremely long words render wider than the screen instead of breaking the word. but listen — side scrolling isn't implemented yet, so you genuinely won't be able to see the end of the line with this option on. 😭 in dump mode, this option causes usage of the default width of 80 columns instead of whatever the terminal definition says. (in dump mode, words are always broken anyway.)
• --fussy-html — abort on any HTML syntax errors or warnings encountered. a short error description gets printed. (and ngl, that description may not be terribly useful at times...) this mode is primarily for HTML debugging. (though note that netrik may oversee some errors — but most are reported. most. 🙈)
• --clean-html — do not abort on HTML syntax errors. error descriptions get 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), and other errors are just 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. 🦋
• --valid-html — identical to --clean-html, except netrik doesn't pause after loading completes if only warnings were generated and no real errors were encountered. (i.e. constructs that are discouraged in the standard but strictly speaking are valid. it's giving "technically correct". ✨)
• --broken-html (default) — identical to --valid-html, except 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. (the file syntax_error.txt or syntax_error.html in the documentation directory — see SEE ALSO below — explains why. 👀)
• --ignore-broken — in this mode no warning is shown for any syntax errors, even if they might cause heavily broken layouting.

Don't use! 💀 (that's not me being dramatic, that's the manpage. it's giving danger.)

• --debug — before displaying (or dumping) the page, some intermediate layouting stages are shown. (this output is described in the README.) try it — it's genuinely interesting to watch netrik work :-) it can also be useful to find HTML errors in a page, since it dumps the page while loading/parsing it. (this option is not available if compiled with --disable-debug to ./configure. so check before you get excited. 🙈)
• --warn-unknown — issues a warning when encountering an unknown HTML element or attribute. probably only useful for debugging purposes, since there are quite a lot of (legal) HTML facilities netrik doesn't know. 😅
• --dump — just dumps the file given as argument to the screen and quits, instead of starting the pager. (the page is layouted correctly, don't worry. 🫶) you may want to also give the --bw option (see below), which ensures the dump is plain text without any control sequences.
• --no-proxy — ignore the http_proxy and HTTP_PROXY environment variables with --builtin-http. (no effect on wget! see below. 👇)
• --no-builtin-http — use wget(1) 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. no exceptions. 💅)
• --no-anchor-offset — when jumping to an anchor (following a link with a fragment identifier), the page will be scrolled (if possible) so the anchor stands 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.
• --cursor-keys — use the arrow keys to move the cursor, instead of the lynx-like navigation used by default. (this is useful for blind users, since it allows using the "flash cursor" keys found on braille displays. 🫶)
• --xterm — assume the terminal has xterm-like attribute handling. (i.e. it 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.

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! 😭

• --console — assume the terminal doesn't need and understand the xterm workaround for bright background colors. (see above. 👆)
• --dark-background — use the color definitions from colors-dark.c (formerly colors.alt.c). a black background will be used (even if the terminal uses a bright background by default!), plus a set of foreground colors which look very nice on black background. (but would be unusable on bright background.) this is the default now. 🖤
• --bright-background — use color definitions from colors-bright.c (formerly colors.default.c). the terminal's default colors get used for background and normal text, and an alternative color scheme suitable for bright background is 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 netrik. note that this can be used on a terminal with dark background as well; some colors are somewhat hard to read, however. 👀
• --no-force-colors — use the terminal's default colors even with --dark-background, instead of forcing usage of netrik'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. ✨
• --bw — 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 the --dump option. 🎀
• --color — undo --bw option. that's it, that's the whole thing. 💅

---

🧚 EXAMPLES 🧚

the following config file:

--broken-html
--no-anchor-offset
file:///usr/local/share/doc/netrik/index.html

means:

--broken-html: Do not to stop on smaller HTML errors. (use --valid-html or --clean-html on the command line to override that for a single netrik invocation. 😌)

--no-anchor-offset: when going to an anchor, scroll the page so the anchor appears at the screen top, instead of 1/5 of the screen hight below the top. (use --anchor-offset to override. 🦋)

file:///usr/local/share/doc/netrik/index.html: when no other file name/URL is specified on the command line, open the netrik documentation overview. (if netrik was installed from a Debian or RPM package, use file:///usr/share/doc/netrik/index.html instead. 🫶)

---

⭐ VERSION ⭐

this manual page documents the config file for netrik 1.16.1.

---

👑 AUTHOR 👑

netrik was created and is maintained by Olaf D. Buddenhagen AKA antrik (<antrik@users.sf.net>), with major contributions from Patrice Neff, Sören Schulze, and others. (for a full listing of all contributors see AUTHORS in the doc directory — see below. 💜)

this man page was created by antrik. 🎀

---

🔥 SEE ALSO 🔥

• netrik(1)

---

and that's the whole page bestie, you ate that 💅✨ — this was NETRIKRC(5), dated April 19th, 2004, love that for us 🦋🌸