1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
Commit Graph

211 Commits

Author SHA1 Message Date
Kalle Olavi Niemitalo
34bdddbd87 Regenerated manpages using help2xml 2008-05-03 20:37:44 +03:00
Kalle Olavi Niemitalo
573036a403 Generate DocBook and XHTML with help2xml.
The older help2doc script is no longer used for anything.

To make future cherry-picking easier, this commit does not include the
resulting changes in generated files.
2008-05-03 20:28:45 +03:00
Kalle Olavi Niemitalo
604b99d5a4 help2xml: New script.
The intention is to convert --config-help and --long-help outputs to
DocBook XML and XHTML rather than AsciiDoc, so that the converter does
not have to work around the intricate AsciiDoc syntax.  However, this
commit does not yet connect the script to doc/Makefile.

XHTML could be generated from DocBook XML, but the script outputs it
directly because our DocBook is primarily intended for manual pages
and so does not have all the links that are useful in HTML.
2008-05-03 20:27:47 +03:00
Kalle Olavi Niemitalo
f30583d605 Do not .gitignore doc/man/man5/*.5, which are already in Git. 2008-05-03 20:27:16 +03:00
Kalle Olavi Niemitalo
4b408dd860 Display subtrees last in --config-help.
elinks --config-help used to sort options like this:

  document.history
  document.history.global
    document.history.global.enable
    document.history.global.max_items
    document.history.global.display_type
    document.history.keep_unhistory

Now it'll instead be:

  document.history
    document.history.keep_unhistory
  document.history.global
    document.history.global.enable
    document.history.global.max_items
    document.history.global.display_type

i.e. all the options listed under a subheading are children of the
tree named by it.  This makes elinks.conf(5) look saner.
2008-03-23 19:20:12 +02:00
Kalle Olavi Niemitalo
9bd5b23ee5 Doxyfile.in: Use @VERSION@.
doc/release.txt need not be changed now, because it already did not
mention updating the version number in Doxyfile.in.
2008-03-11 10:54:54 +02:00
Jonas Fonseca
7bdeb3188e When releasing po files should also be updated 2008-03-08 20:15:38 +01:00
Kalle Olavi Niemitalo
0efc9772f9 make update-man, with AsciiDoc 8.2.2 and DocBook XSL 1.72.0 2008-03-08 16:19:28 +02:00
Kalle Olavi Niemitalo
5fcf175963 help2doc: rewrite in Perl
This version takes about 1/300 of the time of the shell version
and fixes several errors in the output, most importantly that
option descriptions were being truncated at the first empty line.

Because help2doc is run only from make update-man, and the distributed
tarballs include prebuilt man pages, people building ELinks need not
have Perl installed.
2008-03-08 14:51:25 +02:00
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
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
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
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
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
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
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