1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-06-12 23:10:51 +00:00
Commit Graph

310 Commits

Author SHA1 Message Date
Jonas Fonseca
34a18bd597 Add description and version info to manpages
This adopts customized docbook manpage header from git's
Documentation/asciidoc.conf and does away with a couple of
ugly hacks.

(cherry picked from commit 0ecc8b9d60,
 omitting generated files)
2008-03-06 10:28:09 +02:00
Kalle Olavi Niemitalo
857c27e8b6 elinks.conf.5: quoting corrections
In set and unset commands, the <option> must not be quoted.  In the
sample protocol.user.mailto.unix setting, the internal quotes were
using some manpage syntax, resulting in incorrect HTML output.
2008-03-06 10:23:21 +02:00
Miciah Dashiel Butler Masters
1086a7c561 elinks.conf.5: Correct description of 'unset' directive
The 'unset' directive does not take a value.
(cherry picked from commit dc7731d30d)
2008-03-05 22:34:10 +02:00
Jonas Fonseca
b28ccd6e4f keys2doc: fix handling of dots (.) in description list term
Quote character keybindings to workaround unescaped (resulting to
invisible) dots in elinkskeys(5).
(cherry picked from commit 3de420d72f)
2008-03-05 10:04:47 +02:00
Jonas Fonseca
9863dbfa9c keys2doc: map the KBD_MOD_SHIFT modifier to Shift-prefix
(cherry picked from commit dc497964e9)
2008-03-05 10:01:21 +02:00
Jonas Fonseca
b0251dad32 elinks(1): update and polish; leave out the platform section
The list of platforms are better maintained on the homepage.

(cherry picked from commit 3ea7939b0d,
 regenerated doc/man/man1/elinks.1.in)
2008-03-05 10:00:06 +02:00
Kalle Olavi Niemitalo
df6801202c elinks(1): Rewrite using AsciiDoc 8.2.2 and DocBook XSL 1.72.0
It basically rewrites the nroff formatting of the elinks(1) manpage and
is mainly checked in separately to make it easier to review later
updates.

This corresponds to commit b09b149986
in ELinks 0.11.4rc0.GIT.
2008-03-05 09:48:33 +02:00
Jonas Fonseca
0c9c7770b7 Add rebuilding manpages as a release task 2008-03-04 11:12:35 +01:00
Kalle Olavi Niemitalo
af9ed54c0f Merge branch 'elinks-0.12' into elinks-0.13 2008-03-01 17:28:37 +02:00
Jonas Fonseca
06b34ef5ac Introduce otherman:[] macro for non-ELinks manpage references
.. avoids an unsafe AsciiDoc operation.
(cherry picked from commit 9be36ed129)
2008-02-28 23:38:35 +02:00
Kalle Olavi Niemitalo
3c861fd530 Merge branch 'elinks-0.12' into elinks-0.13
Conflicts:

	configure.in
	src/protocol/http/http.c
2008-02-24 22:49:47 +02:00
Kalle Olavi Niemitalo
79b69e0bf9 encoding: documentation 2008-02-24 20:45:33 +02:00
Jonas Fonseca
a2c7af990b Change Cogito commands to git 2008-02-05 01:54:43 +01:00
Kalle Olavi Niemitalo
814e672736 Merge branch 'elinks-0.12' into elinks-0.13
Conflicts:

	src/osdep/osdep.c
2008-02-04 23:51:42 +02:00
Kalle Olavi Niemitalo
c55158ddd4 INCLUDE_PATH for Doxygen 2008-02-03 23:14:57 +02:00
Miciah Dashiel Butler Masters
3a0286e447 Strings corrections from Malcolm Parsons
Fix the spelling and grammar in various comments, variable names, comment
descriptions, and documentation.
2008-01-27 04:19:23 +00:00
Miciah Dashiel Butler Masters
643a34e6af Strings corrections from Malcolm Parsons
Fix the spelling and grammar in various comments, variable names, comment
descriptions, and documentation.
2008-01-27 04:09:18 +00:00
Miciah Dashiel Butler Masters
dc7731d30d elinks.conf.5: Correct description of 'unset' directive
The 'unset' directive does not take a value.
2008-01-27 02:59:06 +00:00
Kalle Olavi Niemitalo
9fff802c08 Merge branch 'elinks-0.12' into elinks-0.13 2007-12-16 10:12:08 +02:00
Kalle Olavi Niemitalo
02ffed2fff Document that GNU Make >= 3.78 is needed, and check it.
(cherry picked from commit 4ffbf1faed)
2007-12-09 08:16:29 +02:00
Kalle Olavi Niemitalo
4ffbf1faed Document that GNU Make >= 3.78 is needed, and check it. 2007-12-06 23:46:19 +02:00
Kalle Olavi Niemitalo
cca6ab7034 Enable asciidoc7compatible mode.
AsciiDoc 8 has changed the syntax again and generates e.g. subscripts
where we don't want them.  Instead of updating the documents, I'll
just enable a compatibility mode so that ELinks doesn't require
AsciiDoc 8 yet.
2007-11-25 09:09:58 +02:00
Miciah Dashiel Butler Masters
3975d28bce Merge commit 'origin/elinks-0.12'
Conflicts:

	doc/Doxyfile.in
	src/protocol/bittorrent/common.h
