summaryrefslogtreecommitdiff
path: root/docs/docbook
diff options
context:
space:
mode:
authorGerald Carter <jerry@samba.org>2002-01-05 03:52:39 +0000
committerGerald Carter <jerry@samba.org>2002-01-05 03:52:39 +0000
commit7d3cc61d26a7787c73397f940796c9aae93da096 (patch)
treed251be0ff2ba7d3a7b44cfc981515747197bb463 /docs/docbook
parent69d6c9fe1af2d85036cfbebbf3788128c6d7c5ff (diff)
downloadsamba-7d3cc61d26a7787c73397f940796c9aae93da096.tar.gz
samba-7d3cc61d26a7787c73397f940796c9aae93da096.tar.bz2
samba-7d3cc61d26a7787c73397f940796c9aae93da096.zip
merge from 2.2 and regenerate docs
(This used to be commit f7d900873c3553dde88d42d903b74dc49c9a6c71)
Diffstat (limited to 'docs/docbook')
-rw-r--r--docs/docbook/Makefile.in50
-rw-r--r--docs/docbook/manpages/smb.conf.5.sgml19
-rw-r--r--docs/docbook/manpages/smbclient.1.sgml8
3 files changed, 46 insertions, 31 deletions
diff --git a/docs/docbook/Makefile.in b/docs/docbook/Makefile.in
index b0d445852c..83b9920535 100644
--- a/docs/docbook/Makefile.in
+++ b/docs/docbook/Makefile.in
@@ -34,7 +34,7 @@ MANPAGES=$(MANDIR)/findsmb.1 $(MANDIR)/smbclient.1 \
$(MANDIR)/smbmount.8 $(MANDIR)/swat.8 $(MANDIR)/rpcclient.1 \
$(MANDIR)/smbpasswd.5 $(MANDIR)/testparm.1 $(MANDIR)/samba.7 \
$(MANDIR)/smbpasswd.8 $(MANDIR)/testprns.1 \
- $(MANDIR)/smb.conf.5 $(MANDIR)/wbinfo.1 \
+ $(MANDIR)/smb.conf.5 $(MANDIR)/wbinfo.1 $(MANDIR)/pdbedit.8 \
$(MANDIR)/smbcacls.1 $(MANDIR)/smbsh.1 $(MANDIR)/winbindd.8 \
$(MANDIR)/make_unicodemap.1
@@ -48,7 +48,7 @@ SGMLMANSRC=manpages/findsmb.1.sgml manpages/smbclient.1.sgml \
manpages/rpcclient.1.sgml manpages/smbpasswd.5.sgml \
manpages/testparm.1.sgml manpages/samba.7.sgml \
manpages/smbpasswd.8.sgml manpages/testprns.1.sgml \
- manpages/smb.conf.5.sgml \
+ manpages/smb.conf.5.sgml manpages/pdbedit.8.sgml \
manpages/wbinfo.1.sgml manpages/smbcacls.1.sgml \
manpages/smbsh.1.sgml manpages/winbindd.8.sgml \
manpages/make_unicodemap.1.sgml
@@ -58,29 +58,33 @@ HOWTOSRC=projdoc/DOMAIN_MEMBER.sgml projdoc/NT_Security.sgml \
projdoc/UNIX_INSTALL.sgml projdoc/winbind.sgml projdoc/OS2-Client-HOWTO.sgml \
projdoc/Samba-PDC-HOWTO.sgml projdoc/ENCRYPTION.sgml \
projdoc/CVS-Access.sgml projdoc/Integrating-with-Windows.sgml \
- projdoc/PAM-Authentication-And-Samba.sgml
-
-FAQSRC=faq/samba-pdc-faq.sgml
+ projdoc/PAM-Authentication-And-Samba.sgml projdoc/Samba-LDAP-HOWTO.sgml
######################################################################
# Make instructions
######################################################################
-all: HOWTO proj-doc man-all man-html-all
-
-man: $(MANPAGES)
-
-FAQ: $(FAQSRC)
- @echo Building SAMBA PDC FAQ...
+all:
+ @echo "Possible options to the Makefile include:"
+ @echo " all-docs - Force a rebuild of all documentation"
+ @echo " HOWTO - Build all individual HOWTOs in html format"
+ @echo " proj-doc - Build the Samba-HOWTO-Collection.[pdf|html] file"
+ @echo " man - Rebuild html and nroff versions of man pages as necessary"
+ @echo " syntax - Check the SGML/DocBook syntax of all source files"
+
+all-docs: HOWTO proj-doc man-all man-html-all
+
+syntax: $(SGMLMANSRC) projdoc/samba-doc.sgml
+ @echo Checking syntax of all SGML/DocBook source files...
@(for i in $?; do \
- htmlfile=`echo $$i | sed 's,.*/,,' | sed "s/\.sgml/\.html/g"`; \
- echo "Making $$htmlfile"; \
- $(JADE) -t sgml -V nochunks -d $(SGML_SHARE)/dsssl/docbook/html/docbook.dsl \
- -f /tmp/jade.log $$i > ../htmldocs/$$htmlfile; \
- cat /tmp/jade.log | grep -v DTDDECL; \
- /bin/rm -f /tmp/jade.log; \
+ echo "$$i..."; \
+ $(NSGMLS) -sv $$i 2>&1 | grep -v "DTDDECL catalog entries are not supported" ; \
done)
+
+
+
+man: $(MANPAGES)
HOWTO: $(HOWTOSRC)
@echo Building HOWTO pages...
@@ -112,9 +116,6 @@ proj-doc:
@/bin/mv -f samba-doc.html ../htmldocs/Samba-HOWTO-Collection.html
-
-
-
## generate all HTML man pages
man-html-all: $(SGMLMANSRC)
@echo Building HTML formatted man pages...
@@ -363,6 +364,15 @@ $(MANDIR)/winbindd.8: manpages/winbindd.8.sgml
@$(JADE) -t sgml -i html -V nochunks -d ./stylesheets/ldp.dsl\#html $< > $(HTMLDIR)/`echo $< | sed 's,.*/,,'| sed "s/\.sgml/\.html/g"`
+$(MANDIR)/pdbedit.8: manpages/pdbedit.8.sgml
+ @echo "Making $@"
+ @$(NSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @cat `echo $@ | sed 's,.*/,,'` | $(PERL) scripts/strip-links.pl > $@
+ @/bin/rm -f `echo $@ | sed 's,.*/,,'`
+ @echo "Making HTML version of $@"
+ @$(JADE) -t sgml -i html -V nochunks -d ./stylesheets/ldp.dsl\#html $< > $(HTMLDIR)/`echo $< | sed 's,.*/,,'| sed "s/\.sgml/\.html/g"`
+
+
## Clean Rule
clean:
/bin/rm -f manpage.*
diff --git a/docs/docbook/manpages/smb.conf.5.sgml b/docs/docbook/manpages/smb.conf.5.sgml
index a7328e7cf6..9e719e1f2a 100644
--- a/docs/docbook/manpages/smb.conf.5.sgml
+++ b/docs/docbook/manpages/smb.conf.5.sgml
@@ -2493,7 +2493,7 @@
causes <command>smbd</command> to authenticate against another
server.</para>
- <para>Default: <command>encrypt passwords = no</command></para></listitem>
+ <para>Default: <command>encrypt passwords = yes</command></para></listitem>
</varlistentry>
@@ -3451,10 +3451,13 @@
<para>
This option is used to control the tcp port number used to contact
the <link linkend="LDAPSERVER"><parameter>ldap server</parameter></link>.
- The default is to use the stand LDAP port 389.
+ The default is to use the stand LDAPS port 636.
</para>
- <para>Default : <command>ldap port = 389</command></para>
+ <para>See Also: <link linkend="LDAPSSL">ldap ssl</link>
+ </para>
+
+ <para>Default : <command>ldap port = 636</command></para>
</listitem>
</varlistentry>
@@ -3502,15 +3505,15 @@
<para>
The <parameter>ldap ssl</parameter> can be set to one of three values:
- (a) <command>on</command> - Always use SSL when contacting the
- <parameter>ldap server</parameter>, (b) <command>off</command> -
- Never use SSL when querying the directory, or (c) <command>start
- tls</command> - Use the LDAPv3 StartTLS extended operation
+ (a) <constant>on</constant> - Always use SSL when contacting the
+ <parameter>ldap server</parameter>, (b) <constant>off</constant> -
+ Never use SSL when querying the directory, or (c) <constant>start_tls</constant>
+ - Use the LDAPv3 StartTLS extended operation
(RFC2830) for communicating with the directory server.
</para>
- <para>Default : <command>ldap ssl = off</command></para>
+ <para>Default : <command>ldap ssl = on</command></para>
</listitem>
</varlistentry>
diff --git a/docs/docbook/manpages/smbclient.1.sgml b/docs/docbook/manpages/smbclient.1.sgml
index 6cc7be654a..4f36de1576 100644
--- a/docs/docbook/manpages/smbclient.1.sgml
+++ b/docs/docbook/manpages/smbclient.1.sgml
@@ -357,7 +357,7 @@
to read the password. </para>
<para>A third option is to use a credentials file which
- contains the plaintext of the username and password. This
+ contains the plaintext of the domain name, username and password. This
option is mainly provided for scripts where the admin doesn't
wish to pass the credentials on the command line or via environment
variables. If this method is used, make certain that the permissions
@@ -375,17 +375,19 @@
<varlistentry>
<term>-A filename</term><listitem><para>This option allows
- you to specify a file from which to read the username and
+ you to specify a file from which to read the username, domain name, and
password used in the connection. The format of the file is
</para>
<para><programlisting>
username = &lt;value&gt;
password = &lt;value&gt;
+domain = &lt;value&gt;
</programlisting></para>
- <para>Make certain that the permissions on the file restrict
+ <para>If the domain parameter is missing the current workgroup name
+ is used instead. Make certain that the permissions on the file restrict
access from unwanted users. </para></listitem>
</varlistentry>