1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-24 21:34:56 +03:00
samba-mirror/docs-xml
Andreas Schneider b6576686f9 docs: Move idmap manpage to there old location.
This wasn't planned and slipped trough, sorry.

Autobuild-User(master): Andreas Schneider <asn@cryptomilk.org>
Autobuild-Date(master): Tue Sep 11 14:28:53 CEST 2012 on sn-devel-104
2012-09-11 14:28:52 +02:00
..
archives s3/docs: Fix several typos. 2009-02-20 09:20:16 +01:00
build Fix bug #8831 - Inconsistent (with manpage) command-line switch for "help" in smbtree 2012-03-30 22:59:53 +02:00
manpages docs: Move idmap manpage to there old location. 2012-09-11 14:28:52 +02:00
registry docs: Fix Bug 6922: Add Registry patchfile for Win7 domain join. 2009-11-24 11:38:14 +01:00
Samba3-ByExample doc: Remove documentation for obsolete ldapsam_compat. 2012-07-03 21:56:49 +02:00
Samba3-Developers-Guide s3-docs: Fix several typos. 2012-05-08 13:56:32 +02:00
Samba3-HOWTO docs: Rename manpages-3 -> manpages. 2012-09-03 23:35:37 +02:00
scripts docs: Fix undocumented target to find smb.conf directives in the right place 2012-09-04 09:31:49 +10:00
smbdotconf docs: describe the new parameter "durable handles" in the smb.conf manpage 2012-09-10 01:06:54 +02:00
templates Moving docs tree to docs-xml to make room for generated docs in the release tarball. 2008-04-23 08:47:48 -05:00
test Move test image to test/images/, consistent with the other books. 2009-05-01 22:49:10 +02:00
using_samba doc: Remove references to deprecated 'share modes' parameter. 2012-07-03 23:49:18 +02:00
xslt Revert "Remove XSLT script to generate image dependencies, instead rely on make" 2012-07-16 16:18:46 +02:00
.gitignore Ignore intermediary documentation files in git 2008-04-24 23:41:35 +04:00
aclocal.m4 Fix 'make undocumented' (by hardcoding the source path, now that the docs 2009-05-01 13:10:13 +02:00
configure.ac docs: Rename htmlman3 -> htmlman. 2012-09-10 14:19:42 +02:00
gpl-3.0.xml Moving docs tree to docs-xml to make room for generated docs in the release tarball. 2008-04-23 08:47:48 -05:00
htmldocs.html docs: Fix TOC of generated HTML docs. 2008-12-17 09:17:26 +01:00
Makefile docs:build: make target "manpages" .PHONY, so manpages do get built... 2012-09-10 17:55:20 +02:00
Makefile.settings.in docs: Fix undocumented target to find smb.conf directives in the right place 2012-09-04 09:31:49 +10:00
README Trim the requirements for building the docs, remove outdated instructions 2009-05-01 22:49:10 +02:00
Samba-EventLog-HOWTO.txt Moving docs tree to docs-xml to make room for generated docs in the release tarball. 2008-04-23 08:47:48 -05:00
Samba.desktop Moving docs tree to docs-xml to make room for generated docs in the release tarball. 2008-04-23 08:47:48 -05:00
structure.svg Moving docs tree to docs-xml to make room for generated docs in the release tarball. 2008-04-23 08:47:48 -05:00
wscript_build waf: Fix bug #8801 - build s3fs manpages. 2012-09-07 12:30:08 +02:00

!==
!== docbook.txt for Samba 3.0
!==
!== Author:	David Bannon, D.Bannon@latrobe.edu.au  November, 2000
!== Updates:	Gerald (Jerry) Carter, jerry@samba.org, Feb. 2001
!== Updates:	Jelmer Vernooij, jelmer@samba.org,		Aug, 2002
!== Updates:	Jelmer Vernooij, jelmer@samba.org,		Jun, 2003
!== Updates: 	Jelmer Vernooij, jelmer@samba.org,		May, 2004
!== Updates:    Jelmer Vernooij, jelmer@samba.org,              May, 2005

Quick start
-----------

Run:

$ make all

or to see what is possible:

$ make help

What are DocBook documents doing in the Samba Distribution ?
-----------------------------------------------------------

We have converted all samba docs to XML/DocBook V4.2
in order to make them easier to maintain and produce a nicer looking
product.

This short note (strange isn't it how it always starts out as a short note
and becomes a long one ?) will explain very briefly how and why we have
done this.


The format
----------

If you are new to xml, regard an xml file as 'source code'. You don't
read it directly, but use it to create other formats (like the txt and html
included in ../txtdocs and ../htmldocs).

Docbook is a particular XML style, particularly suited to producing
technical manuals. 

For more information on DocBook tags and format, see "DocBook: The 
Definitive Guide" by Walsh and Muellner, (c) O'Reilly Publishing.
This book covers DocBook V4.2 and is available on-line
at http://www.docbook.org/

The Output
----------
The current Samba Subversion tree contains the XML/DocBook source files.

A regularly generated version can be found at http://samba.org/samba/docs/.

The Tools
---------

To generate the docs, you need to have the following packages installed:

 * GNU Make
 * GNU autoconf
 * xsltproc
 * inkscape

For generating PDF and PostScript (thru LaTeX):
 * dblatex (from http://dblatex.sf.net/)

For generating PDF (thru FO):
 * fop (http://xml.apache.org/fop/)

For generating ASCII:
 * html2text

For generating Palm-viewable docs:
 * plucker-build

For generating texi files:
 * docbook2x-texi
 * makeinfo

For validating:
 * xmllint

This directory now contains a ./configure script and Makefile to 
support the automated building of man pages (including HTML versions), and 
the building of the Samba-HOWTO-Collection and the 
Samba Developers Guide (HTML,TeX,PDF,PS,Text versions).

The configure script detects which of the required utilities are installed 
and builds as much docs as it can using these tools.

Help! Building the docs generates a lot of HTTP traffic...
----------------------------------------------------------

To be able to build the docs without an internet connection (or faster with 
a slow internet connection), you need to set up "catalogs".

For the Pearson DTD, add something like:

  <public publicId="-//Pearson//DTD Books//DE" uri="file:///home/jelmer/Xml_dtd_1.1/pearson.dtd"/>

For the Samba DTD's, add something like:
  <rewriteURI uriStartString="http://www.samba.org/samba/DTD" rewritePrefix="file:///home/jelmer/samba-web/DTD"/>

catalog entries for the other DTD's and XSL scripts should be present on your 
system already.

Windows Help files
----------

http://htmlhelp.berlios.de/howto/mshh4wine.php