2007-08-28 14:47:39 +00:00
Jonas Fonseca
1079c95b9d Integrate Doxygen better in the build system
This change:

 - Adds a check for the doxygen program to configure.
 - Moves the Doxyfile from src/Doxyfile to doc/Doxyfile.in.
 - Generates a doc/Doxyfile from doc/Doxyfile.in inserting
   an absolute path to the source directory, so that it
   also works when builddir != srcdir.
 - Adds `make api` rule for running doxygen; it depends on
   api/doxygen file which is never created to force the rule
   to always run.
2007-08-08 14:23:21 +02:00
Kalle Olavi Niemitalo
df0f64f9e7 doc: Don't generate HTML for po/perl/ 2007-07-18 15:41:16 +03:00
Kalle Olavi Niemitalo
e6a2430fb7 Rename accelerator checking scripts. 2007-07-17 14:32:07 +03:00
Kalle Olavi Niemitalo
78133cfeee Regenerated manpages.
In doc/man/man1/elinks.1.in, only the date had changed, so I'm
omitting that file from this commit.
2007-06-22 00:01:04 +03:00
Kalle Olavi Niemitalo
1f68e44a42 elinkskeys.5: Revert 8f030fcb63, which ESR did not review.
Revert 8f030fcb63, "Hack elinkskeys.5
with sed some more, to please ESR."  I asked ESR on 2007-01-06 and
2007-06-09 whether the changes were OK, but he never answered.  So I'm
reverting the changes until someone with troff knowledge reviews them.
2007-06-21 22:49:44 +03:00
Kalle Olavi Niemitalo
f0119e1944 Check for gzclearerr in configure. Document needing zlib >= 1.2.0.2.
It was reported at elinks-dev on 2007-06-03 that Solaris 10 comes with
zlib 1.1.4, which does not include gzclearerr(), which ELinks nowadays
requires.  It would be possible to rewrite the decompression support
to use deflate() directly and avoid stdio, in which case gzclearerr()
would not be needed.  That will take some time however, so I'm not
attempting it for ELinks 0.12.0.  Instead, I'm just disabling gzip
decompression entirely if zlib is too old.
2007-06-11 10:15:43 +03:00
Kalle Olavi Niemitalo
c56b662f46 doc/release.txt: Don't speculate on the release date. 2007-05-01 15:33:38 +03:00
Kalle Olavi Niemitalo
e27a3c3f58 lua-scripting: Revised examples for Lua 5.0. And other updates.
Use admonishment elements, especially WARNING for insecure temporary files.
Don't say anything about enabling system functions.
Linuxgames.com no longer uses <CENTER>.
AppWatch.com was shut down on 2001-08-31.
2007-04-19 00:14:13 +03:00
Jonas Fonseca
707bb70361 release.txt: Also remember to update download.html 2007-04-16 08:37:23 +02:00
Jonas Fonseca
315c6e8552 Merge with git+ssh://pasky/srv/git/elinks.git 2007-04-15 22:10:00 +02:00
Jonas Fonseca
8013553d31 release.txt: remember to add version number to NEWS file
Thanks to kahmalo.
2007-04-15 22:09:17 +02:00
Kalle Olavi Niemitalo
20fbefbe18 lua_console_hook must return "goto_url", not "goto-url". 2007-04-15 02:19:49 +03:00
Kalle Olavi Niemitalo
f76f49345e Updated Lua scripting document.
Use the http: AsciiDoc macro instead of link:http:.
Identify the supported version of Lua.  Mention the related bug 742.
"Help | About" nowadays groups scripting backends under "Scripting".
Document proxy_for_hook.
The enable_systems_functions function has been removed.
The setlocale function is nowadays called os.setlocale, and it does
affect the operation of ELinks.
The execute function does not return the exit code.
Document tmpname, edit_bookmark_dialog, xdialog, set_option, get_option.
Document elinks_home.

