derive doc from doc/socat.yo

This commit is contained in:
Gerhard Rieger 2008-01-28 20:33:15 +01:00
parent b819572f5e
commit 2b3afcf425
5 changed files with 27 additions and 5564 deletions

View file

@ -1,4 +1,7 @@
new features:
docu source doc/socat.yo released
####################### V 1.6.0.0: ####################### V 1.6.0.0:
new features: new features:

View file

@ -81,7 +81,18 @@ OSFILES = Config/Makefile.Linux-2-6-16 Config/config.Linux-2-6-16.h \
Config/Makefile.Tru64-5-1B Config/config.Tru64-5-1B.h Config/Makefile.Tru64-5-1B Config/config.Tru64-5-1B.h
all: progs all: progs doc
doc: doc/socat.1 doc/socat.html
docclean:
rm -f doc/socat.1 doc/socat.html
doc/socat.1: doc/socat.yo
yodl2man -o $@ $+
doc/socat.html: doc/socat.yo
yodl2html -o $@ $+
progs: $(PROGS) progs: $(PROGS)

12
README
View file

@ -225,6 +225,18 @@ doc/socat-multicast.html is a short tutorial for multicast and broadcast
communications. communications.
doc/socat-tun shows how to build a virtual network between two hosts. doc/socat-tun shows how to build a virtual network between two hosts.
socat.1 and socat.html can be generated from socat.yo (which is released with
socat 1.6.1 and later) using the yodl document language package. Maintenance
of yodl had been discontinued by its author
(http://www.xs4all.nl/~jantien/yodl/) (there seems to be a revival at
http://yodl.sourceforge.net/ though). For socat, the old version 1.31 is used;
an rpm is still distributed with recent OpenSuSE versions (confirmed for
OpenSuSE 10.1 in suse/i586/yodl-1.31.18-1142.i586.rpm). It appears to install
smoothly also under RedHat Linux. After yodl 1.31 installation, the following
correction must be performed in /usr/share/yodl/shared.yo in two places:
< whenhtml(htmlcommand(<!)ARG1+htmlcommand(>)))
> whenhtml(htmlcommand(<!--)ARG1+htmlcommand(-->)))
license license
------- -------

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff