Merge branch 'master' of git://git.samba.org/samba
[kai/samba.git] / docs-xml / build / README
1 HOW TO BUILD SAMBA DOCUMENTATION WITHOUT NETWORK ACCESS
2 -------------------------------------------------------
3
4 Samba documentation depends on several DTD schema specification and XML files
5 that are stored in samba-web Subversion repository and hosted publicly through
6 Samba.org web-site. In order to do networkless builds a local XML catalog should
7 provide a local replica of those files.
8
9 The easiest way to provide them is to fetch samba-docs subversion repository.
10 In this directory (build/) we reference samba-web repository as external source
11 so that Subversion fetches current state of DTDs out of samba-web repository.
12 You then need to point xsltproc utility to use locally-provided version of DTDs.
13
14 It is done by setting XML_CATALOG_FILES variable:
15
16 export XML_CATALOG_FILES="file:///etc/xml/catalog file://$(pwd)/build/catalog.xml"
17
18 where $(pwd)/build/catalog.xml is generated from $(pwd)/build/catalog.xml.in by a 
19 following command:
20
21 cat $(pwd)/build/catalog.xml.in | sed -e "s|@BUILDDIR@|$(pwd)|g" > $(pwd)/build/catalog.xml
22
23 where $(pwd) assumes that you're in the top-level directory of samba-docs.
24
25 After those steps a regular make process can be followed and xsltproc will automatically
26 use locally-provided DTDs through catalog.xml we've created.