However, I did not update the example Lua scripts.
2007-04-15 01:27:08 +03:00
Kalle Olavi Niemitalo
13d00f8049 NEWS: Moved Tiny C Compiler advice to a separate file. 2007-04-14 16:53:25 +03:00
Laurent MONIN
b6b956ac8f Fix a typo. 2007-04-12 14:47:15 +02:00
Kalle Olavi Niemitalo
4aff50067c hacking.txt: Promote all headings one level.
"Hacking Elinks" is now a level-0 heading, so we get a <title> in the
generated HTML.
2007-04-04 10:00:16 +03:00
Kalle Olavi Niemitalo
3caec64c51 doc: Ctrl-Alt- keystrokes can be bound too. 2007-02-11 20:55:58 +02:00
Kalle Olavi Niemitalo
cd608eb03e Revive #lua-scripting and #ecmascript links in installation.html.
installation.html built from installation.txt does not include the
sections about LUA scripting and ECMAScript, but installation.txt
tries to link to them via fragment identifiers.  Point those links to
manual.html instead; not manual.html-chunked because the file names
there might not remain stable.

Alternatively, installation.txt could be changed to include
lua-scripting.txt and ecmascript.txt into installation.html.
2007-02-11 01:35:34 +02:00
M. Levinson
ec1bedc25e Python: Document more goto_url_hook and follow_url_hook return values.
Document what happens if goto_url_hook or follow_url_hook returns None or "".
doc/events.txt already explains the corresponding C values.

[ commit message by me --KON ]
2007-01-12 00:02:50 +02:00
Kalle Olavi Niemitalo
3bee1cbfc4 Regenerated manpages. 2007-01-06 23:46:35 +02:00
Kalle Olavi Niemitalo
9cae6a4fa4 update-man: Install manpages to srcdir, not builddir.
elinks.1.in, elinkskeys.5, and elinks.conf.5 are included in the Git tree,
so they are initially in the srcdir, and that's were the new versions must go.
2007-01-06 22:17:54 +02:00
Kalle Olavi Niemitalo
d73632d7de keys2doc: Change \"foo\" to "foo". 2007-01-06 21:38:29 +02:00
Kalle Olavi Niemitalo
8f030fcb63 Hack elinkskeys.5 with sed some more, to please ESR.
http://catb.org/~esr/doclifter/problems.html
2007-01-06 21:05:52 +02:00
M. Levinson
26473f72f5 Python: Give goto_url_hook only one argument, like follow_url_hook.
On Dec 31, 2006, at 11:30am, Kalle Olavi Niemitalo writes:
>src/scripting/python/hooks.c (script_hook_url) calls hooks as
>goto_url_hook(new-url, current-url) and follow_url_hook(new-url).
>It has a comment saying that the current-url parameter exists
>only for compatibility and that the script can instead use
>elinks.current_url().  However, the current-url parameter was
>added in commit 87e27b9b3e and is
>not in ELinks 0.11.2, so any compatibility problems would only
>hit people who have been using 0.12.GIT snapshots.  Can we remove
>the second parameter now before releasing ELinks 0.12pre1?

The decision isn't up to me, but I think this is a good idea. Here's a
patch that would update the documentation and hooks.py, as well as hooks.c.

FYI, if this patch is applied then anyone who's still trying to use a
goto_url_hook that expects a second argument will get a "Browser scripting
error" dialog box that says:

	An error occurred while running a Python script:

	TypeError: goto_url_hook() takes exactly 2 arguments (1 given)
