1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-06-24 00:56:14 +00:00
Commit Graph

310 Commits

Author SHA1 Message Date
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
Jonas Fonseca
ac73ccce42 Merge with git+ssh://pasky/srv/git/elinks.git 2006-01-08 23:46:06 +01:00
Jonas Fonseca
61efbc4c9a First attempt to build html/api docs
It only does src/dom/sgml/parser.h for now.
2006-01-08 23:44:59 +01:00
Russ Rowan
0eef02b8f3 Handle: SGML_PARSER_CODE_OK = 1, /**: The parsing was successful */ 2006-01-08 17:42:04 -05:00
Jonas Fonseca
b70133760f Make *-docs depend on doc-dirs; beware if you build individual files 2006-01-08 23:15:47 +01:00
Russ Rowan
0f8f5b0635 Undo last change and left align enums. 2006-01-08 16:57:10 -05:00
Russ Rowan
b2cbbf1139 Don't left align enums. 2006-01-08 16:46:46 -05:00
Jonas Fonseca
65c007d326 Merge with git+ssh://pasky/srv/git/elinks.git 2006-01-08 22:36:18 +01:00
Jonas Fonseca
15cd8c8d2c Simplify dependency on doc-dirs by making MAKECMDGOALS depend on it 2006-01-08 22:33:26 +01:00
Russ Rowan
e15c9d4611 Minor code optimization. 2006-01-08 16:20:46 -05:00
Jonas Fonseca
905aa95a6e Simplify some more 2006-01-08 21:57:55 +01:00
Russ Rowan
f451e89286 Merge with git+ssh://pasky.or.cz/srv/git/elinks.git 2006-01-08 15:54:29 -05:00
Russ Rowan
4fe54a9d68 Added another blank line between each block and one between each id:[*]::
line for readability.
2006-01-08 15:54:00 -05:00
Jonas Fonseca
877ed348be Simplify the doc Makefile tremendously 2006-01-08 21:46:21 +01:00
Russ Rowan
97b0635d1e Don't underline leading comment lines that contain ::. 2006-01-08 15:37:03 -05:00
Jonas Fonseca
3529b35da0 Sneak in an extra newline after section headers 2006-01-08 20:02:31 +01:00
Russ Rowan
33f373fbd5 Get rid of extraneous spaces left in the output. I have no idea if
asciidoc is sensitive enough to fail on these.
2006-01-08 13:05:11 -05:00
Russ Rowan
92be45d1be Don't remove all blank lines. Just the first of a comment block. 2006-01-08 12:56:15 -05:00
Russ Rowan
67a89e1454 Added a document helper script: code2doc. It's ugly and mean, but it gets
the job done.
2006-01-08 05:15:08 -05:00
Jonas Fonseca
7d4b2ee5ed Do a much needed update of the man pages 2006-01-03 15:18:49 +01:00
Jonas Fonseca
e2a79aeacb Fix parsing by filtering the header outputed by ELinks
Also improve matching of option 'titles'.
2006-01-03 15:17:23 +01:00
Jonas Fonseca
0a844e6534 Drop useless comment block now that CVS Id tags are gone
... also drop comment about hacking.txt being extended gradually. AsciiDoc
burps on it and it really is kind of a boot message.
2006-01-03 14:28:26 +01:00
Jonas Fonseca
748bab64a7 Make the printed install paths simpler for man5 files when srcdir == builddir 2005-12-30 00:49:01 +01:00
Miciah Dashiel Butler Masters
97b71aa868 Document that pre-format-html hooks are given a session pointer. 2005-12-17 16:01:15 +00:00
Miciah Dashiel Butler Masters
fdacffd113 Change the pre-format event so that hooks are given the cache entry
instead of the URI, content, and length of the entry. Change the hooks
to use add_fragment. This should fix the memory leakage when multiple
hooks change the same document, closing bug 703.
2005-12-17 06:32:08 +00:00
Russ Rowan
42f715f90f Clean up 'make clean'. 2005-12-15 04:04:26 -05:00
Kalle Olavi Niemitalo
7c823e49c4 Fix elinks.1 rebuilding by changing top_srcdir with top_builddir 2005-12-06 12:21:50 +01:00
Jonas Fonseca
6815be6964 Document the infoBox() command 2005-11-15 17:40:38 +01:00
Laurent MONIN
df065ead80 Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
Jonas Fonseca
c88afeb1c2 path_to_top -> top_builddir 2005-10-20 04:00:35 +02:00
Jonas Fonseca
db99a74777 Add support for out-of-tree builds
Involves prefixing with $(srcdir) to some of the build rule variables. For
the builddir we create Makefiles which simply include the srcdir Makefile.
Add list make rule to get list of Makefiles to generate (find will get it
wrong for builddirs nested in srcdir).

