summaryrefslogtreecommitdiffstats
path: root/network/w3m/README
diff options
context:
space:
mode:
Diffstat (limited to 'network/w3m/README')
-rw-r--r--network/w3m/README38
1 files changed, 30 insertions, 8 deletions
diff --git a/network/w3m/README b/network/w3m/README
index 86951b88df..15ea4bb339 100644
--- a/network/w3m/README
+++ b/network/w3m/README
@@ -1,10 +1,32 @@
-w3m is a World Wide Web (WWW) text based client. It has English and
-Japanese help files and an option menu and can be configured to use
-either language. It will display hypertext markup language (HTML)
-documents containing links to files residing on the local system, as
-well as files residing on remote systems. It can display HTML tables,
-frames, and images, and supports tabbed browsing. In addition, it can
-be used as a "pager" in much the same manner as "more" or "less".
-w3m can display images in both the framebuffer and the X server.
+w3m is a World Wide Web (WWW) text based client.
+
+Help is avaliable in English, German and Japanese. There is an
+option menu which can be configured for the chosen lanugage.
+
+It will display hypertext markup language (HTML) documents containing
+links to files residing on the local system, as well as files
+residing on remote systems. It can display HTML tables, frames, and
+images, and supports tabbed browsing. In addition, it can be used as
+a "pager" in much the same manner as "more" or "less". w3m can
+display images in both the framebuffer, incertain consoles, and the X
+server.
+
+Supported consoles for image display are urxvt (rxvt-unicode) and
+termite (via a patch), including inside screen (untested with tmux).
Optional dependency: compface
+
+SlackBuild Options:
+
+To disable mouse support pass NOMOUSE=1 to the slackbuild.
+To disable w3mmailer pass NOMAILER=1 to the slackbuild.
+To set the GUI browser pass the desired browser as GUIBROWSER.
+
+EG:
+
+NOMOUSE=1 ./w3m.SlackBuild
+NOMAILER=1 ./w3m.SlackBuild
+GUIBROWSER=/usr/bin/qutebrowser ./w3m.SlackBuild
+
+Or combine any of them together. By default the GUI browser is set to
+/usr/bin/firefox.