2007-01-01 17:45:36 +02:00
Kalle Olavi Niemitalo
7b931a2de0 conf2doc: Backslashify --help, --enable, --disable to avoid &#8212;. 2006-12-27 19:41:04 +02:00
Kalle Olavi Niemitalo
eb7ac943ed doc: Backslashify dashes in long options to prevent &#8212;. 2006-12-27 19:14:57 +02:00
Kalle Olavi Niemitalo
b2aa89d7c3 doc: Fix some missing or incorrect letters. 2006-12-27 19:13:05 +02:00
Kalle Olavi Niemitalo
d62144b944 hacking.txt: spellings of UTF-8, utf8 2006-12-23 01:45:26 +02:00
Kalle Olavi Niemitalo
47a8be1b4d doc/perl.pod: Tweak the NAME section for pod2html.
This change avoids getting <title>No Title</title> in perl.html.
2006-12-17 16:54:50 +02:00
Kalle Olavi Niemitalo
5331789603 Remove cmd_installsrcdata.
cmd_installdata with $(srcdir) now does the same thing.
2006-12-17 16:25:12 +02:00
Jonas Fonseca
5edec55a86 Remove all traces of the horrid "API Doc" code documentation tool 2006-12-10 01:23:40 +01:00
M. Levinson
78bd416dc0 Bug 880: Prevent SIGSEGV in init_python when -no-home is used.
Before this patch, init_python would crash trying to set up elinks.home
at the Python side.  Now it uses None as the value in that case.
Also, init_python no longer adds "(null)" to $PYTHONPATH.
2006-12-08 19:59:41 +02:00
Kalle Olavi Niemitalo
f52d23c224 make install-doc installs doc/python.txt too. 2006-12-01 22:31:16 +02:00
Kalle Olavi Niemitalo
b3cbb0a915 Rename TXT_DOCS to TXT_DOCS_NOINSTALL.
By analogy with HTML_DOCS_NOINSTALL.
2006-12-01 21:38:06 +02:00
Kalle Olavi Niemitalo
b7a58b74f9 doc/Makefile: Don't install po/perl/ documentation. 2006-11-26 13:42:29 +02:00
Kalle Olavi Niemitalo
6299fb44e1 doc/Makefile: Move a semicolon outside ncmd invocation.
This apparently didn't cause any real problems, but the output of Make
looked suspicious.
2006-11-26 11:55:47 +02:00
M. Levinson
0c1ba7306f doc: Additional functionality for Python backend.
This should have been in commit ebadc9bf9e.
2006-11-26 11:37:51 +02:00
Kalle Olavi Niemitalo
df546f79a3 doc/release.txt: What to do to bugs fixed in the new version. 2006-11-25 19:37:04 +02:00
Jonas Fonseca
c9701c80af Add a releast check list 2006-11-21 01:50:04 +01:00
Miciah Dashiel Butler Masters
3c7354b135 Correct documentation for follow-url and goto-url
Synchronise the phrasing and mention in both that either NULL or an
empty, dynamically allocated string indicates that no URL should be loaded.
2006-11-14 00:24:20 +00:00
Jonas Fonseca
89fd7efa3a Fix misparsing of -remote URLs containing parenthesis (bug 830)
Be more strict about the format accepted by the ELinks specific extension
to the -remote URL syntax. That is, commands must begin with a nonempty
sequence of ASCII alphabetic characters followed by optional whitespace and
an opening parenthesis. Also, document the syntax.

Fixes bug 830.
2006-11-12 18:49:05 +01:00
Kalle Olavi Niemitalo
7809efa1b5 Names of enum constants should be in upper case.
Requested by Miciah.
2006-11-12 14:51:18 +02:00
Kalle Olavi Niemitalo
c33d195ff4 Garbage-collect SMJS objects before flushing caches. 2006-09-25 23:43:32 +03:00
Kalle Olavi Niemitalo
7a1644c252 List "Triggered When" before "Arguments" in the event template.
That's the order in all existing event descriptions.
2006-09-25 22:58:38 +03:00
Kalle Olavi Niemitalo
538e8eb8a5 List events in alphabetical order. 2006-09-25 22:46:48 +03:00
Miciah Dashiel Butler Masters
2962e29f2e Update SpiderMonkey instructions to reflect current features summary 2006-07-06 17:34:52 +00:00
Miciah Dashiel Butler Masters
6028813aad Rewrite the Debian SpiderMonkey installation instructions
Per cga2000's suggestions on the mailing list (Message-id:
<20060706034618.GA9392@turki.gavron.org>).
2006-07-06 17:32:50 +00:00
Miciah Dashiel Butler Masters
4623e55fe8 Update ECMAScript instructions for Debian Sarge 2006-07-06 02:03:47 +00:00
Miciah Dashiel Butler Masters
3b22a65ba9 Clarify the installation instructions for SpiderMonkey on Debian
State explicitely that if one installs SpiderMonkey via apt-get, then one
needn't also build it manually.
2006-07-05 17:24:21 +00:00
Laurent MONIN
7e6c98dadf Add a note about ld.so.conf and /usr/local/lib as suggested by cga on ml. 2006-07-05 18:43:26 +02:00
Jonas Fonseca
5f4f4f770b Sync man pages 2006-06-12 22:30:42 +02:00
Kalle Olavi Niemitalo
513cade0ff doc: Fixed a quote in AsciiDoc markup. 2006-05-14 22:22:37 +03:00
Kalle Olavi Niemitalo
5c2dfc72cf doc: Minor fixes wrt accel-check.
doc/hacking.txt: Point to the ELinks-specific po/perl/README, rather
than to the generic po/perl/check-accelerator-conflicts.pl.

po/perl/README: Removed a spurious preposition.
2006-05-13 16:47:39 +03:00
Kalle Olavi Niemitalo
daaed3912b doc: Always refer to elinks.cz rather than elinks.or.cz. 2006-04-27 00:13:33 +03:00
Kalle Olavi Niemitalo
a19f271a8b doc: CVS is no longer used. Mention static accel checking. 2006-04-27 00:09:23 +03:00
Kalle Olavi Niemitalo
c3f5c34dd3 doc: More AsciiDoc compatibility. 2006-04-27 00:08:22 +03:00
Kalle Olavi Niemitalo
ff3a1be247 doc: Misc spelling and AsciiDoc compatibility fixes.
This part of dev-intro.txt doesn't work on AsciiDoc 7.1.2:

.Overview of the hierarchy of the various subsystems. At the bottom are \
 subsystems that provide functionality used by the upper layers.

AsciiDoc treats only the first line as the title and includes the
backslash in the XHTML output.  It looks like the only way to fix
dev-intro.txt is to merge the lines into one, but this would both make
the source ugly and somehow generate "Example:" at the beginning of
the title.  Because doc/Makefile does not currently run AsciiDoc on
dev-intro.txt, I'm leaving this part unchanged.
2006-04-23 20:29:58 +03:00
Jonas Fonseca
b772b12847 Build HTML versions of scripts in po/perl 2006-02-19 01:27:31 +01:00
Jonas Fonseca
3fc0eb3884 DOC: Sync with current option tree, propagate zas' fix for hooks file list 2006-01-31 15:18:34 +01:00
Jonas Fonseca
c18740b30d Revert FreeBSD sed changes; they don't work for GNU sed 2006-01-27 02:52:44 +01:00
Jonas Fonseca
c4d22f9c24 Fix shell scripts to work better with FreeBSD's sed 2006-01-27 02:32:48 +01:00
Jonas Fonseca
20baf3b207 Newer versions of AsciiDoc (7.0.5 atleast) needs to be passed --unsafe
Detect this in configure and set ASCIIDOC_FLAGS accordingly.
2006-01-27 02:32:06 +01:00
Jonas Fonseca
3824ea99a7 Mention API docs, and how to build them 2006-01-27 01:06:59 +01:00
Jonas Fonseca
44074061fa Make the link to the old manual 'accessible' in the HTML versions 2006-01-19 04:33:07 +01:00
Jonas Fonseca
ed73a5c9b3 Make code2doc use the buildsystem echoing 2006-01-17 16:50:15 +01:00
Jonas Fonseca
a892c84601 Make it possible to build all-docs when $(builddir) != $(srcdir) 2006-01-16 00:21:05 +01:00
Jonas Fonseca
2748d043f9 Autogenerate .vimrc files and put the master in config/vimrc
This changes the init target to be idempotent: most importantly it will now
never overwrite a Makefile if it exists. Additionally 'make init' will
generate the .vimrc files. Yay, no more stupid 'added fairies' commits! ;)
2006-01-15 18:38:58 +01:00
Jonas Fonseca
2a4afa22b1 Minor simplification 2006-01-15 18:06:44 +01:00
Laurent MONIN
fb7e6e4f74 Fix hooks files list. 2006-01-15 10:13:43 +01:00
Jonas Fonseca
f4735aa32e Big update, mentioning BitTorrent, mailcap and hooks files, etc. 2006-01-14 22:35:08 +01:00
Jonas Fonseca
8aa32ea153 Replace --'s so they do not get translated to &#8212; 2006-01-14 19:47:47 +01:00
Jonas Fonseca
6e79a24679 Add an empty line before titles in keymap-*.txt; fixes elinkskeys.5.html 2006-01-14 19:45:40 +01:00
Jonas Fonseca
66e9ae4957 Escape {}'s so that AsciiDoc does the right thing; fixes elinks.conf(5) 2006-01-14 19:43:58 +01:00
Jonas Fonseca
c992a0860c Sound of silence 2006-01-14 19:40:29 +01:00
Jonas Fonseca
01b9ba0983 Fix keymap-%.txt building; move FIXME about prefixes to elinkskeys.5.txt 2006-01-14 19:24:46 +01:00
Jonas Fonseca
97fe1db841 Minor Makefile fixes 2006-01-14 10:59:58 +01:00
Jonas Fonseca
a37d5acb39 Update to the new names of generated txt files 2006-01-14 08:02:30 +01:00
Jonas Fonseca
fabd3df984 mv import-features.conf conf2doc; mv make-elinkskeys-manpage keys2doc 2006-01-13 12:58:47 +01:00
Jonas Fonseca
57e7bafa83 Shortly mention install-doc in the README 2006-01-13 12:55:36 +01:00
Jonas Fonseca
54e980abe4 Make install-doc depend on update-man to get the newest 2006-01-13 12:48:37 +01:00
Jonas Fonseca
b8301917ec Add install-doc rule 2006-01-13 12:42:14 +01:00
Jonas Fonseca
75bf42bfe0 Simplify further; only list generated files; move things around; comment 2006-01-13 12:17:03 +01:00
Jonas Fonseca
63f4a15d91 Add ending punctuation for one-liners; fix missing ending ';' 2006-01-13 12:14:05 +01:00
Jonas Fonseca
bcdd3fafca Output only to stdout instead of creating files directly 2006-01-13 12:02:26 +01:00
Jonas Fonseca
686166d5e6 Various api doc related fixes and cleanups 2006-01-13 08:09:06 +01:00
Jonas Fonseca
fd1c3510f5 Improve rebuilding using asciidoc by using files in .deps/ 2006-01-12 11:59:11 +01:00
Jonas Fonseca
a7397ea328 Use man:[] macro for all manpage references 2006-01-12 11:34:56 +01:00
Jonas Fonseca
d72f160a8a Drop relic from index.txt 2006-01-12 11:18:20 +01:00
Jonas Fonseca
1d35855d7d Minor fixes 2006-01-12 11:08:18 +01:00
Jonas Fonseca
9eb040401a Fix squote hack; redo elinks.conf(5) to get the description 2006-01-12 10:48:48 +01:00
Jonas Fonseca
a1bc5164e2 Regenerate all man pages 2006-01-12 10:30:55 +01:00
Jonas Fonseca
0e57735284 Add description header to be used for the man hack 2006-01-12 10:30:25 +01:00
Jonas Fonseca
aef863da96 Various minor improvements 2006-01-12 10:29:05 +01:00
Jonas Fonseca
aa7d65fb79 Make elinks.conf(5) also be build from .txt files
This simplifies help2doc since it now just have to do one single thing with
output of either --config-help or --long-help. The new manpage is not as
fancy wrt. indentation and sub titles but it is more uniform and we get a
HTML version.