There are still a few minor issues like the file paths echoed during make
install ...
2005-10-20 03:49:40 +02:00
Jonas Fonseca
b2b2012386 Always address configure.in and other autotools file with $(top_srcdir) 2005-10-20 01:14:53 +02:00
Jonas Fonseca
e39a4342d6 Include $(top_srcdir)/Makefile.lib instead of $(path_to_top)/Makefile.lib
A step towards out of tree builds ...
2005-10-20 01:11:47 +02:00
Jonas Fonseca
c517dbf101 elinkskeys(5): Improve the listing of actions and default keybindings
Display them in a table for the HTML version.
2005-10-04 00:53:03 +02:00
Jonas Fonseca
279f33e985 Fix subsubsection
Thou shall always underline _all_ characters in the title.
2005-10-03 22:05:49 +02:00
Jonas Fonseca
ea510b0863 Add a little documentation about the BitTorrent client
It is basically the Chapter 6: User Manual from
http://www.nitro.dk/~jonas/elinks/modules/bittorrent/main.{pdf,ps.gz}

Patch by Lilja, Basim and me.
2005-10-03 21:56:27 +02:00
Jonas Fonseca
ec8e13295f Make the elinks.1 rebuilding more similar to automakes 2005-10-03 00:52:19 +02:00
Jonas Fonseca
cd103aa5bf Build elinks.1 from elinks.1.in
This is needed after running 'make man-docs' in doc/.
2005-10-03 00:00:58 +02:00
Jonas Fonseca
123b71ab49 Sync with current cmd option tree 2005-10-02 20:33:35 +02:00
Jonas Fonseca
daaf61331a Make installation also use the cmd calling
Makes it more obvious which files are actually installed. MKINSTALLDIRS
still spurs out a lot of 'mkdir ...', which probably should also be
silenced when V=0.
2005-10-01 14:16:19 +02:00
Jonas Fonseca
14f6c0ebf5 Always create the directory path before installing (using mkinstalldirs) 2005-09-28 21:43:09 +02:00
Jonas Fonseca
b30064c0d0 Rename targets: *-l -> *-local 2005-09-27 21:11:28 +02:00
Jonas Fonseca
249fac4345 Tune the clean-l usage
- Fix the doc/ clean target which was called clean-local
 - Consistently use $(RM)
 - Introduce CLEAN variable to make it simpler to costumize local cleaning
2005-09-27 18:27:17 +02:00
Jonas Fonseca
49a6d7cf8d Revive doc/.gitignore 2005-09-23 15:08:02 +02:00
Jonas Fonseca
7446adecd5 Remove *.tmp files created by pod2html 2005-09-23 15:07:40 +02:00
Russ Rowan
7d5d63bb29 Several minor grammar and spelling corrections. Mainly to test that I have
GIT_COMMITTER_NAME set properly.
2005-09-22 08:07:01 -04:00
Russ Rowan
efc2d3b235 Correct installation of man5 manpages. 2005-09-22 07:27:25 -04:00
Jonas Fonseca
655ff2c6b3 Remove the stupid CVS docs retrieving script
The docs are available in the generated tarballs, and GIT doesn't support
modules.
2005-09-18 18:52:00 +02:00
Jonas Fonseca
baadeebab1 More CVS -> GIT conversions
Update INSTALL to both 'cover' GIT checkouts and requirements for the new
build system. Hacking info no more advices to add CVS Id lines.
2005-09-18 18:47:20 +02:00
Petr Baudis
e52144349d Don't install elinks.1 from srcdir since it's autogenerated. 2005-09-17 20:44:50 +02:00
Petr Baudis
871c2dab3a Try to fix installation when built out-of-tree. 2005-09-17 20:37:32 +02:00
Petr Baudis
a87d775eeb Merge with git+ssh://pasky.or.cz/srv/git/elinks.git 2005-09-17 08:45:23 +02:00
Petr Baudis
a529ed444b A feeble attempt to fix the atrocious grammar in doc/README. 2005-09-17 03:16:24 +02:00
Petr Baudis
13ce7f6f81 Converted doc/ to ELBuild 2005-09-16 04:38:48 +02:00
Petr Baudis
204bbe5d2c Fix starting a build from a subdirectory ELBuild-wise
Now all the submakefiles contain informationa buot where in the directory
hierarchy they stay.
2005-09-16 02:07:36 +02:00
Petr Baudis
32fe41fae7 ELBuild: Use 'include' instead of '-include'
We _do_ want to error on when including .config and .lib failed.
2005-09-16 01:09:42 +02:00
Petr Baudis
fffc573769 Use all-l,install-l,clean-l targets in individual makefiles and let
Makefile.lib multiplex the real ones. That's so that the -recursive
ones always come first.
2005-09-16 00:52:54 +02:00
Petr Baudis
6aea3df7ac Switch doc/man over to the new build system 2005-09-15 23:26:40 +02:00
Jonas Fonseca
7462f22635 Remove now obsolete .cvsignore files. 2005-09-15 18:33:20 +02:00
Jonas Fonseca
da11cf325a Convert more bits from the .cvsignore files. Now cg-status doesn't list
anything here. It might do in the future.
2005-09-15 18:25:37 +02:00
Petr Baudis
0f6d4310ad Initial commit of the HEAD branch of the ELinks CVS repository, as of
Thu Sep 15 15:57:07 CEST 2005. The previous history can be added to this
by grafting.
2005-09-15 15:58:31 +02:00