Merge pull request #237 from rkta/siteconf_docs

Improve siteconf docs
This commit is contained in:
Tatsuya Kinoshita
2022-12-25 10:08:05 +09:00
committed by GitHub

View File

@@ -8,6 +8,7 @@ The siteconf is read from ~/.w3m/siteconf by default.
===== The syntax =====
# comment
url <url>|/<re-url>/|m@<re-url>@i [exact]
substitute_url "<destination-url>"
url_charset <charset>
@@ -17,42 +18,39 @@ user_agent "string"
The last match wins.
Lines starting with a '#' are ignored. You can use this to annotate the
entries.
===== Examples =====
# This forwards twitter.com to the alternative site.
url m!^https?://([a-z]+\.)?twitter\.com/!
substitute_url "https://nitter.net/"
This forwards twitter.com to the alternative site.
# This prevents HTTP referers from being sent when you follow links
# at the your.bookmark.net.
url "http://your.bookmark.net/"
no_referer_from on
This prevents HTTP referers from being sent when you follow links
at the your.bookmark.net.
# This forwards the Google's redirector to your local CGI.
url "http://www.google.com/url?" exact
substitute_url "file:///cgi-bin/your-redirector.cgi?"
This forwards the Google's redirector to your local CGI.
# When combinated with "decode_url" option turned on, links to
# Wikipedia will be human-readable.
url /^http:\/\/[a-z]*\.wikipedia\.org\//
url_charset utf-8
When combinated with "decode_url" option turned on, links to
Wikipedia will be human-readable.
# Tell Google we're actually Lynx. (So they send us a text-browser friendly
# results page.)
url m@^https?://(.*\.)google\.com/@
user_agent "Lynx/2.8.8dev.3 libwww-FM/2.14 SSL-MM/1.4.1"
Tell Google we're actually Lynx. (So they send us a text-browser friendly
results page.)
# Tell Twitter we're actually Googlebot. (So they send us a page without
# rejection of a JavaScript disabled browser.)
url m!^https?://([a-z]+\.)?twitter\.com/!
user_agent "Googlebot/2.1"
Tell Twitter we're actually Googlebot. (So they send us a page without
rejection of a JavaScript disabled browser.)
===== Regular expressions notes =====
Following expressions are all equivalent: