network/elinks: Add multiple build options and contributed code.

1 files changed, 54 insertions, 23 deletions

diff --git a/network/elinks/README b/network/elinks/README
index 736c32bde8..89e2057621 100644
--- a/network/elinks/README
+++ b/network/elinks/README
@@ -1,34 +1,65 @@
 elinks (ELinks - Full-Featured Text WWW Browser)
 
-ELinks is an advanced and well-established feature-rich text mode
-web (HTTP/FTP/..) browser. ELinks can render both frames and tables,
-is highly customizable, and can be extended via Lua or Guile scripts.
-It is very portable and runs on a variety of platforms. It also uses
-Spider Monkey's javascript support.
+ELinks is an advanced and well-established feature-rich text mode web
+(HTTP/FTP/..) browser. ELinks can render both frames and tables, is highly
+customizable, and can be extended via Lua or Guile scripts. It is very portable
+and runs on a variety of platforms. It also uses SpiderMonkey javascript
+support.
 
-ELinks also supports the gopher protocol.
+There are a number of options that can be used to add support for other
+protocols etc. To enable or disable an option use the following method:
 
-Various support options added into this SlackBuild:
+MOUSE=no ./elinks.SlackBuild
 
-Guile, CGI, NNTP, HTML-highlight, finger, bittorrent, gopher,
-exmode, 88 colours, 256 colours, true colour.
+Several options can be combined together.
 
-If you experience problems with corrupt graphics etc. it may be worth
-experiementing with various $TERM variables, as well as look into the
-settings for terminal options. EG:
+OPTIONS
 
-TERM=rxvt-unicode elinks <URL>
+Category       Description                         Default Value
 
-To disable the X windows mouse use the flag NOMOUSE=1
-To disable the gpm mouse use the flag NOGPM=1
-or combine them:
+System:
 
-NOMOUSE=1 NOGPM=1 ./elinks.SlackBuild
+FASTMEM        Direct use of system alloc          no
+CGI            Local CGI support                   no
+CCOMBINING     Unicode combining characters        no
+UTF8           UTF-8 support                       yes
+IPV6           IPv6 support                        yes
+HTMLHL         HTML highlighting using DOM engine  no
+LZMA           LZMA encoding support               no
 
-This version is patched to fix the following issues:
+UI:
 
-Fix gopher URL: html links.
-Fix gopher index queries.
-Fix gopher directory links.
-Make elinks verify ssl hostnames.
-Fix a few more issues with gopher links.
+MOUSE          Mouse support                       yes
+GPM            GPM (mouse) support                 yes
+EXMODE         Exmode (CLI) interface              no
+
+Colours:
+
+COLS88         88 Colours                          no
+COLS256        256 Colours                         no
+COLSTRUE       True Colours                        no
+
+Scripting:
+
+GUILE                                              no
+PERL                                               no
+PYTHON                                             no
+LUA                                                yes
+ECMA           (SpiderMonkey Javascript Engine)    yes
+
+Protocols:
+
+BITTORRENT                                         no
+DATA                                               yes
+FSP                                                no
+FTP                                                yes
+FINGER                                             no
+GOPHER                                             no
+NNTP                                               no
+SMB                                                no
+
+Note that Unicode combining characters is marked as experimental.
+
+Optional Dependencies:
+
+tre:  for regex search support