Generate options-{config,command}.txt with help2doc. Only conditionally
check for API header files, to speed up execusion.
2006-01-12 08:33:50 +01:00
Jonas Fonseca
428783704a Enhance docbook man:[] macro with stuff from git's gitlink:[] macro 2006-01-12 07:32:25 +01:00
Jonas Fonseca
32bd0f6cd3 A few fixes 2006-01-12 05:44:16 +01:00
Jonas Fonseca
2ed9e26ebe Fix to generate listings correctly for docbook backend 2006-01-12 05:36:24 +01:00
Jonas Fonseca
877c5fc1ba Center some dialog examples 2006-01-12 04:49:50 +01:00
Jonas Fonseca
42b4ff43ae Retire index.txt
Put the remaining parts which didn't already get reused into manual.txt
and base a largely rewritten README on the file listing TOC.
2006-01-12 04:49:23 +01:00
Jonas Fonseca
cae0d9d8a6 Add some more comments 2006-01-12 03:16:37 +01:00
Jonas Fonseca
247b3c4623 Don't masq calls 2006-01-11 11:12:03 +01:00
Jonas Fonseca
ba6221c6f6 Redo the whole doc/ build thing
You can now use: make {all-docs,pdf,html,man,api,update-man}
     instead of: make {all-docs,pdf-docs,html-docs,man-docs}

Away is building into separate dirs. This makes make able to actually get
dependencies right, since there are now a collection of 'common' build
rules, some of which have even been moved to use the cmd infrastructure.

To update the man pages there is a new update-man rule. It builds the
manual pages and copies them to their proper place under man/ while doing
the final preformatting.

As good thing is that the (two) man pages are moved to .txt files and
include the generated content.

The API building thing is also refined. It builds into api/ and builds it's
list of files dynamically by searching throught the .h files in the src/
directory. Documented header files must contain a comment like this:

	/* API Doc :: <api-name> */

where <api-name> is the name used for the file under api/, for example
dom-scanner.
2006-01-11 11:02:43 +01:00
Jonas Fonseca
fe7c2391d6 Fix typo 2006-01-11 10:31:39 +01:00
Laurent MONIN
c4ab3629f0 Add a note about mode_t and S_I???? macros. 2006-01-11 00:11:39 +01:00
Laurent MONIN
7af11c507f More dependencies. 2006-01-10 22:18:03 +01:00
Laurent MONIN
1ac97927b5 Make $(MAN_DIR)/man5/elinkskeys.5 target depends on $(HELP2DOC) and
Makefile.
2006-01-10 22:11:14 +01:00
Laurent MONIN
e833c444f5 Remove obsolete elinksmanual(1) link. 2006-01-10 22:10:37 +01:00
Jonas Fonseca
4f20c950b5 Remove useless FAQ entry 2006-01-10 18:55:06 +01:00
Jonas Fonseca
6bd67a6f09 Preprocess elinks.1.in and elinkskeys.5 to add title and date fields
Regenerate all man pages.
2006-01-10 17:09:02 +01:00
Laurent MONIN
06dd1e2e06 Use date -I for man page date, suggested by lindi. 2006-01-10 16:15:32 +01:00
Laurent MONIN
3d837406d6 print_elinksconf_header(): fix quotes and backslashes
escaping. elinks.conf.5 was badly formatted.
2006-01-10 00:45:06 +01:00
Laurent MONIN
6b19a4fe1f Enforce locales env vars to be sure elinks generate english texts,
even on systems using non-english locales.
2006-01-09 23:51:29 +01:00
Jonas Fonseca
d657060b74 Build html/api/dom.html 2006-01-09 22:48:09 +01:00
Jonas Fonseca
0e5853cae7 More perl snacks; added macro:[] for #define'd values; api dom/scanner.h 2006-01-09 14:06:47 +01:00
Jonas Fonseca
d7edca09c3 More perl snacks 2006-01-09 12:46:13 +01:00
Jonas Fonseca
2206f560c6 Build a DOM api from the two doctised header files 2006-01-09 12:45:50 +01:00
Jonas Fonseca
938c8a80b4 Support more implicit markup of source files 2006-01-09 11:01:36 +01:00
Jonas Fonseca
9799a66710 Code2doc v2.0 2006-01-09 08:25:03 +01:00
Jonas Fonseca
9699396658 Match against comment end once 2006-01-09 06:49:15 +01:00
Jonas Fonseca
9e23ea9eeb Replace $first with $indent to get uniform indentation and simplify 2006-01-09 06:24:00 +01:00
Jonas Fonseca
cab1380031 Obsolete $start and $gotone; tune newlines; simply line matching 2006-01-09 05:30:59 +01:00
Jonas Fonseca
41fe69f86e Handle one-liners with '/*:: ... */' upfront 2006-01-09 05:03:07 +01:00
Jonas Fonseca
4e8abf55ec Cleanup; use Getopt::Std; Loop multiple files from cmdline with <> 2006-01-09 04:49:26 +01:00
Jonas Fonseca
2d7356d29a Improve support for struct documentation by saving the struct name
This makes it easy to create

id:[$struct$member]::
	One line description
2006-01-09 00:53:41 +01:00
Jonas Fonseca
a7fb4a71e3 Insert missing ':' after 'id', use tab for indentation 2006-01-09 00:01:09 +01:00
Jonas Fonseca
4aa57ffc59 Add asciidoc configuration file for output of code2doc 2006-01-09 00:00:10 +01:00
Jonas Fonseca
7acb3059a8 Make code2doc print to stdout 2006-01-08 23:57:14 +01:00