1 Overview of the ELinks documentation
3 There is only limited documentation available for ELinks so far, sorry. It
4 basically consists of the documents in this directory and the features.conf,
5 README and INSTALL files in the project's root directory.
7 You are encouraged to get a copy of the ELinks manual. It tries to be a
8 complete book of all there is to know about ELinks. For example, most files
9 listed in the next section is in some way part of the ELinks manual.
11 Instructions on building the manual is given below. If you do not intend to
12 build it yourself either access it on the ELinks homepage or, if you
13 downloaded ELinks via a tarball, the manual should be in the html/ directory.
19 This sections tries to give a quick overview of important files you will find
20 in this directory or it's children.
24 elinks(1) ................................... man/man1/elinks.1
25 elinks.conf(5) .............................. man/man5/elinks.conf.5
26 elinkskeys(5) ............................... man/man5/elinkskeys.5
28 Man pages are best viewed with the man program. The easiest way to do this
29 is by telling the man program to look for man pages in the doc/man
30 directory by using the -M switch. If you are standing in the top-level
31 directory, you can do this by invoking the man program using:
33 man -M doc/man elinks.conf
37 Getting ELinks up and running................ installation.txt
38 Introduction to the World of ELinks ......... introduction.txt
39 Frequently Asked Questions .................. faq.txt
40 JavaScript/ECMAScript in ELinks ............. ecmascript.txt
41 Notes on User Feedback ...................... feedback.txt
42 The Smallest Binary Quest Spoilerbook ....... small.txt
44 Note: The ELinks manual really should be read in one of the generated
45 formats: html, html-chunked or pdf, however the entry point can be found in
46 manual.txt and might be of some help, when deciding what other .txt
47 documents to read in this directory.
51 Introduction to ELinks Developing ........... dev-intro.txt
52 The Demented Guide to Source Hacking ........ hacking.txt
54 The developing intro tries to explain some of the basic concepts in the
55 ELinks internal. While the hacking guide contains great deal about general
56 source code structure and especially guidelines regarding coding style,
57 submitting patches etc., thus every aspiring developer should take the
58 pains to read through it, do not forget to also look for README and similar
59 text files in the subdirectories containing the relevant sources for
60 detailed notes regarding given modules/subsystems.
62 The Lua Scripting Book ...................... lua-scripting.txt
63 Events Reference Sheet ...................... events.txt
65 The above covers internal scripting, by which we mean scripting of the
66 browser internals through embedded Lua, Guile or Perl scripts. ECMAScript
67 scripts embedded in documents have nothing to do with that.
70 Building documentation
71 ----------------------
73 The following tools are used for generating documentation in various formats:
75 - asciidoc: the basic tool for lifting the .txt files to other formats.
76 - xmlto: used for outputting chunked HTML and man pages.
77 - jw: used for pdf documents.
78 - pod2html: used for perl docs.
80 All these tools are checked by configure, thus to successfully build all the
81 possible documentation (with the tools available on the system), just run
85 in the doc/ directory. It will build, if possibly, the manual in the following
86 manual formats (with tool requirements listed):
88 - HTML one-file (asciidoc)
89 - HTML chunked / multiple files (asciidoc + xmlto)
92 and the following man page formats:
95 - man / groff (asciidoc + xmlto)
97 Note: You do not need to build manpages. They are shipped with ELinks.
99 Note: You must first build the ELinks binary for "make all-docs" to work
100 successfully. The binary is used for getting option documentation.
106 Contributions are very warmly welcomed, whether it is fixing typos or bad
107 grammar, rewritings or new material. Any information relevant to ELinks usage
108 can be included in the manual, including FAQ material, tips and cheats ;)
110 There is no strict codingstyle, but please don't limit your use of whitespaces
111 and take a look at the style used in the current documents to get ideas of what
114 Contributions should be sent to Jonas Fonseca <fonseca@diku.dk> or to the
115 ELinks mailing list. If you are changing something in an existing document,
116 please read about how to make unified patches in the Patches section of the
117 doc/hacking.txt file.