You can find the latest release of
This document, written in SGML, can be available in several formats: ASCII TeX SGML PostScript HTML HTM PDF Info LyX Man
The software linuxdoc-make is a bunch of directories, a Makefile, and SGML examples, bundled to create several output formats with just one make command. As a bullet proof, this site part has been generated with linuxdoc-make.
Installation is easy since you just have to unpack the tarball where you want to build your documentation. But to create the documentation you need some tools. They are in section "Prerequisites".
You need some freely available softwares: All can be found from freshmeat
You need to know how to write SGML files with the linuxdoc DTD.
you can download linuxdoc-make via the ftp protocol at http://www.linux-france.org/prj/linuxdoc-make/00_dist/
The archive is named linuxdoc-make-0.13.tgz where 0.13 is the version number.
You do not have to be root to install linuxdoc-make. You install linuxdoc-make where you want to use it.
gzip -tv linuxdoc-make-0.13.tgz # optional cd where/you/want/ tar tzvf linuxdoc-make-0.13.tgz # see the content tar xzvf xzvf linuxdoc-make-0.13.tgz # extract cd linuxdoc-make-0.13 make # and read because "make" alone is just a reminder ...
You can rename the
like you want at any time. Using
make without argument is safe
since it gives you the usage (alias
If you write an non-english document (english is the default language),
you must end its name with
ll is the
two characters symbolizing your language.
- en: english,english,
- de: deutsch,german,
- nl: nederlands,dutch,
- fr: français,french,
- es: español,spanish,
- da: dansk,danish,
- no: norsk,norwegian,
- se: svenska,swedish,
- pt: portuges,portuguese,
- ca: català,catalan,
- it: italiano,italian,
- ro: românã,romanian
Create a new file with the model.
cd linuxdoc-make-0.13/ # if you're not already there cp sgml/lidoma-model.en.sgml sgml/myfile.en.sgml
Edit your file
sgml/myfile.en.sgml (emacs is good at it). Save
Generate a HTML single page:
Look at the directory htm/
ls -l htm/ myfile.en.htm
View myfile-en.htm with your favorite web browser (lynx, isn't it?).
Try other output formats:
make make txt html ps pdf
If you want a clone directory of all the needed files, just type:
then move the clone/ directory where you want.
First, if there is a file named
.index.m4 in any directory,
then this file will be processed with m4 to create an index file named
Second, if there is no file named
.index.m4 then an nice
ls command will create an index file named
in each directory.
make indexes make i # same thing (I am lazy) make if # force mode
Some treatments use m4. All definitions are from the file
include/definitions.m4 and the files it includes. The best
way to change any definition is to edit the file named
include/override.m4 and modify the values.
Happy doc !