Ensure that the generator gets notified about an I/O error for the dir
[rsync.git] / doc / README-SGML
1 Handling the rsync SGML documentation
2
3 rsync documentation is now primarily in Docbook format.  Docbook is an
4 SGML/XML documentation format that is becoming standard on free
5 operating systems.  It's also used for Samba documentation.
6
7 The SGML files are source code that can be translated into various
8 useful output formats, primarily PDF, HTML, Postscript and plain text.  
9
10 To do this transformation on Debian, you should install the
11 docbook-utils package.  Having done that, you can say 
12
13   docbook2pdf rsync.sgml
14
15 and so on.
16
17 On other systems you probably need James Clark's "sp" and "JadeTeX"
18 packages.  Work it out for yourself and send a note to the mailing
19 list.
20