summaryrefslogtreecommitdiff
path: root/docs/docbook
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docbook')
-rw-r--r--docs/docbook/Makefile.in68
-rwxr-xr-xdocs/docbook/configure64
-rw-r--r--docs/docbook/configure.in9
-rw-r--r--docs/docbook/manpages/make_unicodemap.1.sgml2
-rw-r--r--docs/docbook/manpages/nmbd.8.sgml19
-rw-r--r--docs/docbook/manpages/nmblookup.1.sgml2
-rw-r--r--docs/docbook/manpages/rpcclient.1.sgml10
-rw-r--r--docs/docbook/manpages/smb.conf.5.sgml645
-rw-r--r--docs/docbook/manpages/smbcacls.1.sgml20
-rw-r--r--docs/docbook/manpages/smbclient.1.sgml104
-rw-r--r--docs/docbook/manpages/smbcontrol.1.sgml5
-rw-r--r--docs/docbook/manpages/smbd.8.sgml74
-rw-r--r--docs/docbook/manpages/smbmnt.8.sgml15
-rw-r--r--docs/docbook/manpages/smbmount.8.sgml70
-rw-r--r--docs/docbook/manpages/smbpasswd.5.sgml14
-rw-r--r--docs/docbook/manpages/smbpasswd.8.sgml108
-rw-r--r--docs/docbook/manpages/smbsh.1.sgml12
-rw-r--r--docs/docbook/manpages/smbspool.8.sgml6
-rw-r--r--docs/docbook/manpages/smbumount.8.sgml2
-rw-r--r--docs/docbook/manpages/swat.8.sgml16
-rw-r--r--docs/docbook/manpages/testparm.1.sgml6
-rw-r--r--docs/docbook/manpages/wbinfo.1.sgml7
-rw-r--r--docs/docbook/manpages/winbindd.8.sgml53
-rw-r--r--docs/docbook/projdoc/CVS-Access.sgml8
-rw-r--r--docs/docbook/projdoc/DOMAIN_MEMBER.sgml2
-rw-r--r--docs/docbook/projdoc/ENCRYPTION.sgml6
-rw-r--r--docs/docbook/projdoc/Integrating-with-Windows.sgml935
-rw-r--r--docs/docbook/projdoc/NT_Security.sgml20
-rw-r--r--docs/docbook/projdoc/OS2-Client-HOWTO.sgml4
-rw-r--r--docs/docbook/projdoc/PAM-Authentication-And-Samba.sgml212
-rw-r--r--docs/docbook/projdoc/Samba-PDC-HOWTO.sgml73
-rw-r--r--docs/docbook/projdoc/UNIX_INSTALL.sgml18
-rw-r--r--docs/docbook/projdoc/msdfs_setup.sgml2
-rw-r--r--docs/docbook/projdoc/printer_driver2.sgml129
-rw-r--r--docs/docbook/projdoc/samba-doc.sgml15
-rw-r--r--docs/docbook/projdoc/winbind.sgml621
-rw-r--r--docs/docbook/scripts/collateindex.pl595
-rw-r--r--docs/docbook/scripts/strip-links.pl3
38 files changed, 3212 insertions, 762 deletions
diff --git a/docs/docbook/Makefile.in b/docs/docbook/Makefile.in
index 4733ef98b4..b0d445852c 100644
--- a/docs/docbook/Makefile.in
+++ b/docs/docbook/Makefile.in
@@ -12,7 +12,6 @@
SRCDIR = @srcdir@
JADE = @JADE@
NSGMLS = @NSGMLS@
-ONSGMLS=@ONSGMLS@
SGMLSPL=@SGMLSPL@
HTMLDOC=@HTMLDOC@
PERL=@PERL@
@@ -58,7 +57,8 @@ HOWTOSRC=projdoc/DOMAIN_MEMBER.sgml projdoc/NT_Security.sgml \
projdoc/msdfs_setup.sgml projdoc/printer_driver2.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/CVS-Access.sgml projdoc/Integrating-with-Windows.sgml \
+ projdoc/PAM-Authentication-And-Samba.sgml
FAQSRC=faq/samba-pdc-faq.sgml
@@ -67,7 +67,7 @@ FAQSRC=faq/samba-pdc-faq.sgml
######################################################################
# Make instructions
######################################################################
-all: man
+all: HOWTO proj-doc man-all man-html-all
man: $(MANPAGES)
@@ -102,7 +102,11 @@ HOWTO: $(HOWTOSRC)
##
proj-doc:
echo Building Samba-HOWTO-Collections...
- @(cd projdoc; $(JADE) -t sgml -i html -V nochunks -d ../stylesheets/ldp.dsl\#html samba-doc.sgml > ../samba-doc.html)
+ @$(PERL) scripts/collateindex.pl -N -o projdoc/index.sgml
+ @$(JADE) -t sgml -V html-index -d $(SGML_SHARE)/dsssl/docbook/html/docbook.dsl projdoc/samba-doc.sgml
+ @$(PERL) scripts/collateindex.pl -o projdoc/index.sgml HTML.index
+ @/bin/rm HTML.index *.htm
+ @$(JADE) -t sgml -i html -V nochunks -d stylesheets/ldp.dsl\#html projdoc/samba-doc.sgml > samba-doc.html
@(cd scripts; ./ldp_print ../samba-doc.html)
@mv -f samba-doc.pdf ../Samba-HOWTO-Collection.pdf
@/bin/mv -f samba-doc.html ../htmldocs/Samba-HOWTO-Collection.html
@@ -128,7 +132,7 @@ man-all: $(SGMLMANSRC)
@(for i in $?; do \
manfile=`echo $$i | sed 's,.*/,,' | sed "s/\.sgml//g"`; \
echo "Making $$manfile"; \
- $(ONSGMLS) -f /tmp/docbook2x.log $$i | $(SGMLSPL) \
+ $(NSGMLS) -f /tmp/docbook2x.log $$i | $(SGMLSPL) \
$(SGML_SHARE)/docbook2X/docbook2man-spec.pl; \
cat /tmp/docbook2x.log | grep -v DTDDECL; \
/bin/rm -f /tmp/docbook2x.log; \
@@ -144,7 +148,7 @@ man-all: $(SGMLMANSRC)
##
$(MANDIR)/findsmb.1: manpages/findsmb.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -152,7 +156,7 @@ $(MANDIR)/findsmb.1: manpages/findsmb.1.sgml
$(MANDIR)/smbclient.1: manpages/smbclient.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -160,7 +164,7 @@ $(MANDIR)/smbclient.1: manpages/smbclient.1.sgml
$(MANDIR)/smbspool.8: manpages/smbspool.8.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -168,7 +172,7 @@ $(MANDIR)/smbspool.8: manpages/smbspool.8.sgml
$(MANDIR)/lmhosts.5: manpages/lmhosts.5.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -176,7 +180,7 @@ $(MANDIR)/lmhosts.5: manpages/lmhosts.5.sgml
$(MANDIR)/smbcontrol.1: manpages/smbcontrol.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -184,7 +188,7 @@ $(MANDIR)/smbcontrol.1: manpages/smbcontrol.1.sgml
$(MANDIR)/smbstatus.1: manpages/smbstatus.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -192,7 +196,7 @@ $(MANDIR)/smbstatus.1: manpages/smbstatus.1.sgml
$(MANDIR)/make_smbcodepage.1: manpages/make_smbcodepage.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -200,7 +204,7 @@ $(MANDIR)/make_smbcodepage.1: manpages/make_smbcodepage.1.sgml
$(MANDIR)/make_unicodemap.1: manpages/make_unicodemap.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -208,7 +212,7 @@ $(MANDIR)/make_unicodemap.1: manpages/make_unicodemap.1.sgml
$(MANDIR)/smbd.8: manpages/smbd.8.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -216,7 +220,7 @@ $(MANDIR)/smbd.8: manpages/smbd.8.sgml
$(MANDIR)/smbtar.1: manpages/smbtar.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -224,7 +228,7 @@ $(MANDIR)/smbtar.1: manpages/smbtar.1.sgml
$(MANDIR)/nmbd.8: manpages/nmbd.8.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -232,7 +236,7 @@ $(MANDIR)/nmbd.8: manpages/nmbd.8.sgml
$(MANDIR)/smbmnt.8: manpages/smbmnt.8.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -240,7 +244,7 @@ $(MANDIR)/smbmnt.8: manpages/smbmnt.8.sgml
$(MANDIR)/smbumount.8: manpages/smbumount.8.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -248,7 +252,7 @@ $(MANDIR)/smbumount.8: manpages/smbumount.8.sgml
$(MANDIR)/nmblookup.1: manpages/nmblookup.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -256,7 +260,7 @@ $(MANDIR)/nmblookup.1: manpages/nmblookup.1.sgml
$(MANDIR)/smbmount.8: manpages/smbmount.8.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -264,7 +268,7 @@ $(MANDIR)/smbmount.8: manpages/smbmount.8.sgml
$(MANDIR)/swat.8: manpages/swat.8.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -272,7 +276,7 @@ $(MANDIR)/swat.8: manpages/swat.8.sgml
$(MANDIR)/rpcclient.1: manpages/rpcclient.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -280,7 +284,7 @@ $(MANDIR)/rpcclient.1: manpages/rpcclient.1.sgml
$(MANDIR)/smbpasswd.5: manpages/smbpasswd.5.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -288,7 +292,7 @@ $(MANDIR)/smbpasswd.5: manpages/smbpasswd.5.sgml
$(MANDIR)/testparm.1: manpages/testparm.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -296,7 +300,7 @@ $(MANDIR)/testparm.1: manpages/testparm.1.sgml
$(MANDIR)/samba.7: manpages/samba.7.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -304,7 +308,7 @@ $(MANDIR)/samba.7: manpages/samba.7.sgml
$(MANDIR)/smbpasswd.8: manpages/smbpasswd.8.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -312,7 +316,7 @@ $(MANDIR)/smbpasswd.8: manpages/smbpasswd.8.sgml
$(MANDIR)/testprns.1: manpages/testprns.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -320,7 +324,7 @@ $(MANDIR)/testprns.1: manpages/testprns.1.sgml
$(MANDIR)/smb.conf.5: manpages/smb.conf.5.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -328,7 +332,7 @@ $(MANDIR)/smb.conf.5: manpages/smb.conf.5.sgml
$(MANDIR)/wbinfo.1: manpages/wbinfo.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -336,7 +340,7 @@ $(MANDIR)/wbinfo.1: manpages/wbinfo.1.sgml
$(MANDIR)/smbcacls.1: manpages/smbcacls.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -344,7 +348,7 @@ $(MANDIR)/smbcacls.1: manpages/smbcacls.1.sgml
$(MANDIR)/smbsh.1 : manpages/smbsh.1.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
@@ -352,7 +356,7 @@ $(MANDIR)/smbsh.1 : manpages/smbsh.1.sgml
$(MANDIR)/winbindd.8: manpages/winbindd.8.sgml
@echo "Making $@"
- @$(ONSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl
+ @$(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 $@"
diff --git a/docs/docbook/configure b/docs/docbook/configure
index e8578fed39..26ea467482 100755
--- a/docs/docbook/configure
+++ b/docs/docbook/configure
@@ -525,10 +525,12 @@ fi
## check for the necesary install tools
+## Openjade includes 'onsgmls' while
+## the older jade package includes 'nsgmls'
# Extract the first word of "openjade", so it can be a program name with args.
set dummy openjade; ac_word=$2
echo $ac_n "checking for $ac_word""... $ac_c" 1>&6
-echo "configure:532: checking for $ac_word" >&5
+echo "configure:534: checking for $ac_word" >&5
if eval "test \"`echo '$''{'ac_cv_path_JADE'+set}'`\" = set"; then
echo $ac_n "(cached) $ac_c" 1>&6
else
@@ -565,7 +567,7 @@ if test -z "$JADE"; then
# Extract the first word of "jade", so it can be a program name with args.
set dummy jade; ac_word=$2
echo $ac_n "checking for $ac_word""... $ac_c" 1>&6
-echo "configure:569: checking for $ac_word" >&5
+echo "configure:571: checking for $ac_word" >&5
if eval "test \"`echo '$''{'ac_cv_path_JADE'+set}'`\" = set"; then
echo $ac_n "(cached) $ac_c" 1>&6
else
@@ -597,9 +599,7 @@ else
echo "$ac_t""no" 1>&6
fi
-fi
-
-# Extract the first word of "nsgmls", so it can be a program name with args.
+ # Extract the first word of "nsgmls", so it can be a program name with args.
set dummy nsgmls; ac_word=$2
echo $ac_n "checking for $ac_word""... $ac_c" 1>&6
echo "configure:606: checking for $ac_word" >&5
@@ -634,19 +634,20 @@ else
echo "$ac_t""no" 1>&6
fi
-# Extract the first word of "htmldoc", so it can be a program name with args.
-set dummy htmldoc; ac_word=$2
+else
+ # Extract the first word of "onsgmls", so it can be a program name with args.
+set dummy onsgmls; ac_word=$2
echo $ac_n "checking for $ac_word""... $ac_c" 1>&6
-echo "configure:641: checking for $ac_word" >&5
-if eval "test \"`echo '$''{'ac_cv_path_HTMLDOC'+set}'`\" = set"; then
+echo "configure:642: checking for $ac_word" >&5
+if eval "test \"`echo '$''{'ac_cv_path_NSGMLS'+set}'`\" = set"; then
echo $ac_n "(cached) $ac_c" 1>&6
else
- case "$HTMLDOC" in
+ case "$NSGMLS" in
/*)
- ac_cv_path_HTMLDOC="$HTMLDOC" # Let the user override the test with a path.
+ ac_cv_path_NSGMLS="$NSGMLS" # Let the user override the test with a path.
;;
?:/*)
- ac_cv_path_HTMLDOC="$HTMLDOC" # Let the user override the test with a dos path.
+ ac_cv_path_NSGMLS="$NSGMLS" # Let the user override the test with a dos path.
;;
*)
IFS="${IFS= }"; ac_save_ifs="$IFS"; IFS=":"
@@ -654,7 +655,7 @@ else
for ac_dir in $ac_dummy; do
test -z "$ac_dir" && ac_dir=.
if test -f $ac_dir/$ac_word; then
- ac_cv_path_HTMLDOC="$ac_dir/$ac_word"
+ ac_cv_path_NSGMLS="$ac_dir/$ac_word"
break
fi
done
@@ -662,26 +663,28 @@ else
;;
esac
fi
-HTMLDOC="$ac_cv_path_HTMLDOC"
-if test -n "$HTMLDOC"; then
- echo "$ac_t""$HTMLDOC" 1>&6
+NSGMLS="$ac_cv_path_NSGMLS"
+if test -n "$NSGMLS"; then
+ echo "$ac_t""$NSGMLS" 1>&6
else
echo "$ac_t""no" 1>&6
fi
-# Extract the first word of "onsgmls", so it can be a program name with args.
-set dummy onsgmls; ac_word=$2
+fi
+
+# Extract the first word of "htmldoc", so it can be a program name with args.
+set dummy htmldoc; ac_word=$2
echo $ac_n "checking for $ac_word""... $ac_c" 1>&6
-echo "configure:676: checking for $ac_word" >&5
-if eval "test \"`echo '$''{'ac_cv_path_ONSGMLS'+set}'`\" = set"; then
+echo "configure:679: checking for $ac_word" >&5
+if eval "test \"`echo '$''{'ac_cv_path_HTMLDOC'+set}'`\" = set"; then
echo $ac_n "(cached) $ac_c" 1>&6
else
- case "$ONSGMLS" in
+ case "$HTMLDOC" in
/*)
- ac_cv_path_ONSGMLS="$ONSGMLS" # Let the user override the test with a path.
+ ac_cv_path_HTMLDOC="$HTMLDOC" # Let the user override the test with a path.
;;
?:/*)
- ac_cv_path_ONSGMLS="$ONSGMLS" # Let the user override the test with a dos path.
+ ac_cv_path_HTMLDOC="$HTMLDOC" # Let the user override the test with a dos path.
;;
*)
IFS="${IFS= }"; ac_save_ifs="$IFS"; IFS=":"
@@ -689,7 +692,7 @@ else
for ac_dir in $ac_dummy; do
test -z "$ac_dir" && ac_dir=.
if test -f $ac_dir/$ac_word; then
- ac_cv_path_ONSGMLS="$ac_dir/$ac_word"
+ ac_cv_path_HTMLDOC="$ac_dir/$ac_word"
break
fi
done
@@ -697,9 +700,9 @@ else
;;
esac
fi
-ONSGMLS="$ac_cv_path_ONSGMLS"
-if test -n "$ONSGMLS"; then
- echo "$ac_t""$ONSGMLS" 1>&6
+HTMLDOC="$ac_cv_path_HTMLDOC"
+if test -n "$HTMLDOC"; then
+ echo "$ac_t""$HTMLDOC" 1>&6
else
echo "$ac_t""no" 1>&6
fi
@@ -707,7 +710,7 @@ fi
# Extract the first word of "sgmlspl", so it can be a program name with args.
set dummy sgmlspl; ac_word=$2
echo $ac_n "checking for $ac_word""... $ac_c" 1>&6
-echo "configure:711: checking for $ac_word" >&5
+echo "configure:714: checking for $ac_word" >&5
if eval "test \"`echo '$''{'ac_cv_path_SGMLSPL'+set}'`\" = set"; then
echo $ac_n "(cached) $ac_c" 1>&6
else
@@ -742,7 +745,7 @@ fi
# Extract the first word of "perl", so it can be a program name with args.
set dummy perl; ac_word=$2
echo $ac_n "checking for $ac_word""... $ac_c" 1>&6
-echo "configure:746: checking for $ac_word" >&5
+echo "configure:749: checking for $ac_word" >&5
if eval "test \"`echo '$''{'ac_cv_path_PERL'+set}'`\" = set"; then
echo $ac_n "(cached) $ac_c" 1>&6
else
@@ -797,7 +800,7 @@ fi
# The Makefile requires docbook2X in the share/sgml directory
if ! test -f $SGML_SHARE/docbook2X/docbook2man-spec.pl ; then
- { echo "configure: error: "Unable to find docbook2X. Make sure it is installed and that the sgml-share path is correct."" 1>&2; exit 1; }
+ { echo "configure: error: "Unable to find dockbook2X. Make sure it is installed and that the sgml-share path is correct."" 1>&2; exit 1; }
fi
@@ -951,7 +954,6 @@ s%@mandir@%$mandir%g
s%@JADE@%$JADE%g
s%@NSGMLS@%$NSGMLS%g
s%@HTMLDOC@%$HTMLDOC%g
-s%@ONSGMLS@%$ONSGMLS%g
s%@SGMLSPL@%$SGMLSPL%g
s%@PERL@%$PERL%g
s%@SGML_SHARE@%$SGML_SHARE%g
diff --git a/docs/docbook/configure.in b/docs/docbook/configure.in
index f7256505d1..ad0613f2be 100644
--- a/docs/docbook/configure.in
+++ b/docs/docbook/configure.in
@@ -1,15 +1,18 @@
AC_INIT(global.ent)
## check for the necesary install tools
+## Openjade includes 'onsgmls' while
+## the older jade package includes 'nsgmls'
AC_PATH_PROG(JADE,openjade)
if test -z "$JADE"; then
AC_PATH_PROG(JADE,jade)
+ AC_PATH_PROG(NSGMLS, nsgmls)
+else
+ AC_PATH_PROG(NSGMLS, onsgmls)
fi
-AC_PATH_PROG(NSGMLS, nsgmls)
AC_PATH_PROG(HTMLDOC, htmldoc)
-AC_PATH_PROG(ONSGMLS, onsgmls)
AC_PATH_PROG(SGMLSPL, sgmlspl)
AC_PATH_PROG(PERL, perl)
@@ -35,7 +38,7 @@ esac
# The Makefile requires docbook2X in the share/sgml directory
if [ ! test -f $SGML_SHARE/docbook2X/docbook2man-spec.pl ]; then
- AC_MSG_ERROR("Unable to find docbook2X. Make sure it is installed and that the sgml-share path is correct.")
+ AC_MSG_ERROR("Unable to find dockbook2X. Make sure it is installed and that the sgml-share path is correct.")
fi
AC_SUBST(SGML_SHARE)dnl
diff --git a/docs/docbook/manpages/make_unicodemap.1.sgml b/docs/docbook/manpages/make_unicodemap.1.sgml
index 50a5446d60..5e7292341b 100644
--- a/docs/docbook/manpages/make_unicodemap.1.sgml
+++ b/docs/docbook/manpages/make_unicodemap.1.sgml
@@ -33,7 +33,7 @@
<para>
<command>make_unicodemap</command> compiles text unicode map
- files into binary unicodef map files for use with the
+ files into binary unicode map files for use with the
internationalization features of Samba 2.2.
</para>
</refsect1>
diff --git a/docs/docbook/manpages/nmbd.8.sgml b/docs/docbook/manpages/nmbd.8.sgml
index 8db2749bfa..2d873a1e40 100644
--- a/docs/docbook/manpages/nmbd.8.sgml
+++ b/docs/docbook/manpages/nmbd.8.sgml
@@ -15,7 +15,7 @@
<refsynopsisdiv>
<cmdsynopsis>
- <command>smbd</command>
+ <command>nmbd</command>
<arg choice="opt">-D</arg>
<arg choice="opt">-a</arg>
<arg choice="opt">-o</arg>
@@ -287,17 +287,18 @@
a SIGTERM (-15) signal and wait for it to die on its own.</para>
<para><command>nmbd</command> will accept SIGHUP, which will cause
- it to dump out it's namelists into the file <filename>namelist.debug
+ it to dump out its namelists into the file <filename>namelist.debug
</filename> in the <filename>/usr/local/samba/var/locks</filename>
directory (or the <filename>var/locks</filename> directory configured
under wherever Samba was configured to install itself). This will also
- cause <command>nmbd</command> to dump out it's server database in
- the <filename>log.nmb</filename> file. In addition, the debug log level
- of nmbd may be raised by sending it a SIGUSR1 (<command>kill -USR1
- &lt;nmbd-pid&gt;</command>) and lowered by sending it a
- SIGUSR2 (<command>kill -USR2 &lt;nmbd-pid&gt;</command>). This is to
- allow transient problems to be diagnosed, whilst still running at a
- normally low log level.</para>
+ cause <command>nmbd</command> to dump out its server database in
+ the <filename>log.nmb</filename> file.</para>
+
+ <para>The debug log level of nmbd may be raised or lowered using
+ <ulink url="smbcontrol.1.html"><command>smbcontrol(1)</command>
+ </ulink> (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is
+ to allow transient problems to be diagnosed, whilst still running
+ at a normally low log level.</para>
</refsect1>
diff --git a/docs/docbook/manpages/nmblookup.1.sgml b/docs/docbook/manpages/nmblookup.1.sgml
index 6fcf5cf70c..67efac5634 100644
--- a/docs/docbook/manpages/nmblookup.1.sgml
+++ b/docs/docbook/manpages/nmblookup.1.sgml
@@ -84,7 +84,7 @@
datagrams. The reason for this option is a bug in Windows 95
where it ignores the source port of the requesting packet
and only replies to UDP port 137. Unfortunately, on most UNIX
- systems root privilage is needed to bind to this port, and
+ systems root privilege is needed to bind to this port, and
in addition, if the <ulink url="nmbd.8.html">nmbd(8)</ulink>
daemon is running on this machine it also binds to this port.
</para></listitem>
diff --git a/docs/docbook/manpages/rpcclient.1.sgml b/docs/docbook/manpages/rpcclient.1.sgml
index 0d45a5dc20..6093d6dc42 100644
--- a/docs/docbook/manpages/rpcclient.1.sgml
+++ b/docs/docbook/manpages/rpcclient.1.sgml
@@ -89,7 +89,7 @@
<term>-d debuglevel</term>
<listitem><para>set the debuglevel. Debug level 0 is the lowest
and 100 being the highest. This should be set to 100 if you are
- planning on submitting a bug report to the Samba team (see BUGS.txt).
+ planning on submitting a bug report to the Samba team (see <filename>BUGS.txt</filename>).
</para></listitem>
</varlistentry>
@@ -108,7 +108,7 @@
<varlistentry>
<term>-l logbasename</term>
<listitem><para>File name for log/debug files. The extension
- '.client' will be appended. The log file is never removed
+ <constant>'.client'</constant> will be appended. The log file is never removed
by the client.
</para></listitem>
</varlistentry>
@@ -137,7 +137,7 @@
<para>If %password is not specified, The user will be prompted. The
client will first check the <envar>USER</envar> environment variable, then the
- <envar>LOGNAME</envar> variable and if either exist, the
+ <envar>LOGNAME</envar> variable and if either exists, the
string is uppercased. If these environmental variables are not
found, the username <constant>GUEST</constant> is used. </para>
@@ -384,7 +384,7 @@
available from the original creators (Microsoft) on how MSRPC over
SMB works, or how the individual MSRPC services work. Microsoft's
implementation of these services has been demonstrated (and reported)
- to be... a bit flakey in places. </para>
+ to be... a bit flaky in places. </para>
<para>The development of Samba's implementation is also a bit rough,
and as more of the services are understood, it can even result in
@@ -412,7 +412,7 @@
to the way the Linux kernel is developed.</para>
<para>The original rpcclient man page was written by Matthew
- Geddes, Luke Kenneth Casson, and rewriten by Gerald Carter.
+ Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
The conversion to DocBook for Samba 2.2 was done by Gerald
Carter.</para>
</refsect1>
diff --git a/docs/docbook/manpages/smb.conf.5.sgml b/docs/docbook/manpages/smb.conf.5.sgml
index ff56260f2b..3ee2a3b8bd 100644
--- a/docs/docbook/manpages/smb.conf.5.sgml
+++ b/docs/docbook/manpages/smb.conf.5.sgml
@@ -519,7 +519,7 @@
upper case, or if they are forced to be the "default"
case. This option can be use with "preserve case = yes"
to permit long filenames to retain their case, while short names
- are lowered. Default <emphasis>yes</emphasis>.</para></listitem>
+ are lowercased. Default <emphasis>yes</emphasis>.</para></listitem>
</varlistentry>
</variablelist>
@@ -552,7 +552,7 @@
with the system and now supplies a correct password for that
username then the connection is allowed.</para></listitem>
- <listitem><para>The client's netbios name and any previously
+ <listitem><para>The client's NetBIOS name and any previously
used user names are checked against the supplied password, if
they match then the connection is allowed as the corresponding
user.</para></listitem>
@@ -586,6 +586,7 @@
each parameter for details. Note that some are synonyms.</para>
<itemizedlist>
+ <listitem><para><link linkend="ABORTSHUTDOWNSCRIPT"><parameter>abort shutdown script</parameter></link></para></listitem>
<listitem><para><link linkend="ADDPRINTERCOMMAND"><parameter>add printer command</parameter></link></para></listitem>
<listitem><para><link linkend="ADDSHARECOMMAND"><parameter>add share command</parameter></link></para></listitem>
<listitem><para><link linkend="ADDUSERSCRIPT"><parameter>add user script</parameter></link></para></listitem>
@@ -615,6 +616,7 @@
<listitem><para><link linkend="DELETESHARECOMMAND"><parameter>delete share command</parameter></link></para></listitem>
<listitem><para><link linkend="DELETEUSERSCRIPT"><parameter>delete user script</parameter></link></para></listitem>
<listitem><para><link linkend="DFREECOMMAND"><parameter>dfree command</parameter></link></para></listitem>
+ <listitem><para><link linkend="DISABLESPOOLSS"><parameter>disable spoolss</parameter></link></para></listitem>
<listitem><para><link linkend="DNSPROXY"><parameter>dns proxy</parameter></link></para></listitem>
<listitem><para><link linkend="DOMAINADMINGROUP"><parameter>domain admin group</parameter></link></para></listitem>
<listitem><para><link linkend="DOMAINGUESTGROUP"><parameter>domain guest group</parameter></link></para></listitem>
@@ -625,6 +627,7 @@
<listitem><para><link linkend="ENUMPORTSCOMMAND"><parameter>enumports command</parameter></link></para></listitem>
<listitem><para><link linkend="GETWDCACHE"><parameter>getwd cache</parameter></link></para></listitem>
<listitem><para><link linkend="HIDELOCALUSERS"><parameter>hide local users</parameter></link></para></listitem>
+ <listitem><para><link linkend="HIDEUNREADABLE"><parameter>hide unreadable</parameter></link></para></listitem>
<listitem><para><link linkend="HOMEDIRMAP"><parameter>homedir map</parameter></link></para></listitem>
<listitem><para><link linkend="HOSTMSDFS"><parameter>host msdfs</parameter></link></para></listitem>
<listitem><para><link linkend="HOSTSEQUIV"><parameter>hosts equiv</parameter></link></para></listitem>
@@ -632,6 +635,7 @@
<listitem><para><link linkend="KEEPALIVE"><parameter>keepalive</parameter></link></para></listitem>
<listitem><para><link linkend="KERNELOPLOCKS"><parameter>kernel oplocks</parameter></link></para></listitem>
<listitem><para><link linkend="LANMANAUTH"><parameter>lanman auth</parameter></link></para></listitem>
+ <listitem><para><link linkend="LARGEREADWRITE"><parameter>large readwrite</parameter></link></para></listitem>
<listitem><para><link linkend="LMANNOUNCE"><parameter>lm announce</parameter></link></para></listitem>
<listitem><para><link linkend="LMINTERVAL"><parameter>lm interval</parameter></link></para></listitem>
<listitem><para><link linkend="LOADPRINTERS"><parameter>load printers</parameter></link></para></listitem>
@@ -701,6 +705,7 @@
<listitem><para><link linkend="SECURITY"><parameter>security</parameter></link></para></listitem>
<listitem><para><link linkend="SERVERSTRING"><parameter>server string</parameter></link></para></listitem>
<listitem><para><link linkend="SHOWADDPRINTERWIZARD"><parameter>show add printer wizard</parameter></link></para></listitem>
+ <listitem><para><link linkend="SHUTDOWNSCRIPT"><parameter>shutdown script</parameter></link></para></listitem>
<listitem><para><link linkend="SMBPASSWDFILE"><parameter>smb passwd file</parameter></link></para></listitem>
<listitem><para><link linkend="SOCKETADDRESS"><parameter>socket address</parameter></link></para></listitem>
<listitem><para><link linkend="SOCKETOPTIONS"><parameter>socket options</parameter></link></para></listitem>
@@ -735,9 +740,12 @@
<listitem><para><link linkend="USERHOSTS"><parameter>use rhosts</parameter></link></para></listitem>
<listitem><para><link linkend="USERNAMELEVEL"><parameter>username level</parameter></link></para></listitem>
<listitem><para><link linkend="USERNAMEMAP"><parameter>username map</parameter></link></para></listitem>
+ <listitem><para><link linkend="UTMP"><parameter>utmp</parameter></link></para></listitem>
<listitem><para><link linkend="UTMPDIRECTORY"><parameter>utmp directory</parameter></link></para></listitem>
<listitem><para><link linkend="VALIDCHARS"><parameter>valid chars</parameter></link></para></listitem>
<listitem><para><link linkend="WINBINDCACHETIME"><parameter>winbind cache time</parameter></link></para></listitem>
+ <listitem><para><link linkend="WINBINDENUMUSERS"><parameter>winbind enum users</parameter></link></para></listitem>
+ <listitem><para><link linkend="WINBINDENUMGROUPS"><parameter>winbind enum groups</parameter></link></para></listitem>
<listitem><para><link linkend="WINBINDGID"><parameter>winbind gid</parameter></link></para></listitem>
<listitem><para><link linkend="WINBINDSEPARATOR"><parameter>winbind separator</parameter></link></para></listitem>
<listitem><para><link linkend="WINBINDUID"><parameter>winbind uid</parameter></link></para></listitem>
@@ -853,16 +861,15 @@
<listitem><para><link linkend="ROOTPREEXECCLOSE"><parameter>root preexec close</parameter></link></para></listitem>
<listitem><para><link linkend="SECURITYMASK"><parameter>security mask</parameter></link></para></listitem>
<listitem><para><link linkend="SETDIRECTORY"><parameter>set directory</parameter></link></para></listitem>
- <listitem><para><link linkend="SHAREMODES"><parameter>share modes</parameter></link></para></listitem>
<listitem><para><link linkend="SHORTPRESERVECASE"><parameter>short preserve case</parameter></link></para></listitem>
<listitem><para><link linkend="STATUS"><parameter>status</parameter></link></para></listitem>
<listitem><para><link linkend="STRICTLOCKING"><parameter>strict locking</parameter></link></para></listitem>
<listitem><para><link linkend="STRICTSYNC"><parameter>strict sync</parameter></link></para></listitem>
<listitem><para><link linkend="SYNCALWAYS"><parameter>sync always</parameter></link></para></listitem>
+ <listitem><para><link linkend="USECLIENTDRIVER"><parameter>use client driver</parameter></link></para></listitem>
<listitem><para><link linkend="USER"><parameter>user</parameter></link></para></listitem>
<listitem><para><link linkend="USERNAME"><parameter>username</parameter></link></para></listitem>
<listitem><para><link linkend="USERS"><parameter>users</parameter></link></para></listitem>
- <listitem><para><link linkend="UTMP"><parameter>utmp</parameter></link></para></listitem>
<listitem><para><link linkend="VALIDUSERS"><parameter>valid users</parameter></link></para></listitem>
<listitem><para><link linkend="VETOFILES"><parameter>veto files</parameter></link></para></listitem>
<listitem><para><link linkend="VETOOPLOCKFILES"><parameter>veto oplock files</parameter></link></para></listitem>
@@ -883,7 +890,22 @@
<title>EXPLANATION OF EACH PARAMETER</title>
<variablelist>
-
+
+ <varlistentry>
+ <term><anchor id="ABORTSHUTDOWNSCRIPT">abort shutdown script (G)</term>
+ <listitem><para><emphasis>This parameter only exists in the HEAD cvs branch</emphasis>
+ This a full path name to a script called by
+ <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> that
+ should stop a shutdown procedure issued by the <link
+ linkend="SHUTDOWNSCRIPT"><parameter>shutdown script</parameter></link>.</para>
+
+ <para>This command will be run as user.</para>
+
+ <para>Default: <emphasis>None</emphasis>.</para>
+ <para>Example: <command>abort shutdown script = /sbin/shutdown -c</command></para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><anchor id="ADDPRINTERCOMMAND">add printer command (G)</term>
@@ -895,7 +917,7 @@
NT/2000 print server.</para>
<para>For a Samba host this means that the printer must be
- physically added to underlying printing system. The <parameter>add
+ physically added to the underlying printing system. The <parameter>add
printer command</parameter> defines a script to be run which
will perform the necessary operations for adding the printer
to the print system and to add the appropriate service definition
@@ -1000,14 +1022,14 @@
<varlistentry>
<term><anchor id="ADDMACHINESCRIPT">add machine script (G)</term>
<listitem><para>This is the full pathname to a script that will
- be run by <ulink url="smbd.8.html">smbd(8)</ulink> when a machine is added
+ be run by <ulink url="smbd.8.html">smbd(8)</ulink> when a machine is added
to it's domain using the administrator username and password method. </para>
- <para>This option is only required when using sam backends tied to the
- unix uid method of RID calculation such as smbpasswd. This option is only
- avaliable in Samba 3.0.</para>
+ <para>This option is only required when using sam back-ends tied to the
+ Unix uid method of RID calculation such as smbpasswd. This option is only
+ available in Samba 3.0.</para>
- <para>Default: <command>add user script = &lt;empty string&gt;
+ <para>Default: <command>add machine script = &lt;empty string&gt;
</command></para>
<para>Example: <command>add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
@@ -1101,7 +1123,7 @@
linkend="SECURITY"><parameter>security</parameter></link> option is set to
<constant>server</constant> or <constant>domain</constant>.
If it is set to no, then attempts to connect to a resource from
- a domain or workgroup other than the one which smbd is running
+ a domain or workgroup other than the one which <ulink url="smbd.8.html">smbd</ulink> is running
in will fail, even if that domain is trusted by the remote server
doing the authentication.</para>
@@ -1144,13 +1166,13 @@
<varlistentry>
- <term><anchor id="ANNOUNCEVERSION">annouce version (G)</term>
+ <term><anchor id="ANNOUNCEVERSION">announce version (G)</term>
<listitem><para>This specifies the major and minor version numbers
that nmbd will use when announcing itself as a server. The default
is 4.2. Do not change this parameter unless you have a specific
need to set a Samba server to be a downlevel server.</para>
- <para>Default: <command>announce version = 4.2</command></para>
+ <para>Default: <command>announce version = 4.5</command></para>
<para>Example: <command>announce version = 2.0</command></para>
</listitem>
@@ -1184,7 +1206,7 @@
<varlistentry>
<term><anchor id="BINDINTERFACESONLY">bind interfaces only (G)</term>
<listitem><para>This global parameter allows the Samba admin
- to limit what interfaces on a machine will serve smb requests. If
+ to limit what interfaces on a machine will serve SMB requests. If
affects file service <ulink url="smbd.8.html">smbd(8)</ulink> and
name service <ulink url="nmbd.8.html">nmbd(8)</ulink> in slightly
different ways.</para>
@@ -1263,7 +1285,7 @@
queue the lock request, and periodically attempt to obtain
the lock until the timeout period expires.</para>
- <para>If this parameter is set to <constant>False</constant>, then
+ <para>If this parameter is set to <constant>false</constant>, then
Samba 2.2 will behave as previous versions of Samba would and
will fail the lock request immediately if the lock range
cannot be obtained.</para>
@@ -1399,7 +1421,7 @@
<varlistentry>
<term><anchor id="CHARACTERSET">character set (G)</term>
- <listitem><para>This allows a smbd to map incoming filenames
+ <listitem><para>This allows <ulink url="smbd.8.html">smbd</ulink> to map incoming filenames
from a DOS Code page (see the <link linkend="CLIENTCODEPAGE">client
code page</link> parameter) to several built in UNIX character sets.
The built in code page translations are:</para>
@@ -1540,7 +1562,7 @@
<varlistentry>
- <term><anchor id="CODINGSYSTEM">codingsystem (G)</term>
+ <term><anchor id="CODINGSYSTEM">coding system (G)</term>
<listitem><para>This parameter is used to determine how incoming
Shift-JIS Japanese characters are mapped from the incoming <link
linkend="CLIENTCODEPAGE"><parameter>client code page</parameter>
@@ -1741,7 +1763,7 @@
<varlistentry>
<term><anchor id="DEBUGPID">debug pid (G)</term>
<listitem><para>When using only one log file for more then one
- forked smbd-process there may be hard to follow which process
+ forked <ulink url="smbd.8.html">smbd</ulink>-process there may be hard to follow which process
outputs which message. This boolean parameter is adds the process-id
to the timestamp message headers in the logfile when turned on.</para>
@@ -1940,9 +1962,9 @@
</para>
<para>
- See also <link linkend="ADDSHARECOMMAND"><parameter>delete share
+ See also <link linkend="ADDSHARECOMMAND"><parameter>add share
command</parameter></link>, <link linkend="CHANGESHARECOMMAND"><parameter>change
- share</parameter></link>.
+ share command</parameter></link>.
</para>
<para>Default: <emphasis>none</emphasis></para>
@@ -2022,11 +2044,11 @@
<listitem><para>This option is used when Samba is attempting to
delete a directory that contains one or more vetoed directories
(see the <link linkend="VETOFILES"><parameter>veto files</parameter></link>
- option). If this option is set to False (the default) then if a vetoed
+ option). If this option is set to <constant>false</constant> (the default) then if a vetoed
directory contains any non-vetoed files or directories then the
directory delete will fail. This is usually what you want.</para>
- <para>If this option is set to <constant>True</constant>, then Samba
+ <para>If this option is set to <constant>true</constant>, then Samba
will attempt to recursively delete any files and directories within
the vetoed directory. This can be useful for integration with file
serving systems such as NetAtalk which create meta-files within
@@ -2194,7 +2216,7 @@
Samba server through other means can easily bypass this restriction,
so it is primarily useful for standalone "appliance" systems.
Administrators of most normal systems will probably want to leave
- it as the default of 0777.</para>
+ it as the default of <constant>0777</constant>.</para>
<para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>
force directory security mode</parameter></link>, <link
@@ -2206,6 +2228,29 @@
<para>Example: <command>directory security mask = 0700</command></para>
</listitem>
</varlistentry>
+
+
+
+ <varlistentry>
+ <term><anchor id="DISABLESPOOLSS">disable spoolss (G)</term>
+ <listitem><para>Enabling this parameter will disables Samba's support
+ for the SPOOLSS set of MS-RPC's and will yield identical behavior
+ as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
+ Lanman style printing commands. Windows 9x/ME will be uneffected by
+ the parameter. However, this will also disable the ability to upload
+ printer drivers to a Samba server via the Windows NT Add Printer
+ Wizard or by using the NT printer properties dialog window. It will
+ also disable the capability of Windows NT/2000 clients to download
+ print drivers from the Samba host upon demand.
+ <emphasis>Be very careful about enabling this parameter.</emphasis>
+ </para>
+
+ <para>See also <link linkend="USECLIENTDRIVER">use client driver</link>
+ </para>
+
+ <para>Default : <command>disable spoolss = no</command></para>
+ </listitem>
+ </varlistentry>
@@ -2281,7 +2326,7 @@
<varlistentry>
<term><anchor id="DOMAINLOGONS">domain logons (G)</term>
- <listitem><para>If set to true, the Samba server will serve
+ <listitem><para>If set to <constant>true</constant>, the Samba server will serve
Windows 95/98 Domain logons for the <link linkend="WORKGROUP">
<parameter>workgroup</parameter></link> it is in. Samba 2.2 also
has limited capability to act as a domain controller for Windows
@@ -2356,7 +2401,7 @@
<varlistentry>
<term><anchor id="DOSFILEMODE">dos filemode (S)</term>
<listitem><para> The default behavior in Samba is to provide
- UNIX-like behavor where only the owner of a file/directory is
+ UNIX-like behavior where only the owner of a file/directory is
able to change the permissions on it. However, this behavior
is often confusing to DOS/Windows users. Enabling this parameter
allows a user who has write access to the file (by whatever
@@ -2406,7 +2451,7 @@
default, Samba runs with POSIX semantics and refuses to change the
timestamp on a file if the user <command>smbd</command> is acting
on behalf of is not the file owner. Setting this option to <constant>
- True</constant> allows DOS semantics and smbd will change the file
+ true</constant> allows DOS semantics and <ulink url="smbd.8.html">smbd</ulink> will change the file
timestamp as DOS requires.</para>
<para>Default: <command>dos filetimes = no</command></para></listitem>
@@ -2440,16 +2485,15 @@
<varlistentry>
<term><anchor id="ENHANCEDBROWSING">enhanced browsing (G)</term>
<listitem><para>This option enables a couple of enhancements to
- cross-subnet browse propogation that have been added in Samba
+ cross-subnet browse propagation that have been added in Samba
but which are not standard in Microsoft implementations.
- <emphasis>These enhancements are currently only available in
- the HEAD Samba CVS tree (not Samba 2.2.x).</emphasis></para>
+ </para>
- <para>The first enhancement to browse propogation consists of a regular
+ <para>The first enhancement to browse propagation consists of a regular
wildcard query to a Samba WINS server for all Domain Master Browsers,
- followed by a browse synchronisation with each of the returned
+ followed by a browse synchronization with each of the returned
DMBs. The second enhancement consists of a regular randomised browse
- synchronisation with all currently known DMBs.</para>
+ synchronization with all currently known DMBs.</para>
<para>You may wish to disable this option if you have a problem with empty
workgroups not disappearing from browse lists. Due to the restrictions
@@ -2457,7 +2501,7 @@
to stay around forever which can be annoying.</para>
<para>In general you should leave this option enabled as it makes
- cross-subnet browse propogation much more reliable.</para>
+ cross-subnet browse propagation much more reliable.</para>
<para>Default: <command>enhanced browsing = yes</command></para>
</listitem>
@@ -2517,7 +2561,7 @@
reported by Samba will be updated whenever a file is created or
or deleted in the directory. NMAKE finds all object files in
the object directory. The timestamp of the last one built is then
- compared to the timestamp of the object dircetory. If the
+ compared to the timestamp of the object directory. If the
directory's timestamp if newer, then all object files
will be rebuilt. Enabling this option
ensures directories always predate their contents and an NMAKE build
@@ -2596,7 +2640,7 @@
set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
this mask on access control lists also, they need to set the <link
linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
- mask</parameter></link> to true.</para>
+ mask</parameter></link> to <constant>true</constant>.</para>
<para>See also the parameter <link linkend="CREATEMASK"><parameter>create
mask</parameter></link> for details on masking mode bits on files.</para>
@@ -2630,7 +2674,7 @@
set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
this mask on access control lists also, they need to set the <link
linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
- mask</parameter></link> to true.</para>
+ mask</parameter></link> to <constant>true</constant>.</para>
<para>See also the parameter <link linkend="DIRECTORYMASK"><parameter>
directory mask</parameter></link> for details on masking mode bits
@@ -2812,7 +2856,7 @@
caching algorithm will be used to reduce the time taken for getwd()
calls. This can have a significant impact on performance, especially
when the <link linkend="WIDELINKS"><parameter>wide links</parameter>
- </link>parameter is set to <constant>False</constant>.</para>
+ </link>parameter is set to <constant>false</constant>.</para>
<para>Default: <command>getwd cache = yes</command></para>
</listitem>
@@ -2945,9 +2989,19 @@
<varlistentry>
+ <term><anchor id="HIDEUNREADABLE">hide unreadable (S)</term>
+ <listitem><para>This parameter prevents clients from seeing the
+ existance of files that cannot be read. Defaults to off.</para>
+
+ <para>Default: <command>hide unreadable = no</command></para></listitem>
+ </varlistentry>
+
+
+
+ <varlistentry>
<term><anchor id="HOMEDIRMAP">homedir map (G)</term>
<listitem><para>If<link linkend="NISHOMEDIR"><parameter>nis homedir
- </parameter></link> is <constant>True</constant>, and <ulink
+ </parameter></link> is <constant>true</constant>, and <ulink
url="smbd.8.html"><command>smbd(8)</command></ulink> is also acting
as a Win95/98 <parameter>logon server</parameter> then this parameter
specifies the NIS (or YP) map from which the server for the user's
@@ -3088,7 +3142,7 @@
<parameter>hosts allow</parameter></link> which is about hosts
access to services and is more useful for guest services. <parameter>
hosts equiv</parameter> may be useful for NT clients which will
- not supply passwords to samba.</para>
+ not supply passwords to Samba.</para>
<para><emphasis>NOTE :</emphasis> The use of <parameter>hosts equiv
</parameter> can be a major security hole. This is because you are
@@ -3148,7 +3202,7 @@
inheritance (the code explicitly prohibits this).</para>
<para>This can be particularly useful on large systems with
- many users, perhaps several thousand,to allow a single [homes]
+ many users, perhaps several thousand, to allow a single [homes]
share to be used flexibly by each user.</para>
<para>See also <link linkend="CREATEMASK"><parameter>create mask
@@ -3234,7 +3288,7 @@
'+' and '&' may be used at the start of the name in either order
so the value <parameter>+&amp;group</parameter> means check the
UNIX group database, followed by the NIS netgroup database, and
- the value <parameter>&+group"</parameter> means check the NIS
+ the value <parameter>&+group</parameter> means check the NIS
netgroup database, followed by the UNIX group database (the
same as the '@' prefix).</para>
@@ -3286,9 +3340,9 @@
SMB/CIFS, NFS and local file access (and is a <emphasis>very</emphasis>
cool feature :-).</para>
- <para>This parameter defaults to <constant>on</constant> on systems
- that have the support, and <constant>off</constant> on systems that
- don't. You should never need to touch this parameter.</para>
+ <para>This parameter defaults to <constant>on</constant>, but is translated
+ to a no-op on systems that no not have the necessary kernel support.
+ You should never need to touch this parameter.</para>
<para>See also the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
</link> and <link linkend="LEVEL2OPLOCKS"><parameter>level2 oplocks
@@ -3303,8 +3357,8 @@
<varlistentry>
<term><anchor id="LANMANAUTH">lanman auth (G)</term>
- <listitem><para>This parameter determines whether or not smbd will
- attempt to authentication users using the LANMAN password hash.
+ <listitem><para>This parameter determines whether or not <ulink url="smbd.8.html">smbd</ulink> will
+ attempt to authenticate users using the LANMAN password hash.
If disabled, only clients which support NT password hashes (e.g. Windows
NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
network client) will be able to connect to the Samba host.</para>
@@ -3314,7 +3368,27 @@
</varlistentry>
+
+
+
+ <varlistentry>
+ <term><anchor id="LARGEREADWRITE">large readwrite (G)</term>
+ <listitem><para>This parameter determines whether or not <ulink url="smbd.8.html">smbd</ulink>
+ supports the new 64k streaming read and write varient SMB requests introduced
+ with Windows 2000. Note that due to Windows 2000 client redirector bugs
+ this requires Samba to be running on a 64-bit capable operating system such
+ as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with
+ Windows 2000 clients. Defaults to off. Not as tested as some other Samba
+ code paths.
+ </para>
+ <para>Default : <command>large readwrite = no</command></para>
+ </listitem>
+ </varlistentry>
+
+
+
+
<varlistentry>
<term><anchor id="LEVEL2OPLOCKS">level2 oplocks (S)</term>
@@ -3345,7 +3419,7 @@
oplocks</parameter></link> are supported then level2 oplocks are
not granted (even if this parameter is set to <constant>yes</constant>).
Note also, the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
- </link> parameter must be set to "true" on this share in order for
+ </link> parameter must be set to <constant>true</constant> on this share in order for
this parameter to have any effect.</para>
<para>See also the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
@@ -3424,15 +3498,15 @@
<term><anchor id="LOCALMASTER">local master (G)</term>
<listitem><para>This option allows <ulink url="nmbd.8.html"><command>
nmbd(8)</command></ulink> to try and become a local master browser
- on a subnet. If set to <constant>False</constant> then <command>
+ on a subnet. If set to <constant>false</constant> then <command>
nmbd</command> will not attempt to become a local master browser
on a subnet and will also lose in all browsing elections. By
- default this value is set to true. Setting this value to true doesn't
+ default this value is set to <constant>true</constant>. Setting this value to <constant>true</constant> doesn't
mean that Samba will <emphasis>become</emphasis> the local master
browser on a subnet, just that <command>nmbd</command> will <emphasis>
participate</emphasis> in elections for local master browser.</para>
- <para>Setting this value to False will cause <command>nmbd</command>
+ <para>Setting this value to <constant>false</constant> will cause <command>nmbd</command>
<emphasis>never</emphasis> to become a local master browser.</para>
<para>Default: <command>local master = yes</command></para>
@@ -3478,7 +3552,7 @@
<para>This option <emphasis>may</emphasis> be useful for read-only
filesystems which <emphasis>may</emphasis> not need locking (such as
- cdrom drives), although setting this parameter of <constant>no</constant>
+ CDROM drives), although setting this parameter of <constant>no</constant>
is not really recommended even in this case.</para>
<para>Be careful about disabling locking either globally or in a
@@ -3560,7 +3634,7 @@
<para>This tells Samba to return the above string, with
substitutions made when a client requests the info, generally
in a NetUserGetInfo request. Win9X clients truncate the info to
- \\server\share when a user does <command>net use /home"</command>
+ \\server\share when a user does <command>net use /home</command>
but use the whole string when dealing with profiles.</para>
<para>Note that in prior versions of Samba, the <link linkend="LOGONPATH">
@@ -3598,7 +3672,7 @@
<para>The share and the path must be readable by the user for
the preferences and directories to be loaded onto the Windows NT
- client. The share must be writeable when the logs in for the first
+ client. The share must be writeable when the user logs in for the first
time, in order that the Windows NT client can create the NTuser.dat
and other directories.</para>
@@ -3632,7 +3706,7 @@
<listitem><para>This parameter specifies the batch file (.bat) or
NT command file (.cmd) to be downloaded and run on a machine when
a user successfully logs in. The file must contain the DOS
- style cr/lf line endings. Using a DOS-style editor to create the
+ style CR/LF line endings. Using a DOS-style editor to create the
file is recommended.</para>
<para>The script must be a relative path to the [netlogon]
@@ -3643,7 +3717,7 @@
<para><filename>/usr/local/samba/netlogon/STARTUP.BAT</filename></para>
- <para>The contents of the batch file is entirely your choice. A
+ <para>The contents of the batch file are entirely your choice. A
suggested command would be to add <command>NET TIME \\SERVER /SET
/YES</command>, to force every machine to synchronize clocks with
the same time server. Another use would be to add <command>NET USE
@@ -3680,9 +3754,9 @@
of implementing this is by using job priorities, where jobs
having a too low priority won't be sent to the printer.</para>
- <para>If a <parameter>%p</parameter> is given then the printername
+ <para>If a <parameter>%p</parameter> is given then the printer name
is put in its place. A <parameter>%j</parameter> is replaced with
- the job number (an integer). On HPUX (see <parameter>printing = hpux
+ the job number (an integer). On HPUX (see <parameter>printing=hpux
</parameter>), if the <parameter>-p%p</parameter> option is added
to the lpq command, the job will show up with the correct status, i.e.
if the job priority is lower than the set fence priority it will
@@ -3763,7 +3837,7 @@
server reports on the first printer service connected to by the
client. This only happens if the connection number sent is invalid.</para>
- <para>If a <parameter>%p</parameter> is given then the printername
+ <para>If a <parameter>%p</parameter> is given then the printer name
is put in its place. Otherwise it is placed at the end of the
command.</para>
@@ -3794,7 +3868,7 @@
also the <link linkend="LPPAUSECOMMAND"><parameter>lppause command
</parameter></link> parameter.</para>
- <para>If a <parameter>%p</parameter> is given then the printername
+ <para>If a <parameter>%p</parameter> is given then the printer name
is put in its place. A <parameter>%j</parameter> is replaced with
the job number (an integer).</para>
@@ -3831,7 +3905,7 @@
<para>This command should be a program or script which takes
a printer name and job number, and deletes the print job.</para>
- <para>If a <parameter>%p</parameter> is given then the printername
+ <para>If a <parameter>%p</parameter> is given then the printer name
is put in its place. A <parameter>%j</parameter> is replaced with
the job number (an integer).</para>
@@ -3855,7 +3929,7 @@
<varlistentry>
<term><anchor id="MACHINEPASSWORDTIMEOUT">machine password timeout (G)</term>
- <listitem><para>If a Samba server is a member of an Windows
+ <listitem><para>If a Samba server is a member of a Windows
NT Domain (see the <link linkend="SECURITYEQUALSDOMAIN">security = domain</link>)
parameter) then periodically a running <ulink url="smbd.8.html">
smbd(8)</ulink> process will try and change the MACHINE ACCOUNT
@@ -3901,8 +3975,8 @@
executed on behalf of the connected user.</para>
<para>Scripts executed in this way will be deleted upon
- completion assuming that the user has the appripriate level
- of priviledge and the ile permissions allow the deletion.</para>
+ completion assuming that the user has the appropriate level
+ of privilege and the file permissions allow the deletion.</para>
<para>If the script generates output, output will be sent to
the file specified by the <link linkend="MAGICOUTPUT"><parameter>
@@ -3937,7 +4011,7 @@
<varlistentry>
<term><anchor id="MANGLEDMAP">mangled map (S)</term>
<listitem><para>This is for those who want to directly map UNIX
- file names which can not be represented on Windows/DOS. The mangling
+ file names which cannot be represented on Windows/DOS. The mangling
of names is not always what is needed. In particular you may have
documents with file extensions that differ between DOS and UNIX.
For example, under UNIX it is common to use <filename>.html</filename>
@@ -3950,7 +4024,7 @@
<para><command>mangled map = (*.html *.htm)</command></para>
<para>One very useful case is to remove the annoying <filename>;1
- </filename> off the ends of filenames on some CDROMS (only visible
+ </filename> off the ends of filenames on some CDROMs (only visible
under some UNIXes). To do this use a map of (*;1 *;).</para>
<para>Default: <emphasis>no mangled map</emphasis></para>
@@ -4032,12 +4106,12 @@
<para>The larger this value, the more likely it is that mangled
names can be successfully converted to correct long UNIX names.
- However, large stack sizes will slow most directory access. Smaller
+ However, large stack sizes will slow most directory accesses. Smaller
stacks save memory in the server (each stack element costs 256 bytes).
</para>
<para>It is not possible to absolutely guarantee correct long
- file names, so be prepared for some surprises!</para>
+ filenames, so be prepared for some surprises!</para>
<para>Default: <command>mangled stack = 50</command></para>
<para>Example: <command>mangled stack = 100</command></para>
@@ -4235,7 +4309,7 @@
<varlistentry>
<term><anchor id="MAXMUX">max mux (G)</term>
<listitem><para>This option controls the maximum number of
- outstanding simultaneous SMB operations that samba tells the client
+ outstanding simultaneous SMB operations that Samba tells the client
it will allow. You should never need to set this parameter.</para>
<para>Default: <command>max mux = 50</command></para>
@@ -4321,10 +4395,10 @@
<listitem><para>This parameter limits the maximum number of
<ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
processes concurrently running on a system and is intended
- as a stop gap to prevent degrading service to clients in the event
+ as a stopgap to prevent degrading service to clients in the event
that the server has insufficient resources to handle more than this
number of connections. Remember that under normal operating
- conditions, each user will have an smbd associated with him or her
+ conditions, each user will have an <ulink url="smbd.8.html">smbd</ulink> associated with him or her
to handle connections to all shares from a given host.
</para>
@@ -4402,7 +4476,7 @@
THAT THIS COMMAND RETURN IMMEDIATELY</emphasis>. That's why I
have the '&' on the end. If it doesn't return immediately then
your PCs may freeze when sending messages (they should recover
- after 30secs, hopefully).</para>
+ after 30 seconds, hopefully).</para>
<para>All messages are delivered as the global guest user.
The command takes the standard substitutions, although <parameter>
@@ -4597,7 +4671,7 @@
connected subnet.</para></listitem>
</itemizedlist>
- <para>Default: <command>name resolve order = lmhosts wins host bcast
+ <para>Default: <command>name resolve order = lmhosts host wins bcast
</command></para>
<para>Example: <command>name resolve order = lmhosts bcast host
</command></para>
@@ -4756,7 +4830,7 @@
<varlistentry>
<term><anchor id="OBEYPAMRESTRICTIONS">obey pam restrictions (G)</term>
- <listitem><para>When Samba 2.2 is configure to enable PAM support
+ <listitem><para>When Samba 2.2 is configured to enable PAM support
(i.e. --with-pam), this parameter will control whether or not Samba
should obey PAM's account and session management directives. The
default behavior is to use PAM for clear text authentication only
@@ -4837,7 +4911,7 @@
improve the efficiency of the granting of oplocks under multiple
client contention for the same file.</para>
- <para>In brief it specifies a number, which causes smbd not to
+ <para>In brief it specifies a number, which causes <ulink url="smbd.8.html">smbd</ulink> not to
grant an oplock even when requested if the approximate number of
clients contending for an oplock on the same file goes over this
limit. This causes <command>smbd</command> to behave in a similar
@@ -4856,7 +4930,7 @@
<varlistentry>
<term><anchor id="OPLOCKS">oplocks (S)</term>
- <listitem><para>This boolean option tells smbd whether to
+ <listitem><para>This boolean option tells <command>smbd</command> whether to
issue oplocks (opportunistic locks) to file open requests on this
share. The oplock code can dramatically (approx. 30% or more) improve
the speed of access to files on Samba servers. It allows the clients
@@ -4917,7 +4991,7 @@
name&gt;.&lt;device name&gt;</para>
<para>For example, a valid entry using the HP LaserJet 5
- printer driver woudl appear as <command>HP LaserJet 5L = LASERJET.HP
+ printer driver would appear as <command>HP LaserJet 5L = LASERJET.HP
LaserJet 5L</command>.</para>
<para>The need for the file is due to the printer driver namespace
@@ -4934,13 +5008,15 @@
<varlistentry>
<term><anchor id="PAMPASSWORDCHANGE">pam password change (G)</term>
- <listitem><para>With the addition of better PAM support in Samba 2.2,
- this parameter, it is possible to use PAM's password change control
- flag for Samba. If enabled, then PAM will be used for password
- changes when requested by an SMB client, and the <link
- linkend="PASSWDCHAT"><parameter>passwd chat</parameter></link> must be
- be changed to work with the pam prompts.
- </para>
+ <listitem><para>With the addition of better PAM support in Samba 2.2,
+ this parameter, it is possible to use PAM's password change control
+ flag for Samba. If enabled, then PAM will be used for password
+ changes when requested by an SMB client instead of the program listed in
+ <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter></link>.
+ It should be possible to enable this without changing your
+ <link linkend="PASSWDCHAT"><parameter>passwd chat</parameter></link>
+ parameter for most setups.
+ </para>
<para>Default: <command>pam password change = no</command></para>
@@ -4967,7 +5043,7 @@
<listitem><para>This string controls the <emphasis>"chat"</emphasis>
conversation that takes places between <ulink
url="smbd.8.html">smbd</ulink> and the local password changing
- program to change the users password. The string describes a
+ program to change the user's password. The string describes a
sequence of response-receive pairs that <ulink url="smbd.8.html">
smbd(8)</ulink> uses to determine what to send to the
<link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter>
@@ -4977,40 +5053,36 @@
<para>This chat sequence is often quite site specific, depending
on what local methods are used for password control (such as NIS
etc).</para>
+ <para>Note that this parameter only is only used if the <link
+ linkend="UNIXPASSWORDSYNC"><parameter>unix
+ password sync</parameter></link> parameter is set to <constant>yes</constant>. This
+ sequence is then called <emphasis>AS ROOT</emphasis> when the SMB password
+ in the smbpasswd file is being changed, without access to the old
+ password cleartext. This means that root must be able to reset the user's password
+ without knowing the text of the previous password. In the presence of NIS/YP,
+ this means that the <link linkend="PASSWDPROGRAM">passwd program</link> must be
+ executed on the NIS master.
+ </para>
- <para>The string can contain the macros <parameter>%o</parameter>
- and <parameter>%n</parameter> which are substituted for the old
- and new passwords respectively. It can also contain the standard
- macros <constant>\n</constant>, <constant>\r</constant>, <constant>
- \t</constant> and <constant>%s</constant> to give line-feed,
- carriage-return, tab and space.</para>
-
- <para>The string can also contain a '*' which matches
- any sequence of characters.</para>
- <para>Double quotes can be used to collect strings with spaces
+ <para>The string can contain the macro <parameter>%n</parameter> which is substituted
+ for the new password. The chat sequence can also contain the standard
+ macros <constant>\n</constant>, <constant>\r</constant>, <constant>
+ \t</constant> and <constant>\s</constant> to give line-feed,
+ carriage-return, tab and space. The chat sequence string can also contain
+ a '*' which matches any sequence of characters.
+ Double quotes can be used to collect strings with spaces
in them into a single string.</para>
<para>If the send string in any part of the chat sequence
- is a fullstop ".", then no string is sent. Similarly,
- if the expect string is a fullstop then no string is expected.</para>
+ is a full stop ".", then no string is sent. Similarly,
+ if the expect string is a full stop then no string is expected.</para>
- <para>Note that if the <link linkend="UNIXPASSWORDSYNC"><parameter>unix
- password sync</parameter></link> parameter is set to true, then this
- sequence is called <emphasis>AS ROOT</emphasis> when the SMB password
- in the smbpasswd file is being changed, without access to the old
- password cleartext. In this case the old password cleartext is set
- to "" (the empty string).</para>
-
- <para>Also, if the <link linkend="PAMPASSWORDCHANGE"><parameter>pam
- password change</parameter></link> parameter is set to true, then the
- chat sequence should consist of three elements. The first element should
- match the pam prompt for the old password, the second element should match
- the pam prompt for the first request for the new password, and the final
- element should match the pam prompt for the second request for the new password.
- These matches are done case insentively. Under most conditions this change
- is done as root so the prompt for the old password will never be matched.
- </para>
+ <para>If the <link linkend="PAMPASSWORDCHANGE"><parameter>pam
+ password change</parameter></link> parameter is set to true, the chat pairs
+ may be matched in any order, and sucess is determined by the PAM result,
+ not any particular output. The \n macro is ignored for PAM conversions.
+ </para>
<para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix password
sync</parameter></link>, <link linkend="PASSWDPROGRAM"><parameter>
@@ -5039,12 +5111,15 @@
to be seen in the <command>smbd</command> log. It is available to help
Samba admins debug their <parameter>passwd chat</parameter> scripts
when calling the <parameter>passwd program</parameter> and should
- be turned off after this has been done. This parameter is off by
- default.</para>
+ be turned off after this has been done. This option has no effect if the
+ <link linkend="PAMPASSWORDCHANGE"><parameter>pam password change</parameter></link>
+ paramter is set. This parameter is off by default.</para>
+
- <para>See also <<link linkend="PASSWDCHAT"><parameter>passwd chat</parameter>
- </link>, <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter>
- </link>.</para>
+ <para>See also <link linkend="PASSWDCHAT"><parameter>passwd chat</parameter>
+ </link>, <link linkend="PAMPASSWORDCHANGE"><parameter>pam password change</parameter>
+ </link>, <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter>
+ </link>.</para>
<para>Default: <command>passwd chat debug = no</command></para>
</listitem>
@@ -5066,7 +5141,7 @@
it.</para>
<para><emphasis>Note</emphasis> that if the <parameter>unix
- password sync</parameter> parameter is set to <constant>True
+ password sync</parameter> parameter is set to <constant>true
</constant> then this program is called <emphasis>AS ROOT</emphasis>
before the SMB password in the <ulink url="smbpasswd.5.html">smbpasswd(5)
</ulink> file is changed. If this UNIX password change fails, then
@@ -5077,7 +5152,7 @@
is set this parameter <emphasis>MUST USE ABSOLUTE PATHS</emphasis>
for <emphasis>ALL</emphasis> programs called, and must be examined
for security implications. Note that by default <parameter>unix
- password sync</parameter> is set to <constant>False</constant>.</para>
+ password sync</parameter> is set to <constant>false</constant>.</para>
<para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix
password sync</parameter></link>.</para>
@@ -5277,7 +5352,7 @@
substitutions. The command may be run as the root on some
systems.</para>
- <para>An interesting example may be do unmount server
+ <para>An interesting example may be to unmount server
resources:</para>
<para><command>postexec = /etc/umount /cdrom</command></para>
@@ -5298,7 +5373,7 @@
<varlistentry>
<term><anchor id="POSTSCRIPT">postscript (S)</term>
<listitem><para>This parameter forces a printer to interpret
- the print files as postscript. This is done by adding a <constant>%!
+ the print files as PostScript. This is done by adding a <constant>%!
</constant> to the start of print output.</para>
<para>This is most useful when you have lots of PCs that persist
@@ -5354,7 +5429,7 @@
url="nmbd.8.html">nmbd(8)</ulink> is a preferred master browser
for its workgroup.</para>
- <para>If this is set to true, on startup, <command>nmbd</command>
+ <para>If this is set to <constant>true</constant>, on startup, <command>nmbd</command>
will force an election, and it will have a slight advantage in
winning the election. It is recommended that this parameter is
used in conjunction with <command><link linkend="DOMAINMASTER"><parameter>
@@ -5591,11 +5666,11 @@
<varlistentry>
<term><anchor id="PRINTERDRIVER">printer driver (S)</term>
- <listitem><para><emphasis>Note :</emphasis>This is a depreciated
+ <listitem><para><emphasis>Note :</emphasis>This is a deprecated
parameter and will be removed in the next major release
following version 2.2. Please see the instructions in
- <filename>PRINTER_DRIVER2.txt</filename> in the <filename>docs
- </filename> of the Samba distribution for more information
+ the <ulink url="printer_driver2.html">Samba 2.2. Printing
+ HOWTO</ulink> for more information
on the new method of loading printer drivers onto a Samba server.
</para>
@@ -5624,11 +5699,11 @@
<varlistentry>
<term><anchor id="PRINTERDRIVERFILE">printer driver file (G)</term>
- <listitem><para><emphasis>Note :</emphasis>This is a depreciated
+ <listitem><para><emphasis>Note :</emphasis>This is a deprecated
parameter and will be removed in the next major release
following version 2.2. Please see the instructions in
- <filename>PRINTER_DRIVER2.txt</filename> in the <filename>docs
- </filename> of the Samba distribution for more information
+ the <ulink url="printer_driver2.html">Samba 2.2. Printing
+ HOWTO</ulink> for more information
on the new method of loading printer drivers onto a Samba server.
</para>
@@ -5642,7 +5717,7 @@
<para>This file is created from Windows 95 <filename>msprint.inf
</filename> files found on the Windows 95 client system. For more
details on setting up serving of printer drivers to Windows 95
- clients, see the documentation file in the <filename>docs/</filename>
+ clients, see the outdated documentation file in the <filename>docs/</filename>
directory, <filename>PRINTER_DRIVER.txt</filename>.</para>
<para>See also <link linkend="PRINTERDRIVERLOCATION"><parameter>
@@ -5660,11 +5735,11 @@
<varlistentry>
<term><anchor id="PRINTERDRIVERLOCATION">printer driver location (S)</term>
- <listitem><para><emphasis>Note :</emphasis>This is a depreciated
+ <listitem><para><emphasis>Note :</emphasis>This is a deprecated
parameter and will be removed in the next major release
following version 2.2. Please see the instructions in
- <filename>PRINTER_DRIVER2.txt</filename> in the <filename>docs
- </filename> of the Samba distribution for more information
+ the <ulink url="printer_driver2.html">Samba 2.2. Printing
+ HOWTO</ulink> for more information
on the new method of loading printer drivers onto a Samba server.
</para>
@@ -5677,7 +5752,7 @@
<para>Where MACHINE is the NetBIOS name of your Samba server,
and PRINTER$ is a share you set up for serving printer driver
- files. For more details on setting this up see the documentation
+ files. For more details on setting this up see the outdated documentation
file in the <filename>docs/</filename> directory, <filename>
PRINTER_DRIVER.txt</filename>.</para>
@@ -5726,7 +5801,7 @@
<parameter>lpq command</parameter>, <parameter>lppause command
</parameter>, <parameter>lpresume command</parameter>, and
<parameter>lprm command</parameter> if specified in the
- [global]f> section.</para>
+ [global] section.</para>
<para>Currently eight printing styles are supported. They are
<constant>BSD</constant>, <constant>AIX</constant>,
@@ -5770,17 +5845,17 @@
<varlistentry>
<term><anchor id="QUEUEPAUSECOMMAND">queuepause command (S)</term>
<listitem><para>This parameter specifies the command to be
- executed on the server host in order to pause the printerqueue.</para>
+ executed on the server host in order to pause the printer queue.</para>
<para>This command should be a program or script which takes
- a printer name as its only parameter and stops the printerqueue,
+ a printer name as its only parameter and stops the printer queue,
such that no longer jobs are submitted to the printer.</para>
<para>This command is not supported by Windows for Workgroups,
- but can be issued from the Printer's window under Windows 95
+ but can be issued from the Printers window under Windows 95
and NT.</para>
- <para>If a <parameter>%p</parameter> is given then the printername
+ <para>If a <parameter>%p</parameter> is given then the printer name
is put in its place. Otherwise it is placed at the end of the command.
</para>
@@ -5799,20 +5874,20 @@
<varlistentry>
<term><anchor id="QUEUERESUMECOMMAND">queueresume command (S)</term>
<listitem><para>This parameter specifies the command to be
- executed on the server host in order to resume the printerqueue. It
+ executed on the server host in order to resume the printer queue. It
is the command to undo the behavior that is caused by the
previous parameter (<link linkend="QUEUEPAUSECOMMAND"><parameter>
queuepause command</parameter></link>).</para>
<para>This command should be a program or script which takes
- a printer name as its only parameter and resumes the printerqueue,
+ a printer name as its only parameter and resumes the printer queue,
such that queued jobs are resubmitted to the printer.</para>
<para>This command is not supported by Windows for Workgroups,
- but can be issued from the Printer's window under Windows 95
+ but can be issued from the Printers window under Windows 95
and NT.</para>
- <para>If a <parameter>%p</parameter> is given then the printername
+ <para>If a <parameter>%p</parameter> is given then the printer name
is put in its place. Otherwise it is placed at the end of the
command.</para>
@@ -5944,7 +6019,7 @@
<para><command>remote announce = 192.168.2.255/SERVERS
192.168.4.255/STAFF</command></para>
- <para>the above line would cause nmbd to announce itself
+ <para>the above line would cause <command>nmbd</command> to announce itself
to the two given IP addresses using the given workgroup names.
If you leave out the workgroup name then the one given in
the <link linkend="WORKGROUP"><parameter>workgroup</parameter></link>
@@ -5968,10 +6043,10 @@
<term><anchor id="REMOTEBROWSESYNC">remote browse sync (G)</term>
<listitem><para>This option allows you to setup <ulink
url="nmbd.8.html">nmbd(8)</ulink> to periodically request
- synchronization of browse lists with the master browser of a samba
+ synchronization of browse lists with the master browser of a Samba
server that is on a remote segment. This option will allow you to
gain browse lists for multiple workgroups across routed networks. This
- is done in a manner that does not work with any non-samba servers.</para>
+ is done in a manner that does not work with any non-Samba servers.</para>
<para>This is useful if you want your Samba server and all local
clients to appear in a remote workgroup for which the normal browse
@@ -5992,7 +6067,7 @@
of known browse masters if your network config is that stable. If
a machine IP address is given Samba makes NO attempt to validate
that the remote machine is available, is listening, nor that it
- is in fact the browse master on it's segment.</para>
+ is in fact the browse master on its segment.</para>
<para>Default: <command>remote browse sync = &lt;empty string&gt;
</command></para>
@@ -6003,12 +6078,12 @@
<varlistentry>
<term><anchor id="RESTRICTACLWITHMASK">restrict acl with mask (S)</term>
- <listitem><para>This is a boolean parameter. If set to false (default), then
- Creation of files with access control lists (ACLS) and modification of ACLs
+ <listitem><para>This is a boolean parameter. If set to <constant>false</constant> (default), then
+ creation of files with access control lists (ACLS) and modification of ACLs
using the Windows NT/2000 ACL editor will be applied directly to the file
or directory.</para>
- <para>If set to True, then all requests to set an ACL on a file will have the
+ <para>If set to <constant>true</constant>, then all requests to set an ACL on a file will have the
parameters <link linkend="CREATEMASK"><parameter>create mask</parameter></link>,
<link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>
applied before setting the ACL, and all requests to set an ACL on a directory will
@@ -6032,10 +6107,10 @@
<varlistentry>
<term><anchor id="RESTRICTANONYMOUS">restrict anonymous (G)</term>
- <listitem><para>This is a boolean parameter. If it is true, then
+ <listitem><para>This is a boolean parameter. If it is <constant>true</constant>, then
anonymous access to the server will be restricted, namely in the
case where the server is expecting the client to send a username,
- but it doesn't. Setting it to true will force these anonymous
+ but it doesn't. Setting it to <constant>true</constant> will force these anonymous
connections to be denied, and the client will be required to always
supply a username and password when connecting. Use of this parameter
is only recommended for homogeneous NT client environments.</para>
@@ -6045,10 +6120,10 @@
likes to use anonymous connections when refreshing the share list,
and this is a way to work around that.</para>
- <para>When restrict anonymous is true, all anonymous connections
+ <para>When restrict anonymous is <constant>true</constant>, all anonymous connections
are denied no matter what they are for. This can effect the ability
- of a machine to access the samba Primary Domain Controller to revalidate
- it's machine account after someone else has logged on the client
+ of a machine to access the Samba Primary Domain Controller to revalidate
+ its machine account after someone else has logged on the client
interactively. The NT client will display a message saying that
the machine's account in the domain doesn't exist or the password is
bad. The best way to deal with this is to reboot NT client machines
@@ -6081,7 +6156,7 @@
<varlistentry>
<term><anchor id="ROOTDIRECTORY">root directory (G)</term>
<listitem><para>The server will <command>chroot()</command> (i.e.
- Change it's root directory) to this directory on startup. This is
+ Change its root directory) to this directory on startup. This is
not strictly necessary for secure operation. Even without it the
server will deny access to files not in one of the service entries.
It may also check for, and deny access to, soft links to other
@@ -6115,7 +6190,7 @@
<listitem><para>This is the same as the <parameter>postexec</parameter>
parameter except that the command is run as root. This
is useful for unmounting filesystems
- (such as cdroms) after a connection is closed.</para>
+ (such as CDROMs) after a connection is closed.</para>
<para>See also <link linkend="POSTEXEC"><parameter>
postexec</parameter></link>.</para>
@@ -6129,8 +6204,8 @@
<term><anchor id="ROOTPREEXEC">root preexec (S)</term>
<listitem><para>This is the same as the <parameter>preexec</parameter>
parameter except that the command is run as root. This
- is useful for mounting filesystems (such as cdroms) after a
- connection is closed.</para>
+ is useful for mounting filesystems (such as CDROMs) when a
+ connection is opened.</para>
<para>See also <link linkend="PREEXEC"><parameter>
preexec</parameter></link> and <link linkend="PREEXECCLOSE">
@@ -6213,7 +6288,7 @@
<para><anchor id="SECURITYEQUALSSHARE"><emphasis>SECURITY = SHARE
</emphasis></para>
- <para>When clients connect to a share level security server then
+ <para>When clients connect to a share level security server they
need not log onto the server with a valid username and password before
attempting to connect to a shared resource (although modern clients
such as Windows 95/98 and Windows NT will send a logon request with
@@ -6279,7 +6354,7 @@
<para>See also the section <link linkend="VALIDATIONSECT">
NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
- <para><anchor id="SECURITYEQUALSUSER"><emphasis>SECURIYT = USER
+ <para><anchor id="SECURITYEQUALSUSER"><emphasis>SECURITY = USER
</emphasis></para>
<para>This is the default security setting in Samba 2.2.
@@ -6319,7 +6394,7 @@
<filename>ENCRYPTION.txt</filename> for details on how to set this
up.</para>
- <para><emphasis>Note</emphasis> that from the clients point of
+ <para><emphasis>Note</emphasis> that from the client's point of
view <command>security = server</command> is the same as <command>
security = user</command>. It only affects how the server deals
with the authentication, it does not in any way affect what the
@@ -6358,7 +6433,7 @@
exist as well as the account on the Domain Controller to allow
Samba to have a valid UNIX account to map file access to.</para>
- <para><emphasis>Note</emphasis> that from the clients point
+ <para><emphasis>Note</emphasis> that from the client's point
of view <command>security = domain</command> is the same as <command>security = user
</command>. It only affects how the server deals with the authentication,
it does not in any way affect what the client sees.</para>
@@ -6416,7 +6491,7 @@
Samba server through other means can easily bypass this
restriction, so it is primarily useful for standalone
"appliance" systems. Administrators of most normal systems will
- probably want to leave it set to 0777.</para>
+ probably want to leave it set to <constant>0777</constant>.</para>
<para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE">
<parameter>force directory security mode</parameter></link>,
@@ -6472,35 +6547,6 @@
- <varlistentry>
- <term><anchor id="SHAREMODES">share modes (S)</term>
- <listitem><para>This enables or disables the honoring of
- the <parameter>share modes</parameter> during a file open. These
- modes are used by clients to gain exclusive read or write access
- to a file.</para>
-
- <para>These open modes are not directly supported by UNIX, so
- they are simulated using shared memory, or lock files if your
- UNIX doesn't support shared memory (almost all do).</para>
-
- <para>The share modes that are enabled by this option are
- <constant>DENY_DOS</constant>, <constant>DENY_ALL</constant>,
- <constant>DENY_READ</constant>, <constant>DENY_WRITE</constant>,
- <constant>DENY_NONE</constant> and <constant>DENY_FCB</constant>.
- </para>
-
- <para>This option gives full share compatibility and enabled
- by default.</para>
-
- <para>You should <emphasis>NEVER</emphasis> turn this parameter
- off as many Windows applications will break if you do so.</para>
-
- <para>Default: <command>share modes = yes</command></para>
- </listitem>
- </varlistentry>
-
-
-
<varlistentry>
<term><anchor id="SHORTPRESERVECASE">short preserve case (S)</term>
@@ -6536,7 +6582,7 @@
Administrator privileges. If the user does not have administrative
access on the print server (i.e is not root or a member of the
<parameter>printer admin</parameter> group), the OpenPrinterEx()
- call fails and the clients another open call with a request for
+ call fails and the client makes another open call with a request for
a lower privilege level. This should succeed, however the APW
icon will not be displayed.</para>
@@ -6557,6 +6603,49 @@
+ <varlistentry>
+ <term><anchor id="SHUTDOWNSCRIPT">shutdown script (G)</term>
+ <listitem><para><emphasis>This parameter only exists in the HEAD cvs branch</emphasis>
+ This a full path name to a script called by
+ <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> that
+ should start a shutdown procedure.</para>
+
+ <para>This command will be run as the user connected to the
+ server.</para>
+
+ <para>%m %t %r %f parameters are expanded</para>
+ <para><parameter>%m</parameter> will be substituted with the
+ shutdown message sent to the server.</para>
+ <para><parameter>%t</parameter> will be substituted with the
+ number of seconds to wait before effectively starting the
+ shutdown procedure.</para>
+ <para><parameter>%r</parameter> will be substituted with the
+ switch <emphasis>-r</emphasis>. It means reboot after shutdown
+ for NT.
+ </para>
+ <para><parameter>%f</parameter> will be substituted with the
+ switch <emphasis>-f</emphasis>. It means force the shutdown
+ even if applications do not respond for NT.</para>
+
+ <para>Default: <emphasis>None</emphasis>.</para>
+ <para>Example: <command>abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f</command></para>
+ <para>Shutdown script example:
+ <programlisting>
+ #!/bin/bash
+
+ $time=0
+ let "time/60"
+ let "time++"
+
+ /sbin/shutdown $3 $4 +$time $1 &
+ </programlisting>
+ Shutdown does not return so we need to launch it in background.
+ </para>
+
+ <para>See also <link linkend="ABORTSHUTDOWNSCRIPT"><parameter>abort shutdown script</parameter></link>.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><anchor id="SMBPASSWDFILE">smb passwd file (G)</term>
@@ -6582,7 +6671,7 @@
support multiple virtual interfaces on the one server, each
with a different configuration.</para>
- <para>By default samba will accept connections on any
+ <para>By default Samba will accept connections on any
address.</para>
<para>Example: <command>socket address = 192.168.2.20</command>
@@ -6703,8 +6792,8 @@
current binary version of Samba.</para>
<para>This variable enables or disables the entire SSL mode. If
- it is set to <constant>no</constant>, the SSL enabled samba behaves
- exactly like the non-SSL samba. If set to <constant>yes</constant>,
+ it is set to <constant>no</constant>, the SSL-enabled Samba behaves
+ exactly like the non-SSL Samba. If set to <constant>yes</constant>,
it depends on the variables <link linkend="SSLHOSTS"><parameter>
ssl hosts</parameter></link> and <link linkend="SSLHOSTSRESIGN">
<parameter>ssl hosts resign</parameter></link> whether an SSL
@@ -6729,7 +6818,7 @@
<para>This variable defines where to look up the Certification
Authorities. The given directory should contain one file for
- each CA that samba will trust. The file name must be the hash
+ each CA that Samba will trust. The file name must be the hash
value over the "Distinguished Name" of the CA. How this directory
is set up is explained later in this document. All files within the
directory that don't fit into this naming scheme are ignored. You
@@ -6871,14 +6960,14 @@
this code is <emphasis>NOT</emphasis> enabled by default in any
current binary version of Samba.</para>
- <para>These two variables define whether samba will go
- into SSL mode or not. If none of them is defined, samba will
+ <para>These two variables define whether Samba will go
+ into SSL mode or not. If none of them is defined, Samba will
allow only SSL connections. If the <link linkend="SSLHOSTS">
<parameter>ssl hosts</parameter></link> variable lists
hosts (by IP-address, IP-address range, net group or name),
only these hosts will be forced into SSL mode. If the <parameter>
ssl hosts resign</parameter> variable lists hosts, only these
- hosts will NOT be forced into SSL mode. The syntax for these two
+ hosts will <emphasis>NOT</emphasis> be forced into SSL mode. The syntax for these two
variables is the same as for the <link linkend="HOSTSALLOW"><parameter>
hosts allow</parameter></link> and <link linkend="HOSTSDENY">
<parameter>hosts deny</parameter></link> pair of variables, only
@@ -7070,7 +7159,7 @@
<para>When strict locking is <constant>no</constant> the server does file
lock checks only when the client explicitly asks for them.</para>
- <para>Well behaved clients always ask for lock checks when it
+ <para>Well-behaved clients always ask for lock checks when it
is important, so in the vast majority of cases <command>strict
locking = no</command> is preferable.</para>
@@ -7089,7 +7178,7 @@
all outstanding data in kernel disk buffers has been safely stored
onto stable storage. This is very slow and should only be done
rarely. Setting this parameter to <constant>no</constant> (the
- default) means that smbd ignores the Windows applications requests for
+ default) means that <ulink url="smbd.8.html">smbd</ulink> ignores the Windows applications requests for
a sync call. There is only a possibility of losing data if the
operating system itself that Samba is running on crashes, so there is
little danger in this default setting. In addition, this fixes many
@@ -7120,10 +7209,10 @@
<term><anchor id="SYNCALWAYS">sync always (S)</term>
<listitem><para>This is a boolean parameter that controls
whether writes will always be written to stable storage before
- the write call returns. If this is false then the server will be
+ the write call returns. If this is <constant>false</constant> then the server will be
guided by the client's request in each write call (clients can
set a bit indicating that a particular write should be synchronous).
- If this is true then every write will be followed by a <command>fsync()
+ If this is <constant>true</constant> then every write will be followed by a <command>fsync()
</command> call to ensure the data is written to disk. Note that
the <parameter>strict sync</parameter> parameter must be set to
<constant>yes</constant> in order for this parameter to have
@@ -7172,10 +7261,7 @@
<varlistentry>
<term><anchor id="TEMPLATEHOMEDIR">template homedir (G)</term>
- <listitem><para><emphasis>NOTE:</emphasis> this parameter is
- only available in Samba 3.0.</para>
-
- <para>When filling out the user information for a Windows NT
+ <listitem><para>When filling out the user information for a Windows NT
user, the <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon
uses this parameter to fill in the home directory for that user.
If the string <parameter>%D</parameter> is present it is substituted
@@ -7191,10 +7277,7 @@
<varlistentry>
<term><anchor id="TEMPLATESHELL">template shell (G)</term>
- <listitem><para><emphasis>NOTE:</emphasis> this parameter is
- only available in Samba 3.0.</para>
-
- <para>When filling out the user information for a Windows NT
+ <listitem><para>When filling out the user information for a Windows NT
user, the <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon
uses this parameter to fill in the login shell for that user.</para>
@@ -7245,7 +7328,7 @@
<listitem><para>This parameter accepts an integer value which defines
a limit on the maximum number of print jobs that will be accepted
system wide at any given time. If a print job is submitted
- by a client which will exceed this number, then smbd will return an
+ by a client which will exceed this number, then <ulink url="smbd.8.html">smbd</ulink> will return an
error indicating that no space is available on the server. The
default value of 0 means that no such limit exists. This parameter
can be used to prevent a server from exceeding its capacity and is
@@ -7266,10 +7349,10 @@
<listitem><para>This boolean parameter controls whether Samba
attempts to synchronize the UNIX password with the SMB password
when the encrypted SMB password in the smbpasswd file is changed.
- If this is set to true the program specified in the <parameter>passwd
+ If this is set to <constant>true</constant> the program specified in the <parameter>passwd
program</parameter>parameter is called <emphasis>AS ROOT</emphasis> -
to allow the new UNIX password to be set without access to the
- old UNIX password (as the SMB password has change code has no
+ old UNIX password (as the SMB password change code has no
access to the old password cleartext, only the new).</para>
<para>See also <link linkend="PASSWDPROGRAM"><parameter>passwd
@@ -7313,11 +7396,48 @@
</varlistentry>
+ <varlistentry>
+ <term><anchor id="USECLIENTDRIVER">use client driver (S)</term>
+ <listitem><para>This parameter applies only to Windows NT/2000
+ clients. It has no affect on Windows 95/98/ME clients. When
+ serving a printer to Windows NT/2000 clients without first installing
+ a valid printer driver on the Samba host, the client will be required
+ to install a local printer driver. From this point on, the client
+ will treat the print as a local printer and not a network printer
+ connection. This is much the same behavior that will occur
+ when <command>disable spoolss = yes</command>. </para>
+
+ <para>The differentiating
+ factor is that under normal circumstances, the NT/2000 client will
+ attempt to open the network printer using MS-RPC. The problem is that
+ because the client considers the printer to be local, it will attempt
+ to issue the OpenPrinterEx() call requesting access rights associated
+ with the logged on user. If the user possesses local administator rights
+ but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
+ call will fail. The result is that the client will now display an "Access
+ Denied; Unable to connect" message in the printer queue window (even though
+ jobs may successfully be printed). </para>
+
+ <para>If this parameter is enabled for a printer, then any attempt
+ to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
+ to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
+ call to succeed. <emphasis>This parameter MUST not be able enabled
+ on a print share which has valid print driver installed on the Samba
+ server.</emphasis></para>
+
+ <para>See also <link linkend="DISABLESPOOLSS">disable spoolss</link>
+ </para>
+
+ <para>Default: <command>use client driver = no</command></para>
+ </listitem>
+ </varlistentry>
+
+
<varlistentry>
<term><anchor id="USERHOSTS">use rhosts (G)</term>
- <listitem><para>If this global parameter is a true, it specifies
- that the UNIX users <filename>.rhosts</filename> file in their home directory
+ <listitem><para>If this global parameter is <constant>true</constant>, it specifies
+ that the UNIX user's <filename>.rhosts</filename> file in their home directory
will be read to find the names of hosts and users who will be allowed
access without specifying a password.</para>
@@ -7384,7 +7504,7 @@
</parameter></link> parameter.</para>
<para>If any of the usernames begin with a '@' then the name
- will be looked up first in the yp netgroups list (if Samba
+ will be looked up first in the NIS netgroups list (if Samba
is compiled with netgroup support), followed by a lookup in
the UNIX groups database and will expand to a list of all users
in the group of that name.</para>
@@ -7394,7 +7514,7 @@
expand to a list of all users in the group of that name.</para>
<para>If any of the usernames begin with a '&'then the name
- will be looked up only in the yp netgroups database (if Samba
+ will be looked up only in the NIS netgroups database (if Samba
is compiled with netgroup support) and will expand to a list
of all users in the netgroup group of that name.</para>
@@ -7533,10 +7653,10 @@
<varlistentry>
- <term><anchor id="UTMP">utmp (S)</term>
+ <term><anchor id="UTMP">utmp (G)</term>
<listitem><para>This boolean parameter is only available if
Samba has been configured and compiled with the option <command>
- --with-utmp</command>. If set to True then Samba will attempt
+ --with-utmp</command>. If set to <constant>true</constant> then Samba will attempt
to add utmp or utmpx records (depending on the UNIX system) whenever a
connection is made to a Samba server. Sites may use this to record the
user connecting to a Samba share.</para>
@@ -7678,7 +7798,7 @@
to be deleted contains nothing but veto files this
deletion will <emphasis>fail</emphasis> unless you also set
the <parameter>delete veto files</parameter> parameter to
- <parameter>yes</parameter>.
+ <parameter>yes</parameter>.</para>
<para>Setting this parameter will affect the performance
of Samba, as it will be forced to check all files and directories
@@ -7751,7 +7871,7 @@
<varlistentry>
<term><anchor id="VFSOPTIONS">vfs options (S)</term>
<listitem><para>This parameter allows parameters to be passed
- to the vfs layer at initialisation time. The Samba VFS layer
+ to the vfs layer at initialization time. The Samba VFS layer
is new to Samba 2.2 and must be enabled at compile time
with --with-vfs. See also <link linkend="VFSOBJECT"><parameter>
vfs object</parameter></link>.</para>
@@ -7795,10 +7915,7 @@
<varlistentry>
<term><anchor id="WINBINDCACHETIME">winbind cache time</term>
- <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
- available in Samba 3.0.</para>
-
- <para>This parameter specifies the number of seconds the
+ <listitem><para>This parameter specifies the number of seconds the
<ulink url="winbindd.8.html">winbindd(8)</ulink> daemon will cache
user and group information before querying a Windows NT server
again.</para>
@@ -7808,17 +7925,55 @@
</varlistentry>
+ <varlistentry>
+ <term><anchor id="WINBINDENUMUSERS">winbind enum
+ users</term> <listitem><para>On large installations using
+ <ulink url="winbindd.8.html">winbindd(8)</ulink> it may be
+ necessary to suppress the enumeration of users through the
+ <command> setpwent()</command>,
+ <command>getpwent()</command> and
+ <command>endpwent()</command> group of system calls. If
+ the <parameter>winbind enum users</parameter> parameter is
+ false, calls to the <command>getpwent</command> system call
+ will not return any data. </para>
+
+ <para><emphasis>Warning:</emphasis> Turning off user
+ enumeration may cause some programs to behave oddly. For
+ example, the finger program relies on having access to the
+ full user list when searching for matching
+ usernames. </para>
+
+ <para>Default: <command>winbind enum users = yes </command></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><anchor id="WINBINDENUMGROUPS">winbind enum
+ groups</term> <listitem><para>On large installations using
+ <ulink url="winbindd.8.html">winbindd(8)</ulink> it may be
+ necessary to suppress the enumeration of groups through the
+ <command> setgrent()</command>,
+ <command>getgrent()</command> and
+ <command>endgrent()</command> group of system calls. If
+ the <parameter>winbind enum groups</parameter> parameter is
+ false, calls to the <command>getgrent()</command> system
+ call will not return any data. </para>
+
+ <para><emphasis>Warning:</emphasis> Turning off group
+ enumeration may cause some programs to behave oddly.
+ </para>
+
+ <para>Default: <command>winbind enum groups = no </command>
+ </para></listitem>
+ </varlistentry>
<varlistentry>
<term><anchor id="WINBINDGID">winbind gid</term>
- <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
- available in Samba 3.0.</para>
-
- <para>The winbind gid parameter specifies the range of group
+ <listitem><para>The winbind gid parameter specifies the range of group
ids that are allocated by the <ulink url="winbindd.8.html">
winbindd(8)</ulink> daemon. This range of group ids should have no
- existing local or nis groups within it as strange conflicts can
+ existing local or NIS groups within it as strange conflicts can
occur otherwise.</para>
<para>Default: <command>winbind gid = &lt;empty string&gt;
@@ -7831,10 +7986,7 @@
<varlistentry>
<term><anchor id="WINBINDSEPARATOR">winbind separator</term>
- <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
- available in Samba 3.0.</para>
-
- <para>This parameter allows an admin to define the character
+ <listitem><para>This parameter allows an admin to define the character
used when listing a username of the form of <replaceable>DOMAIN
</replaceable>\<replaceable>user</replaceable>. This parameter
is only applicable when using the <filename>pam_winbind.so</filename>
@@ -7851,13 +8003,10 @@
<varlistentry>
<term><anchor id="WINBINDUID">winbind uid</term>
- <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
- available in Samba 3.0.</para>
-
- <para>The winbind gid parameter specifies the range of group
+ <listitem><para>The winbind gid parameter specifies the range of group
ids that are allocated by the <ulink url="winbindd.8.html">
winbindd(8)</ulink> daemon. This range of ids should have no
- existing local or nis users within it as strange conflicts can
+ existing local or NIS users within it as strange conflicts can
occur otherwise.</para>
<para>Default: <command>winbind uid = &lt;empty string&gt;
@@ -7893,12 +8042,12 @@
name has not previously been added, in that case it should be treated
as an add.</para></listitem>
- <listitem><para>The second argument is the netbios name. If the
+ <listitem><para>The second argument is the NetBIOS name. If the
name is not a legal name then the wins hook is not called.
Legal names contain only letters, digits, hyphens, underscores
and periods.</para></listitem>
- <listitem><para>The third argument is the netbios name
+ <listitem><para>The third argument is the NetBIOS name
type as a 2 digit hexadecimal number. </para></listitem>
<listitem><para>The fourth argument is the TTL (time to live)
@@ -7961,9 +8110,9 @@
<term><anchor id="WINSSUPPORT">wins support (G)</term>
<listitem><para>This boolean controls if the <ulink url="nmbd.8.html">
nmbd(8)</ulink> process in Samba will act as a WINS server. You should
- not set this to true unless you have a multi-subnetted network and
+ not set this to <constant>true</constant> unless you have a multi-subnetted network and
you wish a particular <command>nmbd</command> to be your WINS server.
- Note that you should <emphasis>NEVER</emphasis> set this to true
+ Note that you should <emphasis>NEVER</emphasis> set this to <constant>true</constant>
on more than one machine in your network.</para>
<para>Default: <command>wins support = no</command></para>
@@ -8010,7 +8159,7 @@
within it.</para>
<para>This cache allows Samba to batch client writes into a more
- efficient write size for RAID disks (ie. writes may be tuned to
+ efficient write size for RAID disks (i.e. writes may be tuned to
be the RAID stripe size) and can improve performance on systems
where the disk subsystem is a bottleneck but there is free
memory for userspace programs.</para>
@@ -8068,7 +8217,7 @@
<varlistentry>
<term><anchor id="WRITERAW">write raw (G)</term>
<listitem><para>This parameter controls whether or not the server
- will support raw writes SMB's when transferring data from clients.
+ will support raw write SMB's when transferring data from clients.
You should never need to change this parameter.</para>
<para>Default: <command>write raw = yes</command></para>
diff --git a/docs/docbook/manpages/smbcacls.1.sgml b/docs/docbook/manpages/smbcacls.1.sgml
index 997af68331..69aa967492 100644
--- a/docs/docbook/manpages/smbcacls.1.sgml
+++ b/docs/docbook/manpages/smbcacls.1.sgml
@@ -26,7 +26,6 @@
<arg choice="opt">-G name</arg>
<arg choice="opt">-n</arg>
<arg choice="opt">-h</arg>
- <arg choice="opt">-d</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -36,7 +35,7 @@
<para>This tool is part of the <ulink url="samba.7.html">
Samba</ulink> suite.</para>
- <para>The smbcacls program manipulates NT Access Control Lists
+ <para>The <command>smbcacls</command> program manipulates NT Access Control Lists
(ACLs) on SMB file shares. </para>
</refsect1>
@@ -44,7 +43,7 @@
<refsect1>
<title>OPTIONS</title>
- <para>The following options are available to the smbcacls program.
+ <para>The following options are available to the <command>smbcacls</command> program.
The format of ACLs is described in the section ACL FORMAT </para>
@@ -69,7 +68,7 @@
<varlistentry>
<term>-D acls</term>
- <listitem><para>Delete any ACLs specfied on the command line.
+ <listitem><para>Delete any ACLs specified on the command line.
An error will be printed for each ACL specified that was not
already present in the ACL list. </para></listitem>
</varlistentry>
@@ -138,15 +137,6 @@
<listitem><para>Print usage information on the <command>smbcacls
</command> program.</para></listitem>
</varlistentry>
-
-
-
- <varlistentry>
- <term>-d debuglevel</term>
- <listitem><para>Sets the debug level to the value given
- rather than use the value from the
- <filename>smb.conf</filename> file.</para></listitem>
- </varlistentry>
</variablelist>
</refsect1>
@@ -233,8 +223,8 @@ ACL:&lt;sid or name&gt;:&lt;type&gt;/&lt;flags&gt;/&lt;mask&gt;
depending on the success or otherwise of the operations performed.
The exit status may be one of the following values. </para>
- <para>If the operation succeded, smbcacls returns and exit
- status of 0. If smbcacls couldn't connect to the specified server,
+ <para>If the operation succeeded, smbcacls returns and exit
+ status of 0. If <command>smbcacls</command> couldn't connect to the specified server,
or there was an error getting or setting the ACLs, an exit status
of 1 is returned. If there was an error parsing any command line
arguments, an exit status of 2 is returned. </para>
diff --git a/docs/docbook/manpages/smbclient.1.sgml b/docs/docbook/manpages/smbclient.1.sgml
index f82d59d29c..6cc7be654a 100644
--- a/docs/docbook/manpages/smbclient.1.sgml
+++ b/docs/docbook/manpages/smbclient.1.sgml
@@ -21,7 +21,6 @@
<arg choice="opt">-b &lt;buffer size&gt;</arg>
<arg choice="opt">-d debuglevel</arg>
<arg choice="opt">-D Directory</arg>
- <arg choice="opt">-S server</arg>
<arg choice="opt">-U username</arg>
<arg choice="opt">-W workgroup</arg>
<arg choice="opt">-M &lt;netbios name&gt;</arg>
@@ -81,8 +80,8 @@
</para>
<para>The server name is looked up according to either
- the <parameter>-R</parameter> parameter to smbclient or
- using the name resolve order parameter in the smb.conf file,
+ the <parameter>-R</parameter> parameter to <command>smbclient</command> or
+ using the name resolve order parameter in the <filename>smb.conf</filename> file,
allowing an administrator to change the order and methods
by which server names are looked up. </para></listitem>
</varlistentry>
@@ -131,7 +130,7 @@
<term>-R &lt;name resolve order&gt;</term>
<listitem><para>This option is used by the programs in the Samba
suite to determine what naming services and in what order to resolve
- host names to IP addresses. The option takes a space separated
+ host names to IP addresses. The option takes a space-separated
string of different name resolution options.</para>
<para>The options are :"lmhosts", "host", "wins" and "bcast". They
@@ -147,7 +146,7 @@
<listitem><para><constant>host</constant> : Do a standard host
name to IP address resolution, using the system <filename>/etc/hosts
</filename>, NIS, or DNS lookups. This method of name resolution
- is operating system depended for instance on IRIX or Solaris this
+ is operating system dependent, for instance on IRIX or Solaris this
may be controlled by the <filename>/etc/nsswitch.conf</filename>
file). Note that this method is only used if the NetBIOS name
type being queried is the 0x20 (server) name type, otherwise
@@ -172,7 +171,7 @@
<para>The default order is lmhosts, host, wins, bcast and without
this parameter or any entry in the <parameter>name resolve order
- </parameter> parameter of the smb.conf file the name resolution
+ </parameter> parameter of the <filename>smb.conf</filename> file the name resolution
methods will be attempted in this order. </para></listitem>
</varlistentry>
@@ -216,7 +215,8 @@
<term>-i scope</term>
<listitem><para>This specifies a NetBIOS scope that smbclient will
use to communicate with when generating NetBIOS names. For details
- on the use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt.
+ on the use of NetBIOS scopes, see <filename>rfc1001.txt</filename>
+ and <filename>rfc1002.txt</filename>.
NetBIOS scopes are <emphasis>very</emphasis> rarely used, only set
this parameter if you are the system administrator in charge of all
the NetBIOS systems you communicate with. </para></listitem>
@@ -247,7 +247,7 @@
<varlistentry>
<term>-d debuglevel</term>
- <listitem><para>debuglevel is an integer from 0 to 10, or
+ <listitem><para><replaceable>debuglevel</replaceable> is an integer from 0 to 10, or
the letter 'A'. </para>
<para>The default value if this parameter is not specified
@@ -264,13 +264,13 @@
data, and should only be used when investigating a problem.
Levels above 3 are designed for use only by developers and
generate HUGE amounts of log data, most of which is extremely
- cryptic. If debuglevel is set to the letter 'A', then <emphasis>all
+ cryptic. If <replaceable>debuglevel</replaceable> is set to the letter 'A', then <emphasis>all
</emphasis> debug messages will be printed. This setting
is for developers only (and people who <emphasis>really</emphasis> want
to know how the code works internally). </para>
<para>Note that specifying this parameter here will override
- the log level parameter in the <command>smb.conf (5)</command>
+ the log level parameter in the <filename>smb.conf (5)</filename>
file. </para></listitem>
</varlistentry>
@@ -286,7 +286,7 @@
<varlistentry>
<term>-l logfilename</term>
- <listitem><para>If specified, logfilename specifies a base filename
+ <listitem><para>If specified, <replaceable>logfilename</replaceable> specifies a base filename
into which operational data from the running client will be
logged. </para>
@@ -311,7 +311,7 @@
<varlistentry>
<term>-I IP-address</term>
- <listitem><para>IP address is the address of the server to connect to.
+ <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
It should be specified in standard "a.b.c.d" notation. </para>
<para>Normally the client would attempt to locate a named
@@ -344,31 +344,31 @@
<term>-U username[%pass]</term>
<listitem><para>Sets the SMB username or username and password.
If %pass is not specified, The user will be prompted. The client
- will first check the USER environment variable, then the
- <parameter>$LOGNAME</parameter> variable and if either exist, the
+ will first check the <envar>USER</envar> environment variable, then the
+ <envar>LOGNAME</envar> variable and if either exists, the
string is uppercased. Anything in these variables following a '%'
- sign will be treated as the password. If these environmental
+ sign will be treated as the password. If these environment
variables are not found, the username <constant>GUEST</constant>
is used. </para>
- <para>If the password is not included in these environment
- variables (using the %pass syntax), rpcclient will look for
- a <parameter>$PASSWD</parameter> environment variable from which
+ <para>If the password is not included in these environment
+ variables (using the %pass syntax), <command>smbclient</command> will look for
+ a <envar>PASSWD</envar> environment variable from which
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
option is mainly provided for scripts where the admin doesn't
- desire to pass the credentials on the command line or via environment
+ wish to pass the credentials on the command line or via environment
variables. If this method is used, make certain that the permissions
on the file restrict access from unwanted users. See the
<parameter>-A</parameter> for more details. </para>
<para>Be cautious about including passwords in scripts or in
- the <parameter>$PASSWD</parameter> environment variable. Also, on
+ the <envar>PASSWD</envar> environment variable. Also, on
many systems the command line of a running process may be seen
via the <command>ps</command> command to be safe always allow
- <command>rpcclient</command> to prompt for a password and type
+ <command>smbclient</command> to prompt for a password and type
it in directly. </para></listitem>
</varlistentry>
@@ -397,14 +397,14 @@ password = &lt;value&gt;
are available on a server. You use it as <command>smbclient -L
host</command> and a list should appear. The <parameter>-I
</parameter> option may be useful if your NetBIOS names don't
- match your tcp/ip dns host names or if you are trying to reach a
+ match your TCP/IP DNS host names or if you are trying to reach a
host on another network. </para></listitem>
</varlistentry>
<varlistentry>
<term>-t terminal code</term>
- <listitem><para>This option tells smbclient how to interpret
+ <listitem><para>This option tells <command>smbclient</command> how to interpret
filenames coming from the remote server. Usually Asian language
multibyte UNIX implementations use different character sets than
SMB/CIFS servers (<emphasis>EUC</emphasis> instead of <emphasis>
@@ -488,7 +488,7 @@ password = &lt;value&gt;
</para></listitem>
<listitem><para><parameter>r</parameter> - Regular expression include
- or exclude. Uses regular regular expression matching for
+ or exclude. Uses regular expression matching for
excluding or excluding files if compiled with HAVE_REGEX_H.
However this mode can be very slow. If not compiled with
HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
@@ -511,7 +511,7 @@ password = &lt;value&gt;
<para><command>smbclient</command>'s tar option now supports long
file names both on backup and restore. However, the full path
name of the file must be less than 1024 bytes. Also, when
- a tar archive is created, smbclient's tar option places all
+ a tar archive is created, <command>smbclient</command>'s tar option places all
files in the archive with relative names, not absolute names.
</para>
@@ -523,10 +523,10 @@ password = &lt;value&gt;
<para><emphasis>Examples</emphasis></para>
- <para>Restore from tar file backup.tar into myshare on mypc
+ <para>Restore from tar file <filename>backup.tar</filename> into myshare on mypc
(no password on share). </para>
- <para><command>smbclient //mypc/myshare "" -N -Tx backup.tar
+ <para><command>smbclient //mypc/yshare "" -N -Tx backup.tar
</command></para>
<para>Restore everything except <filename>users/docs</filename>
@@ -566,7 +566,7 @@ password = &lt;value&gt;
<varlistentry>
<term>-c command string</term>
- <listitem><para>command string is a semicolon separated list of
+ <listitem><para>command string is a semicolon-separated list of
commands to be executed instead of prompting from stdin. <parameter>
-N</parameter> is implied by <parameter>-c</parameter>.</para>
@@ -616,7 +616,7 @@ password = &lt;value&gt;
<variablelist>
<varlistentry>
<term>? [command]</term>
- <listitem><para>If "command" is specified, the ? command will display
+ <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display
a brief informative message about the specified command. If no
command is specified, a list of available commands will
be displayed. </para></listitem>
@@ -625,7 +625,7 @@ password = &lt;value&gt;
<varlistentry>
<term>! [shell command]</term>
- <listitem><para>If "shell command" is specified, the !
+ <listitem><para>If <replaceable>shell command</replaceable> is specified, the !
command will execute a shell locally and run the specified shell
command. If no command is specified, a local shell will be run.
</para></listitem>
@@ -648,14 +648,14 @@ password = &lt;value&gt;
<varlistentry>
<term>del &lt;mask&gt;</term>
<listitem><para>The client will request that the server attempt
- to delete all files matching "mask" from the current working
+ to delete all files matching <replaceable>mask</replaceable> from the current working
directory on the server. </para></listitem>
</varlistentry>
<varlistentry>
<term>dir &lt;mask&gt;</term>
- <listitem><para>A list of the files matching "mask" in the current
+ <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current
working directory on the server will be retrieved from the server
and displayed. </para></listitem>
</varlistentry>
@@ -670,9 +670,9 @@ password = &lt;value&gt;
<varlistentry>
<term>get &lt;remote file name&gt; [local file name]</term>
- <listitem><para>Copy the file called "remote file name" from
+ <listitem><para>Copy the file called <filename>remote file name</filename> from
the server to the machine running the client. If specified, name
- the local copy "local file name". Note that all transfers in
+ the local copy <filename>local file name</filename>. Note that all transfers in
<command>smbclient</command> are binary. See also the
lowercase command. </para></listitem>
</varlistentry>
@@ -687,7 +687,7 @@ password = &lt;value&gt;
<varlistentry>
<term>lcd [directory name]</term>
- <listitem><para>If "directory name" is specified, the current
+ <listitem><para>If <replaceable>directory name</replaceable> is specified, the current
working directory on the local machine will be changed to
the directory specified. This operation will fail if for any
reason the specified directory is inaccessible. </para>
@@ -751,13 +751,13 @@ password = &lt;value&gt;
<varlistentry>
<term>mget &lt;mask&gt;</term>
- <listitem><para>Copy all files matching mask from the server to
+ <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to
the machine running the client. </para>
- <para>Note that mask is interpreted differently during recursive
+ <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
operation and non-recursive operation - refer to the recurse and
mask commands for more information. Note that all transfers in
- smbclient are binary. See also the lowercase command. </para></listitem>
+ <command>smbclient</command> are binary. See also the lowercase command. </para></listitem>
</varlistentry>
@@ -770,13 +770,13 @@ password = &lt;value&gt;
<varlistentry>
<term>mput &lt;mask&gt;</term>
- <listitem><para>Copy all files matching mask in the current working
+ <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working
directory on the local machine to the current working directory on
the server. </para>
- <para>Note that mask is interpreted differently during recursive
+ <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
operation and non-recursive operation - refer to the recurse and mask
- commands for more information. Note that all transfers in smbclient
+ commands for more information. Note that all transfers in <command>smbclient</command>
are binary. </para></listitem>
</varlistentry>
@@ -813,10 +813,10 @@ password = &lt;value&gt;
<varlistentry>
<term>put &lt;local file name&gt; [remote file name]</term>
- <listitem><para>Copy the file called "local file name" from the
+ <listitem><para>Copy the file called <filename>local file name</filename> from the
machine running the client to the server. If specified,
- name the remote copy "remote file name". Note that all transfers
- in smbclient are binary. See also the lowercase command.
+ name the remote copy <filename>remote file name</filename>. Note that all transfers
+ in <command>smbclient</command> are binary. See also the lowercase command.
</para></listitem>
</varlistentry>
@@ -863,7 +863,7 @@ password = &lt;value&gt;
<varlistentry>
<term>rm &lt;mask&gt;</term>
- <listitem><para>Remove all files matching mask from the current
+ <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current
working directory on the server. </para></listitem>
</varlistentry>
@@ -890,7 +890,7 @@ password = &lt;value&gt;
<term>blocksize &lt;blocksize&gt;</term>
<listitem><para>Blocksize. Must be followed by a valid (greater
than zero) blocksize. Causes tar file to be written out in
- blocksize*TBLOCK (usually 512 byte) blocks. </para></listitem>
+ <replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem>
</varlistentry>
@@ -938,16 +938,22 @@ password = &lt;value&gt;
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
- <para>The variable <parameter>$USER</parameter> may contain the
+ <para>The variable <envar>USER</envar> may contain the
username of the person using the client. This information is
used only if the protocol level is high enough to support
session-level passwords.</para>
- <para>The variable <parameter>$PASSWD</parameter> may contain
+ <para>The variable <envar>PASSWD</envar> may contain
the password of the person using the client. This information is
used only if the protocol level is high enough to support
session-level passwords. </para>
+
+ <para>The variable <envar>LIBSMB_PROG</envar> may contain
+ the path, executed with system(), which the client should connect
+ to instead of connecting to a server. This functionality is primarily
+ intended as a development aid, and works best when using a LMHOSTS
+ file</para>
</refsect1>
@@ -970,7 +976,7 @@ password = &lt;value&gt;
<para>To test the client, you will need to know the name of a
running SMB/CIFS server. It is possible to run <command>smbd(8)
- </command> an ordinary user - running that server as a daemon
+ </command> as an ordinary user - running that server as a daemon
on a user-accessible port (typically any port number over 1024)
would provide a suitable test server. </para>
</refsect1>
diff --git a/docs/docbook/manpages/smbcontrol.1.sgml b/docs/docbook/manpages/smbcontrol.1.sgml
index 8e529d8b71..d2e3d39478 100644
--- a/docs/docbook/manpages/smbcontrol.1.sgml
+++ b/docs/docbook/manpages/smbcontrol.1.sgml
@@ -113,6 +113,11 @@
any Windows NT clients connected to a printer. This message-type
takes an argument of the printer name to send notify messages to.
This message can only be sent to <constant>smbd</constant>.</para>
+
+ <para>The <constant>close-share</constant> message-type sends a
+ message to smbd which forces smbd to close the share that was
+ specified as an argument. This may be useful if you made changes
+ to the access controls on the share. </para>
</listitem>
</varlistentry>
diff --git a/docs/docbook/manpages/smbd.8.sgml b/docs/docbook/manpages/smbd.8.sgml
index 2d01fd7d49..05958b83de 100644
--- a/docs/docbook/manpages/smbd.8.sgml
+++ b/docs/docbook/manpages/smbd.8.sgml
@@ -67,7 +67,7 @@
can force a reload by sending a SIGHUP to the server. Reloading
the configuration file will not affect connections to any service
that is already established. Either the user will have to
- disconnect from the service, or smbd killed and restarted.</para>
+ disconnect from the service, or <command>smbd</command> killed and restarted.</para>
</refsect1>
<refsect1>
@@ -80,9 +80,9 @@
the server to operate as a daemon. That is, it detaches
itself and runs in the background, fielding requests
on the appropriate port. Operating the server as a
- daemon is the recommended way of running smbd for
+ daemon is the recommended way of running <command>smbd</command> for
servers that provide more than casual use file and
- print services. This switch is assumed is <command>smbd
+ print services. This switch is assumed if <command>smbd
</command> is executed on the command line of a shell.
</para></listitem>
</varlistentry>
@@ -104,7 +104,7 @@
<varlistentry>
<term>-P</term>
- <listitem><para>Passive option. Causes smbd not to
+ <listitem><para>Passive option. Causes <command>smbd</command> not to
send any network traffic out. Used for debugging by
the developers only.</para></listitem>
</varlistentry>
@@ -123,7 +123,7 @@
<varlistentry>
<term>-d &lt;debug level&gt;</term>
- <listitem><para>debuglevel is an integer
+ <listitem><para><replaceable>debuglevel</replaceable> is an integer
from 0 to 10. The default value if this parameter is
not specified is zero.</para>
@@ -149,7 +149,7 @@
<varlistentry>
<term>-l &lt;log file&gt;</term>
- <listitem><para>If specified, <emphasis>log file</emphasis>
+ <listitem><para>If specified, <replaceable>log file</replaceable>
specifies a log filename into which informational and debug
messages from the running server will be logged. The log
file generated is never removed by the server although
@@ -170,7 +170,7 @@
<varlistentry>
<term>-p &lt;port number&gt;</term>
- <listitem><para>port number is a positive integer
+ <listitem><para><replaceable>port number</replaceable> is a positive integer
value. The default value if this parameter is not
specified is 139.</para>
@@ -273,10 +273,10 @@
<variablelist>
<varlistentry>
- <term>PRINTER</term>
+ <term><envar>PRINTER</envar></term>
<listitem><para>If no printer name is specified to
printable services, most systems will use the value of
- this variable (or lp if this variable is
+ this variable (or <constant>lp</constant> if this variable is
not defined) as the name of the printer to use. This
is not specific to the server, however.</para></listitem>
</varlistentry>
@@ -296,10 +296,10 @@
program itself should be executable by all, as users may wish to
run the server themselves (in which case it will of course run
with their privileges). The server should NOT be setuid. On some
- systems it may be worthwhile to make smbd setgid to an empty group.
+ systems it may be worthwhile to make <command>smbd</command> setgid to an empty group.
This is because some systems may have a security hole where daemon
processes that become a user can be attached to with a debugger.
- Making the smbd file setgid to an empty group may prevent
+ Making the <command>smbd</command> file setgid to an empty group may prevent
this hole from being exploited. This security hole and the suggested
fix has only been confirmed on old versions (pre-kernel 2.0) of Linux
at the time this was written. It is possible that this hole only
@@ -395,7 +395,7 @@
<title>RUNNING THE SERVER ON REQUEST</title>
<para>If your system uses a meta-daemon such as <command>inetd
- </command>, you can arrange to have the smbd server started
+ </command>, you can arrange to have the <command>smbd</command> server started
whenever a process attempts to connect to it. This requires several
changes to the startup files on the host machine. If you are
experimenting as an ordinary user rather than as root, you will
@@ -463,6 +463,32 @@
</refsect1>
<refsect1>
+ <title>PAM INTERACTION</title>
+ <para>Samba uses PAM for authentication (when presented with a plaintext
+ password), for account checking (is this account disabled?) and for
+ session management. The degree too which samba supports PAM is restricted
+ by the limitations of the SMB protocol and the
+ <ulink url="smb.conf.5.html#OBEYPAMRESRICTIONS">obey pam restricions</ulink>
+ smb.conf paramater. When this is set, the following restrictions apply:
+ </para>
+
+ <itemizedlist>
+ <listitem><para><emphasis>Account Validation</emphasis>: All acccesses to a
+ samba server are checked
+ against PAM to see if the account is vaild, not disabled and is permitted to
+ login at this time. This also applies to encrypted logins.
+ </para></listitem>
+
+ <listitem><para><emphasis>Session Management</emphasis>: When not using share
+ level secuirty, users must pass PAM's session checks before access
+ is granted. Note however, that this is bypassed in share level secuirty.
+ Note also that some older pam configuration files may need a line
+ added for session support.
+ </para></listitem>
+ </itemizedlist>
+</refsect1>
+
+<refsect1>
<title>TESTING THE INSTALLATION</title>
<para>If running the server as a daemon, execute it before
@@ -471,8 +497,8 @@
<command>inetd</command> will reread their configuration
tables if they receive a HUP signal.</para>
- <para>If your machine's name is fred and your
- name is mary, you should now be able to connect
+ <para>If your machine's name is <replaceable>fred</replaceable> and your
+ name is <replaceable>mary</replaceable>, you should now be able to connect
to the service <filename>\\fred\mary</filename>.
</para>
@@ -513,26 +539,26 @@
<refsect1>
<title>SIGNALS</title>
- <para>Sending the smbd a SIGHUP will cause it to
- re-load its <filename>smb.conf</filename> configuration
+ <para>Sending the <command>smbd</command> a SIGHUP will cause it to
+ reload its <filename>smb.conf</filename> configuration
file within a short period of time.</para>
- <para>To shut down a users smbd process it is recommended
+ <para>To shut down a user's <command>smbd</command> process it is recommended
that <command>SIGKILL (-9)</command> <emphasis>NOT</emphasis>
be used, except as a last resort, as this may leave the shared
memory area in an inconsistent state. The safe way to terminate
- an smbd is to send it a SIGTERM (-15) signal and wait for
+ an <command>smbd</command> is to send it a SIGTERM (-15) signal and wait for
it to die on its own.</para>
- <para>The debug log level of smbd may be raised by sending
- it a SIGUSR1 (<command>kill -USR1 &lt;smbd-pid&gt;</command>)
- and lowered by sending it a SIGUSR2 (<command>kill -USR2 &lt;smbd-pid&gt;
- </command>). This is to allow transient problems to be diagnosed,
+ <para>The debug log level of <command>smbd</command> may be raised
+ or lowered using <ulink url="smbcontrol.1.html"><command>smbcontrol(1)
+ </command></ulink> program (SIGUSR[1|2] signals are no longer used in
+ Samba 2.2). This is to allow transient problems to be diagnosed,
whilst still running at a normally low log level.</para>
<para>Note that as the signal handlers send a debug write,
- they are not re-entrant in smbd. This you should wait until
- smbd is in a state of waiting for an incoming smb before
+ they are not re-entrant in <command>smbd</command>. This you should wait until
+ <command>smbd</command> is in a state of waiting for an incoming SMB before
issuing them. It is possible to make the signal handlers safe
by un-blocking the signals before the select call and re-blocking
them after, however this would affect performance.</para>
diff --git a/docs/docbook/manpages/smbmnt.8.sgml b/docs/docbook/manpages/smbmnt.8.sgml
index 9527a19144..55b66d5d25 100644
--- a/docs/docbook/manpages/smbmnt.8.sgml
+++ b/docs/docbook/manpages/smbmnt.8.sgml
@@ -31,14 +31,19 @@
<para><command>smbmnt</command> is a helper application used
by the smbmount program to do the actual mounting of SMB shares.
- <command>smbmnt</command> is meant to be installed setuid root
- so that normal users can mount their smb shares. It checks
- whether the user has write permissions on the mount point and
- then mounts the directory.</para>
+ <command>smbmnt</command> can be installed setuid root if you want
+ normal users to be able to mount their SMB shares.</para>
+
+ <para>A setuid smbmnt will only allow mounts on directories owned
+ by the user, and that the user has write permission on.</para>
<para>The <command>smbmnt</command> program is normally invoked
by <ulink url="smbmount.8.html"><command>smbmount(8)</command>
</ulink>. It should not be invoked directly by users. </para>
+
+ <para>smbmount searches the normal PATH for smbmnt. You must ensure
+ that the smbmnt version in your path matches the smbmount used.</para>
+
</refsect1>
<refsect1>
@@ -79,7 +84,7 @@
<term>-o options</term>
<listitem><para>
list of options that are passed as-is to smbfs, if this
- command is run on a 2.4 or higher linux kernel.
+ command is run on a 2.4 or higher Linux kernel.
</para></listitem>
</varlistentry>
diff --git a/docs/docbook/manpages/smbmount.8.sgml b/docs/docbook/manpages/smbmount.8.sgml
index 391d7d6882..b4a77e51c9 100644
--- a/docs/docbook/manpages/smbmount.8.sgml
+++ b/docs/docbook/manpages/smbmount.8.sgml
@@ -24,22 +24,23 @@
<refsect1>
<title>DESCRIPTION</title>
- <para><command>smbmount</command> mounts a SMB filesystem. It
- is usually invoked as <command>mount.smb</command> from
+ <para><command>smbmount</command> mounts a Linux SMB filesystem. It
+ is usually invoked as <command>mount.smbfs</command> by
the <command>mount(8)</command> command when using the
- "-t smb" option. The kernel must support the smbfs filesystem. </para>
+ "-t smbfs" option. This command only works in Linux, and the kernel must
+ support the smbfs filesystem. </para>
- <para>Options to smbmount are specified as a comma separated
+ <para>Options to <command>smbmount</command> are specified as a comma-separated
list of key=value pairs. It is possible to send options other
than those listed here, assuming that smbfs supports them. If
you get mount failures, check your kernel log for errors on
unknown options.</para>
- <para>smbmount is a daemon. After mounting it keeps running until
+ <para><command>smbmount</command> is a daemon. After mounting it keeps running until
the mounted smbfs is umounted. It will log things that happen
when in daemon mode using the "machine name" smbmount, so
- typically this output will end up in log.smbmount. The
- smbmount process may also be called mount.smbfs.</para>
+ typically this output will end up in <filename>log.smbmount</filename>. The
+ <command>smbmount</command> process may also be called mount.smbfs.</para>
<para><emphasis>NOTE:</emphasis> <command>smbmount</command>
calls <command>smbmnt(8)</command> to do the actual mount. You
@@ -69,7 +70,16 @@
<envar>PASSWD</envar> is used. If it can find
no password <command>smbmount</command> will prompt
for a passeword, unless the guest option is
- given. </para></listitem>
+ given. </para>
+
+ <para>
+ Note that password which contain the arguement delimiter
+ character (i.e. a comma ',') will failed to be parsed correctly
+ on the command line. However, the same password defined
+ in the PASSWD environment variable or a credentials file (see
+ below) will be read correctly.
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
@@ -85,7 +95,7 @@
</para>
<para>This is preferred over having passwords in plaintext in a
- shared file, such as /etc/fstab. Be sure to protect any
+ shared file, such as <filename>/etc/fstab</filename>. Be sure to protect any
credentials file properly.
</para></listitem>
</varlistentry>
@@ -131,7 +141,7 @@
<varlistentry>
<term>dmask=&lt;arg&gt;</term>
- <listitem><para>sets the directory mask. This deterines the
+ <listitem><para>sets the directory mask. This determines the
permissions that remote directories have in the local filesystem.
The default is based on the current umask. </para></listitem>
</varlistentry>
@@ -140,7 +150,9 @@
<varlistentry>
<term>debug=&lt;arg&gt;</term>
<listitem><para>sets the debug level. This is useful for
- tracking down SMB connection problems. </para></listitem>
+ tracking down SMB connection problems. A suggested value to
+ start with is 4. If set too high there will be a lot of
+ output, possibly hiding the useful output.</para></listitem>
</varlistentry>
@@ -191,7 +203,7 @@
<varlistentry>
<term>iocharset=&lt;arg&gt;</term>
<listitem><para>
- sets the charset used by the linux side for codepage
+ sets the charset used by the Linux side for codepage
to charset translations (NLS). Argument should be the
name of a charset, like iso8859-1. (Note: only kernel
2.4.0 or later)
@@ -241,29 +253,36 @@
protocol level is high enough to support session-level
passwords.</para>
- <para>The variable <envar>PASSWD_FILE</envar> may contain the pathname of
- a file to read the password from. A single line of input is
- read and used as password.</para>
+ <para>The variable <envar>PASSWD_FILE</envar> may contain the pathname
+ of a file to read the password from. A single line of input is
+ read and used as the password.</para>
</refsect1>
<refsect1>
<title>BUGS</title>
- <para>Not many known smbmount bugs. But one smbfs bug is
- important enough to mention here anyway:</para>
+ <para>Passwords and other options containing , can not be handled.
+ For passwords an alternative way of passing them is in a credentials
+ file or in the PASSWD environment.</para>
+
+ <para>The credentials file does not handle usernames or passwords with
+ leading space.</para>
+
+ <para>One smbfs bug is important enough to mention here, even if it
+ is a bit misplaced:</para>
<itemizedlist>
<listitem><para>Mounts sometimes stop working. This is usually
caused by smbmount terminating. Since smbfs needs smbmount to
- reconnect when the server disconnects, the mount will go
- dead. A re-mount normally fixes this. At least 2 ways to
+ reconnect when the server disconnects, the mount will eventually go
+ dead. An umount/mount normally fixes this. At least 2 ways to
trigger this bug are known.</para></listitem>
</itemizedlist>
- <para>Note that the typical response to a bugreport is suggestion
+ <para>Note that the typical response to a bug report is suggestion
to try the latest version first. So please try doing that first,
and always include which versions you use of relevant software
when reporting bugs (minimum: samba, kernel, distribution)</para>
@@ -274,8 +293,15 @@
<refsect1>
<title>SEE ALSO</title>
- <para>Documentation/filesystems/smbfs.txt in the kernel source tree
- may contain additional options and information.</para>
+ <para>Documentation/filesystems/smbfs.txt in the linux kernel
+ source tree may contain additional options and information.</para>
+
+ <para>FreeBSD also has a smbfs, but it is not related to smbmount</para>
+
+ <para>For Solaris, HP-UX and others you may want to look at
+ <ulink url="smbsh.1.html"><command>smbsh(1)</command></ulink> or at other
+ solutions, such as sharity or perhaps replacing the SMB server with
+ a NFS server.</para>
</refsect1>
diff --git a/docs/docbook/manpages/smbpasswd.5.sgml b/docs/docbook/manpages/smbpasswd.5.sgml
index 0e8a704c50..be75107819 100644
--- a/docs/docbook/manpages/smbpasswd.5.sgml
+++ b/docs/docbook/manpages/smbpasswd.5.sgml
@@ -59,9 +59,9 @@
<varlistentry>
<term>Lanman Password Hash</term>
- <listitem><para>This is the LANMAN hash of the users password,
+ <listitem><para>This is the LANMAN hash of the user's password,
encoded as 32 hex digits. The LANMAN hash is created by DES
- encrypting a well known string with the users password as the
+ encrypting a well known string with the user's password as the
DES key. This is the same password used by Windows 95/98 machines.
Note that this password hash is regarded as weak as it is
vulnerable to dictionary attacks and if two users choose the
@@ -69,7 +69,7 @@
is not "salted" as the UNIX password is). If the user has a
null password this field will contain the characters "NO PASSWORD"
as the start of the hex string. If the hex string is equal to
- 32 'X' characters then the users account is marked as
+ 32 'X' characters then the user's account is marked as
<constant>disabled</constant> and the user will not be able to
log onto the Samba server. </para>
@@ -89,14 +89,14 @@
<varlistentry>
<term>NT Password Hash</term>
- <listitem><para>This is the Windows NT hash of the users
+ <listitem><para>This is the Windows NT hash of the user's
password, encoded as 32 hex digits. The Windows NT hash is
- created by taking the users password as represented in
+ created by taking the user's password as represented in
16-bit, little-endian UNICODE and then applying the MD4
(internet rfc1321) hashing algorithm to it. </para>
<para>This password hash is considered more secure than
- the Lanman Password Hash as it preserves the case of the
+ the LANMAN Password Hash as it preserves the case of the
password and uses a much higher quality hashing algorithm.
However, it is still the case that if two users choose the same
password this entry will be identical (i.e. the password is
@@ -132,7 +132,7 @@
in the smbpasswd file. </para></listitem>
<listitem><para><emphasis>N</emphasis> - This means the
- account has no password (the passwords in the fields Lanman
+ account has no password (the passwords in the fields LANMAN
Password Hash and NT Password Hash are ignored). Note that this
will only allow users to log on with no password if the <parameter>
null passwords</parameter> parameter is set in the <ulink
diff --git a/docs/docbook/manpages/smbpasswd.8.sgml b/docs/docbook/manpages/smbpasswd.8.sgml
index 3af636715d..e757a0c67c 100644
--- a/docs/docbook/manpages/smbpasswd.8.sgml
+++ b/docs/docbook/manpages/smbpasswd.8.sgml
@@ -9,7 +9,7 @@
<refnamediv>
<refname>smbpasswd</refname>
- <refpurpose>change a users SMB password</refpurpose>
+ <refpurpose>change a user's SMB password</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -45,7 +45,7 @@
SMB passwords. </para>
<para>By default (when run with no arguments) it will attempt to
- change the current users SMB password on the local machine. This is
+ change the current user's SMB password on the local machine. This is
similar to the way the <command>passwd(1)</command> program works.
<command>smbpasswd</command> differs from how the passwd program works
however in that it is not <emphasis>setuid root</emphasis> but works in
@@ -56,10 +56,10 @@
the <filename>smbpasswd(5)</filename> file. </para>
<para>When run by an ordinary user with no options. smbpasswd
- will prompt them for their old smb password and then ask them
+ will prompt them for their old SMB password and then ask them
for their new password twice, to ensure that the new password
was typed correctly. No passwords will be echoed on the screen
- whilst being typed. If you have a blank smb password (specified by
+ whilst being typed. If you have a blank SMB password (specified by
the string "NO PASSWORD" in the smbpasswd file) then just press
the &lt;Enter&gt; key when asked for your old password. </para>
@@ -117,7 +117,7 @@
will fail. </para>
<para>If the smbpasswd file is in the 'old' format (pre-Samba 2.0
- format) there is no space in the users password entry to write
+ format) there is no space in the user's password entry to write
this information and so the user is disabled by writing 'X' characters
into the password space in the smbpasswd file. See <command>smbpasswd(5)
</command> for details on the 'old' and new password file formats.
@@ -151,7 +151,7 @@
<varlistentry>
<term>-D debuglevel</term>
- <listitem><para><parameter>debuglevel</parameter> is an integer
+ <listitem><para><replaceable>debuglevel</replaceable> is an integer
from 0 to 10. The default value if this parameter is not specified
is zero. </para>
@@ -274,68 +274,52 @@
<varlistentry>
- <term>-j DOMAIN</term> <listitem><para>This option is used
- to add a Samba server into a Windows NT Domain, as a Domain
- member capable of authenticating user accounts to any
- Domain Controller in the same way as a Windows NT
- Server. See the <command>security = domain</command> option
- in the <filename>smb.conf(5)</filename> man page. </para>
-
- <para>The Samba server can be joined to the Windows NT
- Domain in one of two ways. The Administrator for the
- domain can use the "Server Manager for Domains" program to
- add the primary NetBIOS name of the Samba server as a
- member of the Domain. </para>
-
- <para>After this has been done, to join the Domain invoke
- <command> smbpasswd</command> with this
- parameter. smbpasswd will then look up the Primary Domain
- Controller for the Domain (found in the
- <filename>smb.conf</filename> file in the parameter
- <parameter>password server</parameter> and change the
- machine account password used to create the secure Domain
- communication. This password is then stored by smbpasswd
- in a TDB, writeable only by root, called
- <filename>secrets.tdb</filename> </para>
+ <term>-j DOMAIN</term>
+ <listitem><para>This option is used to add a Samba server
+ into a Windows NT Domain, as a Domain member capable of authenticating
+ user accounts to any Domain Controller in the same way as a Windows
+ NT Server. See the <command>security = domain</command> option in
+ the <filename>smb.conf(5)</filename> man page. </para>
+
+ <para>In order to be used in this way, the Administrator for
+ the Windows NT Domain must have used the program "Server Manager
+ for Domains" to add the primary NetBIOS name of the Samba server
+ as a member of the Domain. </para>
+
+ <para>After this has been done, to join the Domain invoke <command>
+ smbpasswd</command> with this parameter. smbpasswd will then
+ look up the Primary Domain Controller for the Domain (found in
+ the <filename>smb.conf</filename> file in the parameter
+ <parameter>password server</parameter> and change the machine account
+ password used to create the secure Domain communication. This
+ password is then stored by smbpasswd in a TDB, writeable only by root,
+ called <filename>secrets.tdb</filename> </para>
<para>Once this operation has been performed the <filename>
- smb.conf</filename> file may be updated to set the
- <command> security = domain</command> option and all future
- logins to the Samba server will be authenticated to the
- Windows NT PDC. </para>
-
- <para>Note that even though the authentication is being
- done to the PDC all users accessing the Samba server must
- still have a valid UNIX account on that machine. </para>
-
- <para>The second method for joining the domain is to
- use the <parameter>-U</parameter> option in addition to the
- <parameter>-j</parameter> to specify an administrator
- username and optional password. This method does not
- require the use of the "Server Manager for Domains"
- program. This method is more secure as the machine account
- password is set to a well known value before the member
- server is joined to the domain.
-
- <para>This option is only available when running smbpasswd
- as root. </para></listitem>
+ smb.conf</filename> file may be updated to set the <command>
+ security = domain</command> option and all future logins
+ to the Samba server will be authenticated to the Windows NT
+ PDC. </para>
+
+ <para>Note that even though the authentication is being
+ done to the PDC all users accessing the Samba server must still
+ have a valid UNIX account on that machine. </para>
+
+
+ <para>This option is only available when running smbpasswd as root.
+ </para></listitem>
</varlistentry>
<varlistentry>
- <term>-U username[%password]</term> <listitem><para>This
- option may only be used in conjunction with the
- <parameter>-r</parameter> or <parameter>-j</parameter>
- options. When changing a password on a remote machine it
- allows the user to specify the user name on that machine
- whose password will be changed. It is present to allow
- users who have different user names on different systems to
- change these passwords. When changing the password on a
- machine account using the <parameter>-j</parameter> option
- the username and password of an administrator is specified
- here. Non-administrator users with the 'Add workstations
- to domain' user right can also be used.</para></listitem>
+ <term>-U username</term>
+ <listitem><para>This option may only be used in conjunction
+ with the <parameter>-r</parameter> option. When changing
+ a password on a remote machine it allows the user to specify
+ the user name on that machine whose password will be changed. It
+ is present to allow users who have different user names on
+ different systems to change these passwords. </para></listitem>
</varlistentry>
@@ -351,7 +335,7 @@
<varlistentry>
<term>-s</term>
<listitem><para>This option causes smbpasswd to be silent (i.e.
- not issue prompts) and to read it's old and new passwords from
+ not issue prompts) and to read its old and new passwords from
standard input, rather than from <filename>/dev/tty</filename>
(like the <command>passwd(1)</command> program does). This option
is to aid people writing scripts to drive smbpasswd</para>
diff --git a/docs/docbook/manpages/smbsh.1.sgml b/docs/docbook/manpages/smbsh.1.sgml
index 3a95f116d9..46adac6b79 100644
--- a/docs/docbook/manpages/smbsh.1.sgml
+++ b/docs/docbook/manpages/smbsh.1.sgml
@@ -1,5 +1,5 @@
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
-<refentry id="findsmb">
+<refentry id="smbsh">
<refmeta>
<refentrytitle>smbsh</refentrytitle>
@@ -28,12 +28,12 @@
<para><command>smbsh</command> allows you to access an NT filesystem
using UNIX commands such as <command>ls</command>, <command>
egrep</command>, and <command>rcp</command>. You must use a
- shell that is dynmanically linked in order for <command>smbsh</command>
+ shell that is dynamically linked in order for <command>smbsh</command>
to work correctly.</para>
<para>To use the <command>smbsh</command> command, execute <command>
smbsh</command> from the prompt and enter the username and password
- that authenticate you to the machine running the Windows NT
+ that authenticates you to the machine running the Windows NT
operating system.</para>
<para><programlisting>
@@ -46,8 +46,10 @@
<para>Any dynamically linked command you execute from
this shell will access the <filename>/smb</filename> directory
using the smb protocol. For example, the command <command>ls /smb
- </command> will show all the machines in your workgroup. The command
- <command>ls /smb/&lt;machine-name&gt;</command> will show the share
+ </command> will show a list of workgroups. The command
+ <command>ls /smb/MYGROUP </command> will show all the machines in
+ the workgroup MYGROUP. The command
+ <command>ls /smb/MYGROUP/&lt;machine-name&gt;</command> will show the share
names for that machine. You could then, for example, use the <command>
cd</command> command to change directories, <command>vi</command> to
edit files, and <command>rcp</command> to copy files.</para>
diff --git a/docs/docbook/manpages/smbspool.8.sgml b/docs/docbook/manpages/smbspool.8.sgml
index 5b409bb9de..d5c9c0a114 100644
--- a/docs/docbook/manpages/smbspool.8.sgml
+++ b/docs/docbook/manpages/smbspool.8.sgml
@@ -52,12 +52,12 @@
</itemizedlist>
<para>smbspool tries to get the URI from argv[0]. If argv[0]
- contains the name of the program then it looks in the <parameter>
- DEVICE_URI</parameter> environment variable.</para>
+ contains the name of the program then it looks in the <envar>
+ DEVICE_URI</envar> environment variable.</para>
<para>Programs using the <command>exec(2)</command> functions can
pass the URI in argv[0], while shell scripts must set the
- <parameter>DEVICE_URI</parameter> environment variable prior to
+ <envar>DEVICE_URI</envar> environment variable prior to
running smbspool.</para>
</refsect1>
diff --git a/docs/docbook/manpages/smbumount.8.sgml b/docs/docbook/manpages/smbumount.8.sgml
index 15e20a2e70..d6a1b65b57 100644
--- a/docs/docbook/manpages/smbumount.8.sgml
+++ b/docs/docbook/manpages/smbumount.8.sgml
@@ -24,7 +24,7 @@
<para>With this program, normal users can unmount smb-filesystems,
provided that it is suid root. <command>smbumount</command> has
- been written to give normal linux-users more control over their
+ been written to give normal Linux users more control over their
resources. It is safe to install this program suid root, because only
the user who has mounted a filesystem is allowed to unmount it again.
For root it is not necessary to use smbumount. The normal umount
diff --git a/docs/docbook/manpages/swat.8.sgml b/docs/docbook/manpages/swat.8.sgml
index 7a362ee3ce..dc6989d566 100644
--- a/docs/docbook/manpages/swat.8.sgml
+++ b/docs/docbook/manpages/swat.8.sgml
@@ -31,10 +31,10 @@
configure the complex <ulink url="smb.conf.5.html"><filename>
smb.conf(5)</filename></ulink> file via a Web browser. In addition,
a <command>swat</command> configuration page has help links
- to all the configurable options in the smb.conf file allowing an
+ to all the configurable options in the <filename>smb.conf</filename> file allowing an
administrator to easily look up the effects of any change. </para>
- <para>swat is run from inetd </para>
+ <para><command>swat</command> is run from <command>inetd</command> </para>
</refsect1>
@@ -47,7 +47,7 @@
<listitem><para>The default configuration file path is
determined at compile time. The file specified contains
the configuration details required by the <command>smbd
- </command> server. This is the file that swat will modify.
+ </command> server. This is the file that <command>swat</command> will modify.
The information in this file includes server-specific
information such as what printcap file to use, as well as
descriptions of all the services that the server is to provide.
@@ -59,8 +59,8 @@
<varlistentry>
<term>-a</term>
<listitem><para>This option disables authentication and puts
- swat in demo mode. In that mode anyone will be able to modify
- the smb.conf file. </para>
+ <command>swat</command> in demo mode. In that mode anyone will be able to modify
+ the <filename>smb.conf</filename> file. </para>
<para><emphasis>Do NOT enable this option on a production
server. </emphasis></para></listitem>
@@ -89,7 +89,7 @@
<para>You need to edit your <filename>/etc/inetd.conf
</filename> and <filename>/etc/services</filename>
- to enable SWAT to be launched via inetd.</para>
+ to enable SWAT to be launched via <command>inetd</command>.</para>
<para>In <filename>/etc/services</filename> you need to
add a line like this: </para>
@@ -123,10 +123,10 @@
<refsect2>
<title>Launching</title>
- <para>To launch swat just run your favorite web browser and
+ <para>To launch SWAT just run your favorite web browser and
point it at "http://localhost:901/".</para>
- <para>Note that you can attach to swat from any IP connected
+ <para>Note that you can attach to SWAT from any IP connected
machine but connecting from a remote machine leaves your
connection open to password sniffing as passwords will be sent
in the clear over the wire. </para>
diff --git a/docs/docbook/manpages/testparm.1.sgml b/docs/docbook/manpages/testparm.1.sgml
index da90dc6e6c..320e39e6f5 100644
--- a/docs/docbook/manpages/testparm.1.sgml
+++ b/docs/docbook/manpages/testparm.1.sgml
@@ -72,7 +72,7 @@
<varlistentry>
<term>-L servername</term>
- <listitem><para>Sets the value of the %L macro to servername.
+ <listitem><para>Sets the value of the %L macro to <replaceable>servername</replaceable>.
This is useful for testing include files specified with the
%L macro. </para></listitem>
</varlistentry>
@@ -90,7 +90,7 @@
<varlistentry>
<term>hostname</term>
<listitem><para>If this parameter and the following are
- specified, then testparm will examine the <parameter>hosts
+ specified, then <command>testparm</command> will examine the <parameter>hosts
allow</parameter> and <parameter>hosts deny</parameter>
parameters in the <filename>smb.conf</filename> file to
determine if the hostname with this IP address would be
@@ -126,7 +126,7 @@
<title>DIAGNOSTICS</title>
<para>The program will issue a message saying whether the
- configuration file loaded OK or not. This message may be preceeded by
+ configuration file loaded OK or not. This message may be preceded by
errors and warnings if the file did not load. If the file was
loaded OK, the program then dumps all known service details
to stdout. </para>
diff --git a/docs/docbook/manpages/wbinfo.1.sgml b/docs/docbook/manpages/wbinfo.1.sgml
index fcc96207c7..7133573b14 100644
--- a/docs/docbook/manpages/wbinfo.1.sgml
+++ b/docs/docbook/manpages/wbinfo.1.sgml
@@ -149,7 +149,7 @@
<para>The wbinfo program returns 0 if the operation
succeeded, or 1 if the operation failed. If the <command>winbindd(8)
- </command> daemon is not working wbinfo will always return
+ </command> daemon is not working <command>wbinfo</command> will always return
failure. </para>
</refsect1>
@@ -158,8 +158,7 @@
<title>VERSION</title>
<para>This man page is correct for version 2.2 of
- the Samba suite. winbindd is however not available in
- stable release of Samba as of yet.</para>
+ the Samba suite.</para>
</refsect1>
<refsect1>
@@ -177,7 +176,7 @@
to the way the Linux kernel is developed.</para>
<para><command>wbinfo</command> and <command>winbindd</command>
- were written by TIm Potter.</para>
+ were written by Tim Potter.</para>
<para>The conversion to DocBook for Samba 2.2 was done
by Gerald Carter</para>
diff --git a/docs/docbook/manpages/winbindd.8.sgml b/docs/docbook/manpages/winbindd.8.sgml
index ed4e72604d..6a1ecd59fd 100644
--- a/docs/docbook/manpages/winbindd.8.sgml
+++ b/docs/docbook/manpages/winbindd.8.sgml
@@ -25,9 +25,8 @@
<refsect1>
<title>DESCRIPTION</title>
- <para>This tool is part of the <ulink url="samba.7.html">
- Samba</ulink> suite version 3.0 and describes functionality not
- yet implemented in the main version of Samba.</para>
+ <para>This program is part of the <ulink url="samba.7.html">
+ Samba</ulink> suite.</para>
<para><command>winbindd</command> is a daemon that provides
a service for the Name Service Switch capability that is present
@@ -39,7 +38,7 @@
of user and group ids specified by the administrator of the
Samba system.</para>
- <para>The service provided by winbindd is called `winbind' and
+ <para>The service provided by <command>winbindd</command> is called `winbind' and
can be used to resolve user and group information from a
Windows NT server. The service can also provide authentication
services via an associated PAM module. </para>
@@ -144,7 +143,7 @@ group: files winbind
DOMAIN\username. In some cases this separator character may
cause problems as the '\' character has special meaning in
unix shells. In that case you can use the winbind separator
- option to specify an alternative sepataror character. Good
+ option to specify an alternative separator character. Good
alternatives may be '/' (although that conflicts
with the unix directory separator) or a '+ 'character.
The '+' character appears to be the best choice for 100%
@@ -161,7 +160,7 @@ group: files winbind
<term>winbind uid</term>
<listitem><para>The winbind uid parameter specifies the
range of user ids that are allocated by the winbindd daemon.
- This range of ids should have no existing local or nis users
+ This range of ids should have no existing local or NIS users
within it as strange conflicts can occur otherwise. </para>
<para>Default: <command>winbind uid = &lt;empty string&gt;
@@ -175,7 +174,7 @@ group: files winbind
<term>winbind gid</term>
<listitem><para>The winbind gid parameter specifies the
range of group ids that are allocated by the winbindd daemon.
- This range of group ids should have no existing local or nis
+ This range of group ids should have no existing local or NIS
groups within it as strange conflicts can occur otherwise.</para>
<para>Default: <command>winbind gid = &lt;empty string&gt;
@@ -191,7 +190,7 @@ group: files winbind
seconds the winbindd daemon will cache user and group information
before querying a Windows NT server again. When a item in the
cache is older than this time winbindd will ask the domain
- controller for the sequence number of the servers account database.
+ controller for the sequence number of the server's account database.
If the sequence number has not changed then the cached item is
marked as valid for a further <parameter>winbind cache time
</parameter> seconds. Otherwise the item is fetched from the
@@ -215,7 +214,7 @@ group: files winbind
return any data. </para>
<para><emphasis>Warning:</emphasis> Turning off user enumeration
- may cause some programs to behave oddly. For example, the finger
+ may cause some programs to behave oddly. For example, the <command>finger</command>
program relies on having access to the full user list when
searching for matching usernames. </para>
@@ -308,18 +307,15 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok
</command></para>
<para>The next step is to join the domain. To do that use the
- <command>samedit</command> program like this: </para>
+ <command>smbpasswd</command> program like this: </para>
- <para><command>samedit -S '*' -W DOMAIN -UAdministrator</command></para>
+ <para><command>smbpasswd -j DOMAIN -r PDC -U
+ Administrator</command></para>
- <para>The username after the <parameter>-U</parameter> can be any Domain
- user that has administrator priviliges on the machine. Next from
- within <command>samedit</command>, run the command: </para>
-
- <para><command>createuser MACHINE$ -j DOMAIN -L</command></para>
-
- <para>This assumes your domain is called "DOMAIN" and your Samba
- workstation is called "MACHINE". </para>
+ <para>The username after the <parameter>-U</parameter> can be any
+ Domain user that has administrator privileges on the machine.
+ Substitute your domain name for "DOMAIN" and the name of your PDC
+ for "PDC".</para>
<para>Next copy <filename>libnss_winbind.so</filename> to
<filename>/lib</filename> and <filename>pam_winbind.so</filename>
@@ -329,7 +325,7 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok
older version of glibc then the target of the link should be
<filename>/lib/libnss_winbind.so.1</filename>.</para>
- <para>Finally, setup a smb.conf containing directives like the
+ <para>Finally, setup a <filename>smb.conf</filename> containing directives like the
following: </para>
<para><programlisting>
@@ -356,7 +352,7 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok
<refsect1>
- <title>Notes</title>
+ <title>NOTES</title>
<para>The following notes are useful when configuring and
running <command>winbindd</command>: </para>
@@ -369,8 +365,8 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok
servers, it must be sent a SIGHUP signal. </para>
<para>Client processes resolving names through the <command>winbindd</command>
- nsswitch module read an environment variable named <parameter>
- $WINBINDD_DOMAIN</parameter>. If this variable contains a comma separated
+ nsswitch module read an environment variable named <envar>
+ $WINBINDD_DOMAIN</envar>. If this variable contains a comma separated
list of Windows NT domain names, then winbindd will only resolve users
and groups within those Windows NT domains. </para>
@@ -389,7 +385,7 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok
<refsect1>
- <title>Signals</title>
+ <title>SIGNALS</title>
<para>The following signals can be used to manipulate the
<command>winbindd</command> daemon. </para>
@@ -418,7 +414,7 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok
</refsect1>
<refsect1>
- <title>Files</title>
+ <title>FILES</title>
<variablelist>
<varlistentry>
@@ -447,7 +443,7 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok
<term>$LOCKDIR/winbindd_idmap.tdb</term>
<listitem><para>Storage for the Windows NT rid to UNIX user/group
id mapping. The lock directory is specified when Samba is initially
- compiled using the <filename>--with-lockdir</filename> option.
+ compiled using the <parameter>--with-lockdir</parameter> option.
This directory is by default <filename>/usr/local/samba/var/locks
</filename>. </para></listitem>
</varlistentry>
@@ -464,9 +460,8 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok
<refsect1>
<title>VERSION</title>
- <para>This man page is correct for version 2.2 of
- the Samba suite. winbindd is however not available in
- stable release of Samba as of yet.</para>
+ <para>This man page is correct for version 2.2 of
+ the Samba suite.</para>
</refsect1>
<refsect1>
diff --git a/docs/docbook/projdoc/CVS-Access.sgml b/docs/docbook/projdoc/CVS-Access.sgml
index aea146b66a..98ef925f20 100644
--- a/docs/docbook/projdoc/CVS-Access.sgml
+++ b/docs/docbook/projdoc/CVS-Access.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="cvs-access">
<chapterinfo>
@@ -18,10 +18,10 @@
<title>Introduction</title>
<para>
-Samba is developed in an open environnment. Developers use CVS
+Samba is developed in an open environment. Developers use CVS
(Concurrent Versioning System) to "checkin" (also known as
"commit") new source code. Samba's various CVS branches can
-be accessed via anonymouns CVS using the instructions
+be accessed via anonymous CVS using the instructions
detailed in this chapter.
</para>
@@ -67,7 +67,7 @@ url="http://samba.org/cgi-bin/cvsweb">http://samba.org/cgi-bin/cvsweb</ulink>
You can also access the source code via a
normal cvs client. This gives you much more control over you can
do with the repository and allows you to checkout whole source trees
-and keep them uptodate via normal cvs commands. This is the
+and keep them up to date via normal cvs commands. This is the
preferred method of access if you are a developer and not
just a casual browser.
</para>
diff --git a/docs/docbook/projdoc/DOMAIN_MEMBER.sgml b/docs/docbook/projdoc/DOMAIN_MEMBER.sgml
index c6dbda15a3..0b1db84b20 100644
--- a/docs/docbook/projdoc/DOMAIN_MEMBER.sgml
+++ b/docs/docbook/projdoc/DOMAIN_MEMBER.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="domain-security">
<chapterinfo>
<author>
diff --git a/docs/docbook/projdoc/ENCRYPTION.sgml b/docs/docbook/projdoc/ENCRYPTION.sgml
index 8b624bad1a..6a26dbeffa 100644
--- a/docs/docbook/projdoc/ENCRYPTION.sgml
+++ b/docs/docbook/projdoc/ENCRYPTION.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="pwencrypt">
<chapterinfo>
@@ -96,7 +96,7 @@
<para>The unix and SMB password encryption techniques seem similar
on the surface. This similarity is, however, only skin deep. The unix
- scheme typically sends clear text passwords over the nextwork when
+ scheme typically sends clear text passwords over the network when
logging in. This is bad. The SMB encryption scheme never sends the
cleartext password over the network but it does store the 16 byte
hashed values on disk. This is also bad. Why? Because the 16 byte hashed
@@ -141,7 +141,7 @@
Microsoft SMB/CIFS clients support authentication via the
SMB Challenge/Response mechanism described here. Enabling
clear text authentication does not disable the ability
- of the client to particpate in encrypted authentication.</para>
+ of the client to participate in encrypted authentication.</para>
</warning>
<sect2>
diff --git a/docs/docbook/projdoc/Integrating-with-Windows.sgml b/docs/docbook/projdoc/Integrating-with-Windows.sgml
new file mode 100644
index 0000000000..0b6abaf80f
--- /dev/null
+++ b/docs/docbook/projdoc/Integrating-with-Windows.sgml
@@ -0,0 +1,935 @@
+<chapter id="integrate-ms-networks">
+
+
+<chapterinfo>
+ <author>
+ <firstname>John</firstname><surname>Terpstra</surname>
+ <affiliation>
+ <orgname>Samba Team</orgname>
+ <address>
+ <email>jht@samba.org</email>
+ </address>
+ </affiliation>
+ </author>
+
+
+ <pubdate> (Jan 01 2001) </pubdate>
+</chapterinfo>
+
+<title>Integrating MS Windows networks with Samba</title>
+
+<sect1>
+<title>Agenda</title>
+
+<para>
+To identify the key functional mechanisms of MS Windows networking
+to enable the deployment of Samba as a means of extending and/or
+replacing MS Windows NT/2000 technology.
+</para>
+
+<para>
+We will examine:
+</para>
+
+<orderedlist>
+ <listitem><para>Name resolution in a pure Unix/Linux TCP/IP
+ environment
+ </para></listitem>
+
+ <listitem><para>Name resolution as used within MS Windows
+ networking
+ </para></listitem>
+
+ <listitem><para>How browsing functions and how to deploy stable
+ and dependable browsing using Samba
+ </para></listitem>
+
+ <listitem><para>MS Windows security options and how to
+ configure Samba for seemless integration
+ </para></listitem>
+
+ <listitem><para>Configuration of Samba as:</para>
+ <orderedlist>
+ <listitem><para>A stand-alone server</para></listitem>
+ <listitem><para>An MS Windows NT 3.x/4.0 security domain member
+ </para></listitem>
+ <listitem><para>An alternative to an MS Windows NT 3.x/4.0 Domain Controller
+ </para></listitem>
+ </orderedlist>
+ </listitem>
+</orderedlist>
+
+</sect1>
+
+
+<sect1>
+<title>Name Resolution in a pure Unix/Linux world</title>
+
+<para>
+The key configuration files covered in this section are:
+</para>
+
+<itemizedlist>
+ <listitem><para><filename>/etc/hosts</filename></para></listitem>
+ <listitem><para><filename>/etc/resolv.conf</filename></para></listitem>
+ <listitem><para><filename>/etc/host.conf</filename></para></listitem>
+ <listitem><para><filename>/etc/nsswitch.conf</filename></para></listitem>
+</itemizedlist>
+
+<sect2>
+<title><filename>/etc/hosts</filename></title>
+
+<para>
+Contains a static list of IP Addresses and names.
+eg:
+</para>
+<para><programlisting>
+ 127.0.0.1 localhost localhost.localdomain
+ 192.168.1.1 bigbox.caldera.com bigbox alias4box
+</programlisting></para>
+
+<para>
+The purpose of <filename>/etc/hosts</filename> is to provide a
+name resolution mechanism so that uses do not need to remember
+IP addresses.
+</para>
+
+
+<para>
+Network packets that are sent over the physical network transport
+layer communicate not via IP addresses but rather using the Media
+Access Control address, or MAC address. IP Addresses are currently
+32 bits in length and are typically presented as four (4) decimal
+numbers that are separated by a dot (or period). eg: 168.192.1.1
+</para>
+
+<para>
+MAC Addresses use 48 bits (or 6 bytes) and are typically represented
+as two digit hexadecimal numbers separated by colons. eg:
+40:8e:0a:12:34:56
+</para>
+
+<para>
+Every network interfrace must have an MAC address. Associated with
+a MAC address there may be one or more IP addresses. There is NO
+relationship between an IP address and a MAC address, all such assignments
+are arbitary or discretionary in nature. At the most basic level all
+network communications takes place using MAC addressing. Since MAC
+addresses must be globally unique, and generally remains fixed for
+any particular interface, the assignment of an IP address makes sense
+from a network management perspective. More than one IP address can
+be assigned per MAC address. One address must be the primary IP address,
+this is the address that will be returned in the ARP reply.
+</para>
+
+<para>
+When a user or a process wants to communicate with another machine
+the protocol implementation ensures that the "machine name" or "host
+name" is resolved to an IP address in a manner that is controlled
+by the TCP/IP configuration control files. The file
+<filename>/etc/hosts</filename> is one such file.
+</para>
+
+<para>
+When the IP address of the destination interface has been
+determined a protocol called ARP/RARP isused to identify
+the MAC address of the target interface. ARP stands for Address
+Resolution Protocol, and is a broadcast oriented method that
+uses UDP (User Datagram Protocol) to send a request to all
+interfaces on the local network segment using the all 1's MAC
+address. Network interfaces are programmed to respond to two
+MAC addresses only; their own unique address and the address
+ff:ff:ff:ff:ff:ff. The reply packet from an ARP request will
+contain the MAC address and the primary IP address for each
+interface.
+</para>
+
+<para>
+The <filename>/etc/hosts</filename> file is foundational to all
+Unix/Linux TCP/IP installations and as a minumum will contain
+the localhost and local network interface IP addresses and the
+primary names by which they are known within the local machine.
+This file helps to prime the pump so that a basic level of name
+resolution can exist before any other method of name resolution
+becomes available.
+</para>
+
+</sect2>
+
+
+<sect2>
+<title><filename>/etc/resolv.conf</filename></title>
+
+<para>
+This file tells the name resolution libraries:
+</para>
+
+<itemizedlist>
+ <listitem><para>The name of the domain to which the machine
+ belongs
+ </para></listitem>
+
+ <listitem><para>The name(s) of any domains that should be
+ automatically searched when trying to resolve unqualified
+ host names to their IP address
+ </para></listitem>
+
+ <listitem><para>The name or IP address of available Domain
+ Name Servers that may be asked to perform name to address
+ translation lookups
+ </para></listitem>
+</itemizedlist>
+
+</sect2>
+
+
+<sect2>
+<title><filename>/etc/host.conf</filename></title>
+
+
+<para>
+<filename>/etc/host.conf</filename> is the primary means by
+which the setting in /etc/resolv.conf may be affected. It is a
+critical configuration file. This file controls the order by
+which name resolution may procede. The typical structure is:
+</para>
+
+<para><programlisting>
+ order hosts,bind
+ multi on
+</programlisting></para>
+
+<para>
+then both addresses should be returned. Please refer to the
+man page for host.conf for further details.
+</para>
+
+
+</sect2>
+
+
+
+<sect2>
+<title><filename>/etc/nsswitch.conf</filename></title>
+
+<para>
+This file controls the actual name resolution targets. The
+file typically has resolver object specifications as follows:
+</para>
+
+
+<para><programlisting>
+ # /etc/nsswitch.conf
+ #
+ # Name Service Switch configuration file.
+ #
+
+ passwd: compat
+ # Alternative entries for password authentication are:
+ # passwd: compat files nis ldap winbind
+ shadow: compat
+ group: compat
+
+ hosts: files nis dns
+ # Alternative entries for host name resolution are:
+ # hosts: files dns nis nis+ hesoid db compat ldap wins
+ networks: nis files dns
+
+ ethers: nis files
+ protocols: nis files
+ rpc: nis files
+ services: nis files
+</programlisting></para>
+
+<para>
+Of course, each of these mechanisms requires that the appropriate
+facilities and/or services are correctly configured.
+</para>
+
+<para>
+It should be noted that unless a network request/message must be
+sent, TCP/IP networks are silent. All TCP/IP communications assumes a
+principal of speaking only when necessary.
+</para>
+
+<para>
+Samba version 2.2.0 will add Linux support for extensions to
+the name service switch infrastructure so that linux clients will
+be able to obtain resolution of MS Windows NetBIOS names to IP
+Addresses. To gain this functionality Samba needs to be compiled
+with appropriate arguments to the make command (ie: <command>make
+nsswitch/libnss_wins.so</command>). The resulting library should
+then be installed in the <filename>/lib</filename> directory and
+the "wins" parameter needs to be added to the "hosts:" line in
+the <filename>/etc/nsswitch.conf</filename> file. At this point it
+will be possible to ping any MS Windows machine by it's NetBIOS
+machine name, so long as that machine is within the workgroup to
+which both the samba machine and the MS Windows machine belong.
+</para>
+
+</sect2>
+</sect1>
+
+
+<sect1>
+<title>Name resolution as used within MS Windows networking</title>
+
+<para>
+MS Windows networking is predicated about the name each machine
+is given. This name is known variously (and inconsistently) as
+the "computer name", "machine name", "networking name", "netbios name",
+"SMB name". All terms mean the same thing with the exception of
+"netbios name" which can apply also to the name of the workgroup or the
+domain name. The terms "workgroup" and "domain" are really just a
+simply name with which the machine is associated. All NetBIOS names
+are exactly 16 characters in length. The 16th character is reserved.
+It is used to store a one byte value that indicates service level
+information for the NetBIOS name that is registered. A NetBIOS machine
+name is therefore registered for each service type that is provided by
+the client/server.
+</para>
+
+<para>
+The following are typical NetBIOS name/service type registrations:
+</para>
+
+<para><programlisting>
+ Unique NetBIOS Names:
+ MACHINENAME<00> = Server Service is running on MACHINENAME
+ MACHINENAME<03> = Generic Machine Name (NetBIOS name)
+ MACHINENAME<20> = LanMan Server service is running on MACHINENAME
+ WORKGROUP<1b> = Domain Master Browser
+
+ Group Names:
+ WORKGROUP<03> = Generic Name registered by all members of WORKGROUP
+ WORKGROUP<1c> = Domain Controllers / Netlogon Servers
+ WORKGROUP<1d> = Local Master Browsers
+ WORKGROUP<1e> = Internet Name Resolvers
+</programlisting></para>
+
+<para>
+It should be noted that all NetBIOS machines register their own
+names as per the above. This is in vast contrast to TCP/IP
+installations where traditionally the system administrator will
+determine in the /etc/hosts or in the DNS database what names
+are associated with each IP address.
+</para>
+
+<para>
+One further point of clarification should be noted, the <filename>/etc/hosts</filename>
+file and the DNS records do not provide the NetBIOS name type information
+that MS Windows clients depend on to locate the type of service that may
+be needed. An example of this is what happens when an MS Windows client
+wants to locate a domain logon server. It find this service and the IP
+address of a server that provides it by performing a lookup (via a
+NetBIOS broadcast) for enumeration of all machines that have
+registered the name type *<1c>. A logon request is then sent to each
+IP address that is returned in the enumerated list of IP addresses. Which
+ever machine first replies then ends up providing the logon services.
+</para>
+
+<para>
+The name "workgroup" or "domain" really can be confusing since these
+have the added significance of indicating what is the security
+architecture of the MS Windows network. The term "workgroup" indicates
+that the primary nature of the network environment is that of a
+peer-to-peer design. In a WORKGROUP all machines are responsible for
+their own security, and generally such security is limited to use of
+just a password (known as SHARE MORE security). In most situations
+with peer-to-peer networking the users who control their own machines
+will simply opt to have no security at all. It is possible to have
+USER MODE security in a WORKGROUP environment, thus requiring use
+of a user name and a matching password.
+</para>
+
+<para>
+MS Windows networking is thus predetermined to use machine names
+for all local and remote machine message passing. The protocol used is
+called Server Message Block (SMB) and this is implemented using
+the NetBIOS protocol (Network Basic Input Output System). NetBIOS can
+be encapsulated using LLC (Logical Link Control) protocol - in which case
+the resulting protocol is called NetBEUI (Network Basic Extended User
+Interface). NetBIOS can also be run over IPX (Internetworking Packet
+Exchange) protocol as used by Novell NetWare, and it can be run
+over TCP/IP protocols - in which case the resulting protocol is called
+NBT or NetBT, the NetBIOS over TCP/IP.
+</para>
+
+<para>
+MS Windows machines use a complex array of name resolution mechanisms.
+Since we are primarily concerned with TCP/IP this demonstration is
+limited to this area.
+</para>
+
+<sect2>
+<title>The NetBIOS Name Cache</title>
+
+<para>
+All MS Windows machines employ an in memory buffer in which is
+stored the NetBIOS names and their IP addresses for all external
+machines that that the local machine has communicated with over the
+past 10-15 minutes. It is more efficient to obtain an IP address
+for a machine from the local cache than it is to go through all the
+configured name resolution mechanisms.
+</para>
+
+<para>
+If a machine whose name is in the local name cache has been shut
+down before the name had been expired and flushed from the cache, then
+an attempt to exchange a message with that machine will be subject
+to time-out delays. ie: It's name is in the cache, so a name resolution
+lookup will succeed, but the machine can not respond. This can be
+frustrating for users - but it is a characteristic of the protocol.
+</para>
+
+<para>
+The MS Windows utility that allows examination of the NetBIOS
+name cache is called "nbtstat". The Samba equivalent of this
+is called "nmblookup".
+</para>
+
+</sect2>
+
+<sect2>
+<title>The LMHOSTS file</title>
+
+<para>
+This file is usually located in MS Windows NT 4.0 or
+2000 in <filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains
+the IP Address and the machine name in matched pairs. The
+<filename>LMHOSTS</filename> file performs NetBIOS name
+to IP address mapping oriented.
+</para>
+
+<para>
+It typically looks like:
+</para>
+
+<para><programlisting>
+ # Copyright (c) 1998 Microsoft Corp.
+ #
+ # This is a sample LMHOSTS file used by the Microsoft Wins Client (NetBIOS
+ # over TCP/IP) stack for Windows98
+ #
+ # This file contains the mappings of IP addresses to NT computernames
+ # (NetBIOS) names. Each entry should be kept on an individual line.
+ # The IP address should be placed in the first column followed by the
+ # corresponding computername. The address and the comptername
+ # should be separated by at least one space or tab. The "#" character
+ # is generally used to denote the start of a comment (see the exceptions
+ # below).
+ #
+ # This file is compatible with Microsoft LAN Manager 2.x TCP/IP lmhosts
+ # files and offers the following extensions:
+ #
+ # #PRE
+ # #DOM:&lt;domain&gt;
+ # #INCLUDE &lt;filename&gt;
+ # #BEGIN_ALTERNATE
+ # #END_ALTERNATE
+ # \0xnn (non-printing character support)
+ #
+ # Following any entry in the file with the characters "#PRE" will cause
+ # the entry to be preloaded into the name cache. By default, entries are
+ # not preloaded, but are parsed only after dynamic name resolution fails.
+ #
+ # Following an entry with the "#DOM:&lt;domain&gt;" tag will associate the
+ # entry with the domain specified by &lt;domain&gt;. This affects how the
+ # browser and logon services behave in TCP/IP environments. To preload
+ # the host name associated with #DOM entry, it is necessary to also add a
+ # #PRE to the line. The &lt;domain&gt; is always preloaded although it will not
+ # be shown when the name cache is viewed.
+ #
+ # Specifying "#INCLUDE &lt;filename&gt;" will force the RFC NetBIOS (NBT)
+ # software to seek the specified &lt;filename&gt; and parse it as if it were
+ # local. &lt;filename&gt; is generally a UNC-based name, allowing a
+ # centralized lmhosts file to be maintained on a server.
+ # It is ALWAYS necessary to provide a mapping for the IP address of the
+ # server prior to the #INCLUDE. This mapping must use the #PRE directive.
+ # In addtion the share "public" in the example below must be in the
+ # LanManServer list of "NullSessionShares" in order for client machines to
+ # be able to read the lmhosts file successfully. This key is under
+ # \machine\system\currentcontrolset\services\lanmanserver\parameters\nullsessionshares
+ # in the registry. Simply add "public" to the list found there.
+ #
+ # The #BEGIN_ and #END_ALTERNATE keywords allow multiple #INCLUDE
+ # statements to be grouped together. Any single successful include
+ # will cause the group to succeed.
+ #
+ # Finally, non-printing characters can be embedded in mappings by
+ # first surrounding the NetBIOS name in quotations, then using the
+ # \0xnn notation to specify a hex value for a non-printing character.
+ #
+ # The following example illustrates all of these extensions:
+ #
+ # 102.54.94.97 rhino #PRE #DOM:networking #net group's DC
+ # 102.54.94.102 "appname \0x14" #special app server
+ # 102.54.94.123 popular #PRE #source server
+ # 102.54.94.117 localsrv #PRE #needed for the include
+ #
+ # #BEGIN_ALTERNATE
+ # #INCLUDE \\localsrv\public\lmhosts
+ # #INCLUDE \\rhino\public\lmhosts
+ # #END_ALTERNATE
+ #
+ # In the above example, the "appname" server contains a special
+ # character in its name, the "popular" and "localsrv" server names are
+ # preloaded, and the "rhino" server name is specified so it can be used
+ # to later #INCLUDE a centrally maintained lmhosts file if the "localsrv"
+ # system is unavailable.
+ #
+ # Note that the whole file is parsed including comments on each lookup,
+ # so keeping the number of comments to a minimum will improve performance.
+ # Therefore it is not advisable to simply add lmhosts file entries onto the
+ # end of this file.
+</programlisting></para>
+
+</sect2>
+
+<sect2>
+<title>HOSTS file</title>
+
+<para>
+This file is usually located in MS Windows NT 4.0 or 2000 in
+<filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains
+the IP Address and the IP hostname in matched pairs. It can be
+used by the name resolution infrastructure in MS Windows, depending
+on how the TCP/IP environment is configured. This file is in
+every way the equivalent of the Unix/Linux <filename>/etc/hosts</filename> file.
+</para>
+</sect2>
+
+
+<sect2>
+<title>DNS Lookup</title>
+
+<para>
+This capability is configured in the TCP/IP setup area in the network
+configuration facility. If enabled an elaborate name resolution sequence
+is followed the precise nature of which isdependant on what the NetBIOS
+Node Type parameter is configured to. A Node Type of 0 means use
+NetBIOS broadcast (over UDP broadcast) is first used if the name
+that is the subject of a name lookup is not found in the NetBIOS name
+cache. If that fails then DNS, HOSTS and LMHOSTS are checked. If set to
+Node Type 8, then a NetBIOS Unicast (over UDP Unicast) is sent to the
+WINS Server to obtain a lookup before DNS, HOSTS, LMHOSTS, or broadcast
+lookup is used.
+</para>
+
+</sect2>
+
+<sect2>
+<title>WINS Lookup</title>
+
+<para>
+A WINS (Windows Internet Name Server) service is the equivaent of the
+rfc1001/1002 specified NBNS (NetBIOS Name Server). A WINS server stores
+the names and IP addresses that are registered by a Windows client
+if the TCP/IP setup has been given at least one WINS Server IP Address.
+</para>
+
+<para>
+To configure Samba to be a WINS server the following parameter needs
+to be added to the <filename>smb.conf</filename> file:
+</para>
+
+<para><programlisting>
+ wins support = Yes
+</programlisting></para>
+
+<para>
+To configure Samba to use a WINS server the following parameters are
+needed in the smb.conf file:
+</para>
+
+<para><programlisting>
+ wins support = No
+ wins server = xxx.xxx.xxx.xxx
+</programlisting></para>
+
+<para>
+where <replaceable>xxx.xxx.xxx.xxx</replaceable> is the IP address
+of the WINS server.
+</para>
+
+</sect2>
+</sect1>
+
+
+<sect1>
+<title>How browsing functions and how to deploy stable and
+dependable browsing using Samba</title>
+
+
+<para>
+As stated above, MS Windows machines register their NetBIOS names
+(ie: the machine name for each service type in operation) on start
+up. Also, as stated above, the exact method by which this name registration
+takes place is determined by whether or not the MS Windows client/server
+has been given a WINS server address, whether or not LMHOSTS lookup
+is enabled, or if DNS for NetBIOS name resolution is enabled, etc.
+</para>
+
+<para>
+In the case where there is no WINS server all name registrations as
+well as name lookups are done by UDP broadcast. This isolates name
+resolution to the local subnet, unless LMHOSTS is used to list all
+names and IP addresses. In such situations Samba provides a means by
+which the samba server name may be forcibly injected into the browse
+list of a remote MS Windows network (using the "remote announce" parameter).
+</para>
+
+<para>
+Where a WINS server is used, the MS Windows client will use UDP
+unicast to register with the WINS server. Such packets can be routed
+and thus WINS allows name resolution to function across routed networks.
+</para>
+
+<para>
+During the startup process an election will take place to create a
+local master browser if one does not already exist. On each NetBIOS network
+one machine will be elected to function as the domain master browser. This
+domain browsing has nothing to do with MS security domain control.
+Instead, the domain master browser serves the role of contacting each local
+master browser (found by asking WINS or from LMHOSTS) and exchanging browse
+list contents. This way every master browser will eventually obtain a complete
+list of all machines that are on the network. Every 11-15 minutes an election
+is held to determine which machine will be the master browser. By nature of
+the election criteria used, the machine with the highest uptime, or the
+most senior protocol version, or other criteria, will win the election
+as domain master browser.
+</para>
+
+<para>
+Clients wishing to browse the network make use of this list, but also depend
+on the availability of correct name resolution to the respective IP
+address/addresses.
+</para>
+
+<para>
+Any configuration that breaks name resolution and/or browsing intrinsics
+will annoy users because they will have to put up with protracted
+inability to use the network services.
+</para>
+
+<para>
+Samba supports a feature that allows forced synchonisation
+of browse lists across routed networks using the "remote
+browse sync" parameter in the smb.conf file. This causes Samba
+to contact the local master browser on a remote network and
+to request browse list synchronisation. This effectively bridges
+two networks that are separated by routers. The two remote
+networks may use either broadcast based name resolution or WINS
+based name resolution, but it should be noted that the "remote
+browse sync" parameter provides browse list synchronisation - and
+that is distinct from name to address resolution, in other
+words, for cross subnet browsing to function correctly it is
+essential that a name to address resolution mechanism be provided.
+This mechanism could be via DNS, <filename>/etc/hosts</filename>,
+and so on.
+</para>
+
+</sect1>
+
+<sect1>
+<title>MS Windows security options and how to configure
+Samba for seemless integration</title>
+
+<para>
+MS Windows clients may use encrypted passwords as part of a
+challenege/response authentication model (a.k.a. NTLMv1) or
+alone, or clear text strings for simple password based
+authentication. It should be realized that with the SMB
+protocol the password is passed over the network either
+in plain text or encrypted, but not both in the same
+authentication requets.
+</para>
+
+<para>
+When encrypted passwords are used a password that has been
+entered by the user is encrypted in two ways:
+</para>
+
+<itemizedlist>
+ <listitem><para>An MD4 hash of the UNICODE of the password
+ string. This is known as the NT hash.
+ </para></listitem>
+
+ <listitem><para>The password is converted to upper case,
+ and then padded or trucated to 14 bytes. This string is
+ then appended with 5 bytes of NULL characters and split to
+ form two 56 bit DES keys to encrypt a "magic" 8 byte value.
+ The resulting 16 bytes for the LanMan hash.
+ </para></listitem>
+</itemizedlist>
+
+<para>
+You should refer to the <ulink url="ENCRYPTION.html">
+Password Encryption</ulink> chapter in this HOWTO collection
+for more details on the inner workings
+</para>
+
+<para>
+MS Windows 95 pre-service pack 1, MS Windows NT versions 3.x
+and version 4.0 pre-service pack 3 will use either mode of
+password authentication. All versions of MS Windows that follow
+these versions no longer support plain text passwords by default.
+</para>
+
+<para>
+MS Windows clients have a habit of dropping network mappings that
+have been idle for 10 minutes or longer. When the user attempts to
+use the mapped drive connection that has been dropped the SMB protocol
+has a mechanism by which the connection can be re-established using
+a cached copy of the password.
+</para>
+
+<para>
+When Microsoft changed the default password mode, they dropped support for
+caching of the plain text password. This means that when the registry
+parameter is changed to re-enable use of plain text passwords it appears to
+work, but when a dropped mapping attempts to revalidate it will fail if
+the remote authentication server does not support encrypted passwords.
+This means that it is definitely not a good idea to re-enable plain text
+password support in such clients.
+</para>
+
+<para>
+The following parameters can be used to work around the
+issue of Windows 9x client upper casing usernames and
+password before transmitting them to the SMB server
+when using clear text authentication.
+</para>
+
+<para><programlisting>
+ <ulink url="smb.conf.5.html#PASSWORDLEVEL">passsword level</ulink> = <replaceable>integer</replaceable>
+ <ulink url="smb.conf.5.html#USERNAMELEVEL">username level</ulink> = <replaceable>integer</replaceable>
+</programlisting></para>
+
+<para>
+By default Samba will lower case the username before attempting
+to lookup the user in the database of local system accounts.
+Because UNIX usernames conventionally only contain lower case
+character, the <parameter>username level</parameter> parameter
+is rarely even needed.
+</para>
+
+<para>
+However, password on UNIX systems often make use of mixed case
+characters. This means that in order for a user on a Windows 9x
+client to connect to a Samba server using clear text authentication,
+the <parameter>password level</parameter> must be set to the maximum
+number of upper case letter which <emphasis>could</emphasis> appear
+is a password. Note that is the server OS uses the traditional
+DES version of crypt(), then a <parameter>password level</parameter>
+of 8 will result in case insensitive passwords as seen from Windows
+users. This will also result in longer login times as Samba
+hash to compute the permutations of the password string and
+try them one by one until a match is located (or all combinations fail).
+</para>
+
+<para>
+The best option to adopt is to enable support for encrypted passwords
+where ever Samba is used. There are three configuration possibilities
+for support of encrypted passwords:
+</para>
+
+
+<sect2>
+<title>Use MS Windows NT as an authentication server</title>
+
+<para>
+This method involves the additions of the following parameters
+in the smb.conf file:
+</para>
+
+<para><programlisting>
+ encrypt passwords = Yes
+ security = server
+ password server = "NetBIOS_name_of_PDC"
+</programlisting></para>
+
+
+<para>
+There are two ways of identifying whether or not a username and
+password pair was valid or not. One uses the reply information provided
+as part of the authentication messaging process, the other uses
+just and error code.
+</para>
+
+<para>
+The down-side of this mode of configuration is the fact that
+for security reasons Samba will send the password server a bogus
+username and a bogus password and if the remote server fails to
+reject the username and password pair then an alternative mode
+of identification of validation is used. Where a site uses password
+lock out after a certain number of failed authentication attempts
+this will result in user lockouts.
+</para>
+
+<para>
+Use of this mode of authentication does require there to be
+a standard Unix account for the user, this account can be blocked
+to prevent logons by other than MS Windows clients.
+</para>
+
+</sect2>
+
+<sect2>
+<title>Make Samba a member of an MS Windows NT security domain</title>
+
+<para>
+This method involves additon of the following paramters in the smb.conf file:
+</para>
+
+<para><programlisting>
+ encrypt passwords = Yes
+ security = domain
+ workgroup = "name of NT domain"
+ password server = *
+</programlisting></para>
+
+<para>
+The use of the "*" argument to "password server" will cause samba
+to locate the domain controller in a way analogous to the way
+this is done within MS Windows NT.
+</para>
+
+<para>
+In order for this method to work the Samba server needs to join the
+MS Windows NT security domain. This is done as follows:
+</para>
+
+<itemizedlist>
+ <listitem><para>On the MS Windows NT domain controller using
+ the Server Manager add a machine account for the Samba server.
+ </para></listitem>
+
+ <listitem><para>Next, on the Linux system execute:
+ <command>smbpasswd -r PDC_NAME -j DOMAIN_NAME</command>
+ </para></listitem>
+</itemizedlist>
+
+<para>
+Use of this mode of authentication does require there to be
+a standard Unix account for the user in order to assign
+a uid once the account has been authenticated by the remote
+Windows DC. This account can be blocked to prevent logons by
+other than MS Windows clients by things such as setting an invalid
+shell in the <filename>/etc/passwd</filename> entry.
+</para>
+
+<para>
+An alternative to assigning UIDs to Windows users on a
+Samba member server is presented in the <ulink
+url="winbind.html">Winbind Overview</ulink> chapter in
+this HOWTO collection.
+</para>
+
+
+</sect2>
+
+
+<sect2>
+<title>Configure Samba as an authentication server</title>
+
+<para>
+This mode of authentication demands that there be on the
+Unix/Linux system both a Unix style account as well as and
+smbpasswd entry for the user. The Unix system account can be
+locked if required as only the encrypted password will be
+used for SMB client authentication.
+</para>
+
+<para>
+This method involves addition of the following parameters to
+the smb.conf file:
+</para>
+
+<para><programlisting>
+## please refer to the Samba PDC HOWTO chapter later in
+## this collection for more details
+[global]
+ encrypt passwords = Yes
+ security = user
+ domain logons = Yes
+ ; an OS level of 33 or more is recommended
+ os level = 33
+
+[NETLOGON]
+ path = /somewhare/in/file/system
+ read only = yes
+</programlisting></para>
+
+<para>
+in order for this method to work a Unix system account needs
+to be created for each user, as well as for each MS Windows NT/2000
+machine. The following structure is required.
+</para>
+
+<sect3>
+<title>Users</title>
+
+<para>
+A user account that may provide a home directory should be
+created. The following Linux system commands are typical of
+the procedure for creating an account.
+</para>
+
+<para><programlisting>
+ # useradd -s /bin/bash -d /home/"userid" -m "userid"
+ # passwd "userid"
+ Enter Password: &lt;pw&gt;
+
+ # smbpasswd -a "userid"
+ Enter Password: &lt;pw&gt;
+</programlisting></para>
+</sect3>
+
+<sect3>
+<title>MS Windows NT Machine Accounts</title>
+
+<para>
+These are required only when Samba is used as a domain
+controller. Refer to the Samba-PDC-HOWTO for more details.
+</para>
+
+<para><programlisting>
+ # useradd -s /bin/false -d /dev/null "machine_name"\$
+ # passwd -l "machine_name"\$
+ # smbpasswd -a -m "machine_name"
+</programlisting></para>
+</sect3>
+</sect2>
+</sect1>
+
+
+<sect1>
+<title>Conclusions</title>
+
+<para>
+Samba provides a flexible means to operate as...
+</para>
+
+<itemizedlist>
+ <listitem><para>A Stand-alone server - No special action is needed
+ other than to create user accounts. Stand-alone servers do NOT
+ provide network logon services, meaning that machines that use this
+ server do NOT perform a domain logon but instead make use only of
+ the MS Windows logon which is local to the MS Windows
+ workstation/server.
+ </para></listitem>
+
+ <listitem><para>An MS Windows NT 3.x/4.0 security domain member.
+ </para></listitem>
+
+
+ <listitem><para>An alternative to an MS Windows NT 3.x/4.0
+ Domain Controller.
+ </para></listitem>
+
+</itemizedlist>
+
+</sect1>
+
+</chapter>
diff --git a/docs/docbook/projdoc/NT_Security.sgml b/docs/docbook/projdoc/NT_Security.sgml
index 28dcb5160d..2259dae029 100644
--- a/docs/docbook/projdoc/NT_Security.sgml
+++ b/docs/docbook/projdoc/NT_Security.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="unix-permissions">
<chapterinfo>
<author>
@@ -16,7 +16,7 @@
</chapterinfo>
-<title>UNIX Permission Bits and WIndows NT Access Control Lists</title>
+<title>UNIX Permission Bits and Windows NT Access Control Lists</title>
<sect1>
<title>Viewing and changing UNIX permissions using the NT
@@ -75,7 +75,7 @@
<para>Where <replaceable>SERVER</replaceable> is the NetBIOS name of
the Samba server, <replaceable>user</replaceable> is the user name of
the UNIX user who owns the file, and <replaceable>(Long name)</replaceable>
- is the discriptive string identifying the user (normally found in the
+ is the descriptive string identifying the user (normally found in the
GECOS field of the UNIX password database). Click on the <command>Close
</command> button to remove this dialog.</para>
@@ -87,14 +87,14 @@
you to change the ownership of this file to yourself (clicking on
it will display a dialog box complaining that the user you are
currently logged onto the NT client cannot be found). The reason
- for this is that changing the ownership of a file is a privilaged
+ for this is that changing the ownership of a file is a privileged
operation in UNIX, available only to the <emphasis>root</emphasis>
user. As clicking on this button causes NT to attempt to change
the ownership of a file to the current user logged into the NT
client this will not work with Samba at this time.</para>
<para>There is an NT chown command that will work with Samba
- and allow a user with Administrator privillage connected
+ and allow a user with Administrator privilege connected
to a Samba 2.0.4 server as root to change the ownership of
files on both a local NTFS filesystem or remote mounted NTFS
or Samba drive. This is available as part of the <emphasis>Seclib
@@ -116,7 +116,7 @@
<para>Where <replaceable>SERVER</replaceable> is the NetBIOS name of
the Samba server, <replaceable>user</replaceable> is the user name of
the UNIX user who owns the file, and <replaceable>(Long name)</replaceable>
- is the discriptive string identifying the user (normally found in the
+ is the descriptive string identifying the user (normally found in the
GECOS field of the UNIX password database).</para>
<para>If the parameter <parameter>nt acl support</parameter>
@@ -133,7 +133,7 @@
<title>File Permissions</title>
<para>The standard UNIX user/group/world triple and
- the correspinding "read", "write", "execute" permissions
+ the corresponding "read", "write", "execute" permissions
triples are mapped by Samba into a three element NT ACL
with the 'r', 'w', and 'x' bits mapped into the corresponding
NT permissions. The UNIX world permissions are mapped into
@@ -200,7 +200,7 @@
<para>The first thing to note is that the <command>"Add"</command>
button will not return a list of users in Samba 2.0.4 (it will give
- an error message of <command>"The remote proceedure call failed
+ an error message of <command>"The remote procedure call failed
and did not execute"</command>). This means that you can only
manipulate the current user/group/world permissions listed in
the dialog box. This actually works quite well as these are the
@@ -231,7 +231,7 @@
user/group/world component then you may either highlight the
component and click the <command>"Remove"</command> button,
or set the component to only have the special <command>"Take
- Ownership"</command> permission (dsplayed as <command>"O"
+ Ownership"</command> permission (displayed as <command>"O"
</command>) highlighted.</para>
</sect1>
@@ -281,7 +281,7 @@
as the <ulink url="smb.conf.5.html#FORCECREATEMODE"><parameter>force
create mode</parameter></ulink> parameter to provide compatibility
with Samba 2.0.4 where the permission change facility was introduced.
- To allow a user to modify all the user/group/world permissions on a file,
+ To allow a user to modify all the user/group/world permissions on a file
with no restrictions set this parameter to 000.</para>
<para>The <parameter>security mask</parameter> and <parameter>force
diff --git a/docs/docbook/projdoc/OS2-Client-HOWTO.sgml b/docs/docbook/projdoc/OS2-Client-HOWTO.sgml
index 5db80cda3d..ca7ad6a754 100644
--- a/docs/docbook/projdoc/OS2-Client-HOWTO.sgml
+++ b/docs/docbook/projdoc/OS2-Client-HOWTO.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="os2">
<chapterinfo>
@@ -116,7 +116,7 @@
driver from an OS/2 system.</para>
<para>Install the NT driver first for that printer. Then,
- add to your smb.conf a paramater, "os2 driver map =
+ add to your smb.conf a parameter, "os2 driver map =
<replaceable>filename</replaceable>". Then, in the file
specified by <replaceable>filename</replaceable>, map the
name of the NT driver name to the OS/2 driver name as
diff --git a/docs/docbook/projdoc/PAM-Authentication-And-Samba.sgml b/docs/docbook/projdoc/PAM-Authentication-And-Samba.sgml
new file mode 100644
index 0000000000..6c866acecd
--- /dev/null
+++ b/docs/docbook/projdoc/PAM-Authentication-And-Samba.sgml
@@ -0,0 +1,212 @@
+<chapter id="pam">
+
+
+<chapterinfo>
+ <author>
+ <firstname>John</firstname><surname>Terpstra</surname>
+ <affiliation>
+ <orgname>Samba Team</orgname>
+ <address>
+ <email>jht@samba.org</email>
+ </address>
+ </affiliation>
+ </author>
+
+
+ <pubdate> (Jun 21 2001) </pubdate>
+</chapterinfo>
+
+<title>Configuring PAM for distributed but centrally
+managed authentication</title>
+
+<sect1>
+<title>Samba and PAM</title>
+
+<para>
+A number of Unix systems (eg: Sun Solaris), as well as the
+xxxxBSD family and Linux, now utilize the Pluggable Authentication
+Modules (PAM) facility to provide all authentication,
+authorization and resource control services. Prior to the
+introduction of PAM, a decision to use an alternative to
+the system password database (<filename>/etc/passwd</filename>)
+would require the provision of alternatives for all programs that provide
+security services. Such a choice would involve provision of
+alternatives to such programs as: <command>login</command>,
+<command>passwd</command>, <command>chown</command>, etc.
+</para>
+
+<para>
+PAM provides a mechanism that disconnects these security programs
+from the underlying authentication/authorization infrastructure.
+PAM is configured either through one file <filename>/etc/pam.conf</filename> (Solaris),
+or by editing individual files that are located in <filename>/etc/pam.d</filename>.
+</para>
+
+<para>
+The following is an example <filename>/etc/pam.d/login</filename> configuration file.
+This example had all options been uncommented is probably not usable
+as it stacks many conditions before allowing successful completion
+of the login process. Essentially all conditions can be disabled
+by commenting them out except the calls to <filename>pam_pwdb.so</filename>.
+</para>
+
+<para><programlisting>
+#%PAM-1.0
+# The PAM configuration file for the `login' service
+#
+auth required pam_securetty.so
+auth required pam_nologin.so
+# auth required pam_dialup.so
+# auth optional pam_mail.so
+auth required pam_pwdb.so shadow md5
+# account requisite pam_time.so
+account required pam_pwdb.so
+session required pam_pwdb.so
+# session optional pam_lastlog.so
+# password required pam_cracklib.so retry=3
+password required pam_pwdb.so shadow md5
+</programlisting></para>
+
+<para>
+PAM allows use of replacable modules. Those available on a
+sample system include:
+</para>
+
+<para><programlisting>
+$ /bin/ls /lib/security
+pam_access.so pam_ftp.so pam_limits.so
+pam_ncp_auth.so pam_rhosts_auth.so pam_stress.so
+pam_cracklib.so pam_group.so pam_listfile.so
+pam_nologin.so pam_rootok.so pam_tally.so
+pam_deny.so pam_issue.so pam_mail.so
+pam_permit.so pam_securetty.so pam_time.so
+pam_dialup.so pam_lastlog.so pam_mkhomedir.so
+pam_pwdb.so pam_shells.so pam_unix.so
+pam_env.so pam_ldap.so pam_motd.so
+pam_radius.so pam_smbpass.so pam_unix_acct.so
+pam_wheel.so pam_unix_auth.so pam_unix_passwd.so
+pam_userdb.so pam_warn.so pam_unix_session.so
+</programlisting></para>
+
+<para>
+The following example for the login program replaces the use of
+the <filename>pam_pwdb.so</filename> module which uses the system
+password database (<filename>/etc/passwd</filename>,
+<filename>/etc/shadow</filename>, <filename>/etc/group</filename>) with
+the module <filename>pam_smbpass.so</filename> which uses the Samba
+database which contains the Microsoft MD4 encrypted password
+hashes. This database is stored in either
+<filename>/usr/local/samba/private/smbpasswd</filename>,
+<filename>/etc/samba/smbpasswd</filename>, or in
+<filename>/etc/samba.d/smbpasswd</filename>, depending on the
+Samba implementation for your Unix/Linux system. The
+<filename>pam_smbpass.so</filename> module is provided by
+Samba version 2.2.1 or later. It can be compiled only if the
+<constant>--with-pam --with-pam_smbpass</constant> options are both
+provided to the Samba <command>configure</command> program.
+</para>
+
+<para><programlisting>
+#%PAM-1.0
+# The PAM configuration file for the `login' service
+#
+auth required pam_smbpass.so nodelay
+account required pam_smbpass.so nodelay
+session required pam_smbpass.so nodelay
+password required pam_smbpass.so nodelay
+</programlisting></para>
+
+<para>
+The following is the PAM configuration file for a particular
+Linux system. The default condition uses <filename>pam_pwdb.so</filename>.
+</para>
+
+<para><programlisting>
+#%PAM-1.0
+# The PAM configuration file for the `samba' service
+#
+auth required /lib/security/pam_pwdb.so nullok nodelay shadow audit
+account required /lib/security/pam_pwdb.so audit nodelay
+session required /lib/security/pam_pwdb.so nodelay
+password required /lib/security/pam_pwdb.so shadow md5
+</programlisting></para>
+
+<para>
+In the following example the decision has been made to use the
+smbpasswd database even for basic samba authentication. Such a
+decision could also be made for the passwd program and would
+thus allow the smbpasswd passwords to be changed using the passwd
+program.
+</para>
+
+<para><programlisting>
+#%PAM-1.0
+# The PAM configuration file for the `samba' service
+#
+auth required /lib/security/pam_smbpass.so nodelay
+account required /lib/security/pam_pwdb.so audit nodelay
+session required /lib/security/pam_pwdb.so nodelay
+password required /lib/security/pam_smbpass.so nodelay smbconf=/etc/samba.d/smb.conf
+</programlisting></para>
+
+<para>
+Note: PAM allows stacking of authentication mechanisms. It is
+also possible to pass information obtained within on PAM module through
+to the next module in the PAM stack. Please refer to the documentation for
+your particular system implementation for details regarding the specific
+capabilities of PAM in this environment. Some Linux implmentations also
+provide the <filename>pam_stack.so</filename> module that allows all
+authentication to be configured in a single central file. The
+<filename>pam_stack.so</filename> method has some very devoted followers
+on the basis that it allows for easier administration. As with all issues in
+life though, every decision makes trade-offs, so you may want examine the
+PAM documentation for further helpful information.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Distributed Authentication</title>
+
+<para>
+The astute administrator will realize from this that the
+combination of <filename>pam_smbpass.so</filename>,
+<command>winbindd</command>, and <command>rsync</command> (see
+<ulink url="http://rsync.samba.org/">http://rsync.samba.org/</ulink>)
+will allow the establishment of a centrally managed, distributed
+user/password database that can also be used by all
+PAM (eg: Linux) aware programs and applications. This arrangement
+can have particularly potent advantages compared with the
+use of Microsoft Active Directory Service (ADS) in so far as
+reduction of wide area network authentication traffic.
+</para>
+
+</sect1>
+
+<sect1>
+<title>PAM Configuration in smb.conf</title>
+
+<para>
+There is an option in smb.conf called <ulink
+url="smb.conf.5.html#OBEYPAMRESTRICTIONS">obey pam restrictions</ulink>.
+The following is from the on-line help for this option in SWAT;
+</para>
+
+<para>
+When Samba 2.2 is configure to enable PAM support (i.e.
+<constant>--with-pam</constant>), this parameter will
+control whether or not Samba should obey PAM's account
+and session management directives. The default behavior
+is to use PAM for clear text authentication only and to
+ignore any account or session management. Note that Samba always
+ignores PAM for authentication in the case of
+<ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords = yes</ulink>.
+The reason is that PAM modules cannot support the challenge/response
+authentication mechanism needed in the presence of SMB
+password encryption.
+</para>
+
+<para>Default: <command>obey pam restrictions = no</command></para>
+
+</sect1>
+</chapter>
diff --git a/docs/docbook/projdoc/Samba-PDC-HOWTO.sgml b/docs/docbook/projdoc/Samba-PDC-HOWTO.sgml
index 0b86bcba63..b980b99e22 100644
--- a/docs/docbook/projdoc/Samba-PDC-HOWTO.sgml
+++ b/docs/docbook/projdoc/Samba-PDC-HOWTO.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="samba-pdc">
<chapterinfo>
@@ -32,12 +32,12 @@ How to Configure Samba 2.2 as a Primary Domain Controller
<title>Prerequisite Reading</title>
<para>
-Before you continue readingin this chapter, please make sure
+Before you continue reading in this chapter, please make sure
that you are comfortable with configuring basic files services
-in smb.conf and how to enable and administrate password
+in smb.conf and how to enable and administer password
encryption in Samba. Theses two topics are covered in the
<ulink url="smb.conf.5.html"><filename>smb.conf(5)</filename></ulink>
-manpage and the <ulink url="EMCRYPTION.html">Encryption chapter</ulink>
+manpage and the <ulink url="ENCRYPTION.html">Encryption chapter</ulink>
of this HOWTO Collection.
</para>
@@ -60,13 +60,14 @@ Background
<para>
<emphasis>Author's Note :</emphasis> This document is a combination
of David Bannon's Samba 2.2 PDC HOWTO and the Samba NT Domain FAQ.
-Both documents are superceeded by this one.
+Both documents are superseded by this one.
</para>
</note>
<para>
Version of Samba prior to release 2.2 had marginal capabilities to
-act as a Windows NT 4.0 Primary Domain Controller (PDC). Beginning with
+act as a Windows NT 4.0 Primary DOmain Controller <indexterm><primary>Primary
+Domain Controller</primary></indexterm> (PDC). Beginning with
Samba 2.2.0, we are proud to announce official support for Windows NT 4.0
style domain logons from Windows NT 4.0 (through SP6) and Windows 2000 (through
SP1) clients. This article outlines the steps necessary for configuring Samba
@@ -264,9 +265,8 @@ There are a couple of points to emphasize in the above configuration.
<para>
As Samba 2.2 does not offer a complete implementation of group mapping between
Windows NT groups and UNIX groups (this is really quite complicated to explain
-in a short space), you should refer to the <ulink url="smb.conf.5.html#DOMAINADMINUSERS">domain
-admin users</ulink> and <ulink url="smb.conf.5.html#DOMAINADMINGROUP">domain
-admin group</ulink> smb.conf parameters for information of creating a Domain Admins
+in a short space), you should refer to the <ulink url="smb.conf.5.html#DOMAINADMINGROUP">domain
+admin group</ulink> smb.conf parameter for information of creating "Domain Admins"
style accounts.
</para>
@@ -281,7 +281,7 @@ to the Domain</title>
A machine trust account is a samba user account owned by a computer.
The account password acts as the shared secret for secure
communication with the Domain Controller. This is a security feature
-to prevent an unauthorized machine with the same netbios name from
+to prevent an unauthorized machine with the same NetBIOS name from
joining the domain and gaining access to domain user/group accounts.
Hence a Windows 9x host is never a true member of a domain because it does
not posses a machine trust account, and thus has no shared secret with the DC.
@@ -310,7 +310,7 @@ There are two means of creating machine trust accounts.
<listitem><para>
Manual creation before joining the client to the domain. In this case,
the password is set to a known value -- the lower case of the
- machine's netbios name.
+ machine's NetBIOS name.
</para></listitem>
<listitem><para>
@@ -333,8 +333,11 @@ based Samba server:
</para>
<para>
-<prompt>root# </prompt>/usr/sbin/useradd -g 100 -d /dev/null -c <replaceable>
-machine_nickname</replaceable> -m -s /bin/false <replaceable>machine_name</replaceable>$
+<prompt>root# </prompt>/usr/sbin/useradd -g 100 -d /dev/null -c <replaceable>"machine
+nickname"</replaceable> -s /bin/false <replaceable>machine_name</replaceable>$
+</para>
+<para>
+<prompt>root# </prompt>passwd -l <replaceable>machine_name</replaceable>$
</para>
<para>
@@ -351,7 +354,7 @@ doppy$:x:505:501:<replaceable>machine_nickname</replaceable>:/dev/null:/bin/fals
<para>
Above, <replaceable>machine_nickname</replaceable> can be any descriptive name for the
pc i.e. BasementComputer. The <replaceable>machine_name</replaceable> absolutely must be
-the netbios name of the pc to be added to the domain. The "$" must append the netbios
+the NetBIOS name of the pc to be added to the domain. The "$" must append the NetBIOS
name of the pc or samba will not recognize this as a machine account
</para>
@@ -369,7 +372,7 @@ as shown here:
</para>
<para>
-where <replaceable>machine_name</replaceable> is the machine's netbios
+where <replaceable>machine_name</replaceable> is the machine's NetBIOS
name.
</para>
@@ -382,7 +385,7 @@ name.
the "Server Manager". From the time at which the account is created
to the time which th client joins the domain and changes the password,
your domain is vulnerable to an intruder joining your domain using a
- a machine with the same netbios name. A PDC inherently trusts
+ a machine with the same NetBIOS name. A PDC inherently trusts
members of the domain and will serve out a large degree of user
information to such clients. You have been warned!
</para>
@@ -409,7 +412,7 @@ add user script = /usr/sbin/useradd -d /dev/null -g 100 -s /bin/false -M %u
In Samba 2.2.1, <emphasis>only the root account</emphasis> can be used to create
machine accounts like this. Therefore, it is required to create
an entry in smbpasswd for <emphasis>root</emphasis>. The password
-<emphasis>SHOULD</emphasis> be set to s different password that the
+<emphasis>SHOULD</emphasis> be set to a different password that the
associated <filename>/etc/passwd</filename> entry for security reasons.
</para>
</sect2>
@@ -519,8 +522,8 @@ associated <filename>/etc/passwd</filename> entry for security reasons.
have not been created correctly. Make sure that you have the entry
correct for the machine account in smbpasswd file on the Samba PDC.
If you added the account using an editor rather than using the smbpasswd
- utility, make sure that the account name is the machine netbios name
- with a '$' appended to it ( ie. computer_name$ ). There must be an entry
+ utility, make sure that the account name is the machine NetBIOS name
+ with a '$' appended to it ( i.e. computer_name$ ). There must be an entry
in both /etc/passwd and the smbpasswd file. Some people have reported
that inconsistent subnet masks between the Samba server and the NT
client have caused this problem. Make sure that these are consistent
@@ -543,7 +546,7 @@ associated <filename>/etc/passwd</filename> entry for security reasons.
<para>
At first be ensure to enable the useraccounts with <command>smbpasswd -e
- %user%</command>, this is normaly done, when you create an account.
+ %user%</command>, this is normally done, when you create an account.
</para>
<para>
@@ -619,7 +622,7 @@ Here are some additional details:
<para>
The Windows NT policy editor is also included with the Service Pack 3 (and
later) for Windows NT 4.0. Extract the files using <command>servicepackname /x</command>,
- ie thats <command>Nt4sp6ai.exe /x</command> for service pack 6a. The policy editor,
+ i.e. that's <command>Nt4sp6ai.exe /x</command> for service pack 6a. The policy editor,
<command>poledit.exe</command> and the associated template files (*.adm) should
be extracted as well. It is also possible to downloaded the policy template
files for Office97 and get a copy of the policy editor. Another possible
@@ -715,7 +718,7 @@ general SMB topics such as browsing.</para>
<para>
One of the best diagnostic tools for debugging problems is Samba itself.
- You can use the -d option for both smbd and nmbd to specifiy what
+ You can use the -d option for both smbd and nmbd to specify what
'debug level' at which to run. See the man pages on smbd, nmbd and
smb.conf for more information on debugging options. The debug
level can range from 1 (the default) to 10 (100 for debugging passwords).
@@ -758,7 +761,7 @@ general SMB topics such as browsing.</para>
(aka. netmon) is available on the Microsoft Developer Network CD's,
the Windows NT Server install CD and the SMS CD's. The version of
netmon that ships with SMS allows for dumping packets between any two
- computers (ie. placing the network interface in promiscuous mode).
+ computers (i.e. placing the network interface in promiscuous mode).
The version on the NT Server install CD will only allow monitoring
of network traffic directed to the local NT box and broadcasts on the
local subnet. Be aware that Ethereal can read and write netmon
@@ -934,7 +937,7 @@ general SMB topics such as browsing.</para>
</para></listitem>
<listitem><para> Don't cross post. Work out which is the best list to post to
- and see what happens, ie don't post to both samba-ntdom and samba-technical.
+ and see what happens, i.e. don't post to both samba-ntdom and samba-technical.
Many people active on the lists subscribe to more
than one list and get annoyed to see the same message two or more times.
Often someone will see a message and thinking it would be better dealt
@@ -1026,7 +1029,7 @@ When an SMB client in a domain wishes to logon it broadcast requests for a
logon server. The first one to reply gets the job, and validates its
password using whatever mechanism the Samba administrator has installed.
It is possible (but very stupid) to create a domain where the user
-database is not shared between servers, ie they are effectively workgroup
+database is not shared between servers, i.e. they are effectively workgroup
servers advertising themselves as participating in a domain. This
demonstrates how authentication is quite different from but closely
involved with domains.
@@ -1124,7 +1127,7 @@ at how a Win9X client performs a logon:
<listitem>
<para>
The client then connects to the user's home share and searches for the
- user's profile. As it turns out, you can specify the users home share as
+ user's profile. As it turns out, you can specify the user's home share as
a sharename and path. For example, \\server\fred\.profile.
If the profiles are found, they are implemented.
</para>
@@ -1229,7 +1232,7 @@ logon script = scripts\%U.bat
<listitem>
<para>
- you will probabaly find that your clients automatically mount the
+ you will probably find that your clients automatically mount the
\\SERVER\NETLOGON share as drive z: while logging in. You can put
some useful programs there to execute from the batch files.
</para>
@@ -1255,7 +1258,7 @@ or not Samba must be the domain master browser for its workgroup
when operating as a DC. While it may technically be possible
to configure a server as such (after all, browsing and domain logons
are two distinctly different functions), it is not a good idea to
-so. You should remember that the DC must register the DOMAIN#1b netbios
+so. You should remember that the DC must register the DOMAIN#1b NetBIOS
name. This is the name used by Windows clients to locate the DC.
Windows clients do not distinguish between the DC and the DMB.
For this reason, it is very wise to configure the Samba DC as the DMB.
@@ -1302,7 +1305,7 @@ Win9X and WinNT clients implement these features.
<para>
Win9X clients send a NetUserGetInfo request to the server to get the user's
profiles location. However, the response does not have room for a separate
-profiles location field, only the users home share. This means that Win9X
+profiles location field, only the user's home share. This means that Win9X
profiles are restricted to being in the user's home directory.
</para>
@@ -1414,7 +1417,7 @@ as are folders "Start Menu", "Desktop", "Programs" and "Nethood".
These directories and their contents will be merged with the local
versions stored in c:\windows\profiles\username on subsequent logins,
taking the most recent from each. You will need to use the [global]
-options "preserve case = yes", "short case preserve = yes" and
+options "preserve case = yes", "short preserve case = yes" and
"case sensitive = no" in order to maintain capital letters in shortcuts
in any of the profile folders.
</para>
@@ -1551,7 +1554,7 @@ they will be told that they are logging in "for the first time".
<listitem>
<para>
- search for the user's .PWL password-cacheing file in the c:\windows
+ search for the user's .PWL password-caching file in the c:\windows
directory, and delete it.
</para>
</listitem>
@@ -1654,11 +1657,11 @@ matter to be resolved].
</para>
<para>
-[lkcl 20aug97 - after samba digest correspondance, one user found, and
+[lkcl 20aug97 - after samba digest correspondence, one user found, and
another confirmed, that profiles cannot be loaded from a samba server
unless "security = user" and "encrypt passwords = yes" (see the file
ENCRYPTION.txt) or "security = server" and "password server = ip.address.
-of.yourNTserver" are used. either of these options will allow the NT
+of.yourNTserver" are used. Either of these options will allow the NT
workstation to access the samba server using LAN manager encrypted
passwords, without the user intervention normally required by NT
workstation for clear-text passwords].
@@ -1843,7 +1846,7 @@ plain Servers.
<para>
The User database is called the SAM (Security Access Manager) database and
is used for all user authentication as well as for authentication of inter-
-process authentication (ie: to ensure that the service action a user has
+process authentication (i.e. to ensure that the service action a user has
requested is permitted within the limits of that user's privileges).
</para>
@@ -1858,7 +1861,7 @@ to Samba systems.
<para>
Windows for Workgroups, Windows 95, and Windows NT Workstations and Servers
can participate in a Domain security system that is controlled by Windows NT
-servers that have been correctly configured. At most every domain will have
+servers that have been correctly configured. Almost every domain will have
ONE Primary Domain Controller (PDC). It is desirable that each domain will
have at least one Backup Domain Controller (BDC).
</para>
diff --git a/docs/docbook/projdoc/UNIX_INSTALL.sgml b/docs/docbook/projdoc/UNIX_INSTALL.sgml
index 0e4d8a5d03..ee91f6e07a 100644
--- a/docs/docbook/projdoc/UNIX_INSTALL.sgml
+++ b/docs/docbook/projdoc/UNIX_INSTALL.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="install">
<title>How to Install and Test SAMBA</title>
@@ -30,7 +30,7 @@
</userinput></para>
<para>first to see what special options you can enable.
- Then exectuting</para>
+ Then executing</para>
<para><prompt>root# </prompt><userinput>make</userinput></para>
@@ -96,7 +96,7 @@
<para>which would allow connections by anyone with an
account on the server, using either their login name or
"homes" as the service name. (Note that I also set the
- workgroup that Samba is part of. See BROWSING.txt for defails)</para>
+ workgroup that Samba is part of. See BROWSING.txt for details)</para>
<para>Note that <command>make install</command> will not install
a <filename>smb.conf</filename> file. You need to create it
@@ -120,7 +120,7 @@
not it will give an error message.</para>
<para>Make sure it runs OK and that the services look
- resonable before proceeding. </para>
+ reasonable before proceeding. </para>
</sect1>
@@ -174,14 +174,14 @@
<para>NOTE: Some unixes already have entries like netbios_ns
(note the underscore) in <filename>/etc/services</filename>.
You must either edit <filename>/etc/services</filename> or
- <filename>/etc/inetd.conf</filename> to make them consistant.</para>
+ <filename>/etc/inetd.conf</filename> to make them consistent.</para>
<para>NOTE: On many systems you may need to use the
"interfaces" option in smb.conf to specify the IP address
and netmask of your interfaces. Run <command>ifconfig</command>
as root if you don't know what the broadcast is for your
net. <command>nmbd</command> tries to determine it at run
- time, but fails on somunixes. See the section on "testing nmbd"
+ time, but fails on some unixes. See the section on "testing nmbd"
for a method of finding if you need to do this.</para>
<para>!!!WARNING!!! Many unixes only accept around 5
@@ -305,7 +305,7 @@
<sect2>
<title>Diagnosing Problems</title>
- <para>If you have instalation problems then go to
+ <para>If you have installation problems then go to
<filename>DIAGNOSIS.txt</filename> to try to find the
problem.</para>
</sect2>
@@ -419,7 +419,7 @@
are set by an application when it opens a file to determine
what types of access should be allowed simultaneously with
its open. A client may ask for DENY_NONE, DENY_READ, DENY_WRITE
- or DENY_ALL. There are also special compatability modes called
+ or DENY_ALL. There are also special compatibility modes called
DENY_FCB and DENY_DOS.</para>
<para>You can disable share modes using "share modes = no".
@@ -442,7 +442,7 @@
<para>If you have problems using filenames with accented
characters in them (like the German, French or Scandinavian
- character sets) then I recommmend you look at the "valid chars"
+ character sets) then I recommend you look at the "valid chars"
option in smb.conf and also take a look at the validchars
package in the examples directory.</para>
</sect2>
diff --git a/docs/docbook/projdoc/msdfs_setup.sgml b/docs/docbook/projdoc/msdfs_setup.sgml
index 5853049d79..35c9d40840 100644
--- a/docs/docbook/projdoc/msdfs_setup.sgml
+++ b/docs/docbook/projdoc/msdfs_setup.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="msdfs">
<chapterinfo>
<author>
diff --git a/docs/docbook/projdoc/printer_driver2.sgml b/docs/docbook/projdoc/printer_driver2.sgml
index 51471ae690..4377303ffb 100644
--- a/docs/docbook/projdoc/printer_driver2.sgml
+++ b/docs/docbook/projdoc/printer_driver2.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="printing">
<chapterinfo>
@@ -126,12 +126,19 @@ Windows NT print servers to provide support for printer driver
download).
</para>
-<para>You should modify the server's smb.conf file to create the
+<para>You should modify the server's smb.conf file to add the global
+parameters and to create the
following file share (of course, some of the parameter values,
such as 'path' are arbitrary and should be replaced with
appropriate values for your site):</para>
<para><programlisting>
+[global]
+ ; members of the ntadmin group should be able
+ ; to add drivers and set printer properties
+ ; root is implicitly a 'printer admin'
+ printer admin = @ntadmin
+
[print$]
path = /usr/local/samba/printers
guest ok = yes
@@ -142,13 +149,13 @@ appropriate values for your site):</para>
; sure this account can copy files to the share. If this
; is setup to a non-root account, then it should also exist
; as a 'printer admin'
- write list = ntadmin
+ write list = @ntadmin,root
</programlisting></para>
<para>The <ulink url="smb.conf.5.html#WRITELIST"><parameter>
write list</parameter></ulink> is used to allow administrative
level user accounts to have write access in order to update files
-on the share. See the <ulink url="smb./conf.5.html">smb.conf(5)
+on the share. See the <ulink url="smb.conf.5.html">smb.conf(5)
man page</ulink> for more information on configuring file shares.</para>
<para>The requirement for <ulink url="smb.conf.5.html#GUESTOK"><command>guest
@@ -345,7 +352,7 @@ Add Printer Wizard icon. The APW will be show only if
<itemizedlist>
<listitem><para>The connected user is able to successfully
execute an OpenPrinterEx(\\server) with administrative
- priviledges (i.e. root or <parameter>printer admin</parameter>).
+ privileges (i.e. root or <parameter>printer admin</parameter>).
</para></listitem>
<listitem><para><ulink url="smb.conf.5.html#SHOWADDPRINTERWIZARD"><parameter>show
@@ -513,7 +520,7 @@ foreach (supported architecture for a given driver)
the Imprints tool set was the name space issues between
various supported client architectures. For example, Windows
NT includes a driver named "Apple LaserWriter II NTX v51.8"
- and Windows 95 callsits version of this driver "Apple
+ and Windows 95 calls its version of this driver "Apple
LaserWriter II NTX"</para>
<para>The problem is how to know what client drivers have
@@ -547,71 +554,10 @@ foreach (supported architecture for a given driver)
<para>
Given that printer driver management has changed (we hope improved) in
2.2 over prior releases, migration from an existing setup to 2.2 can
-follow several paths.
+follow several paths. Here are the possible scenarios for
+migration:
</para>
-<para>
-Windows clients have a tendency to remember things for quite a while.
-For example, if a Windows NT client has attached to a Samba 2.0 server,
-it will remember the server as a LanMan printer server. Upgrading
-the Samba host to 2.2 makes support for MSRPC printing possible, but
-the NT client will still remember the previous setting.
-</para>
-
-<para>
-In order to give an NT client printing "amesia" (only necessary if you
-want to use the newer MSRPC printing functionality in Samba), delete
-the registry keys associated with the print server contained in
-<constant>[HKLM\SYSTEM\CurrentControlSet\Control\Print]</constant>. The
-spooler service on the client should be stopped prior to doing this:
-</para>
-
-<para>
-<prompt>C:\WINNT\ ></prompt> <userinput>net stop spooler</userinput>
-</para>
-
-<para>
-<emphasis>All the normal disclaimers about editing the registry go
-here.</emphasis> Be careful, and know what you are doing.
-</para>
-
-<para>
-The spooler service should be restarted after you have finished
-removing the appropriate registry entries by replacing the
-<command>stop</command> command above with <command>start</command>.
-</para>
-
-<para>
-Windows 9x clients will continue to use LanMan printing calls
-with a 2.2 Samba server so there is no need to perform any of these
-modifications on non-NT clients.
-</para>
-
-<warning>
-<title>Achtung!</title>
-
-<para>
-The following smb.conf parameters are considered to be depreciated and will
-be removed soon. Do not use them in new installations
-</para>
-
-<itemizedlist>
- <listitem><para><parameter>printer driver file (G)</parameter>
- </para></listitem>
-
- <listitem><para><parameter>printer driver (S)</parameter>
- </para></listitem>
-
- <listitem><para><parameter>printer driver location (S)</parameter>
- </para></listitem>
-</itemizedlist>
-</warning>
-
-
-<para>
-Here are the possible scenarios for supporting migration:
-</para>
-
<itemizedlist>
<listitem><para>If you do not desire the new Windows NT
print driver support, nothing needs to be done.
@@ -620,13 +566,13 @@ Here are the possible scenarios for supporting migration:
<listitem><para>If you want to take advantage of NT printer
driver support but do not want to migrate the
9x drivers to the new setup, the leave the existing
- printers.def file. When smbd attempts to locate a
+ <filename>printers.def</filename> file. When smbd attempts
+ to locate a
9x driver for the printer in the TDB and fails it
will drop down to using the printers.def (and all
associated parameters). The <command>make_printerdef</command>
tool will also remain for backwards compatibility but will
- be moved to the "this tool is the old way of doing it"
- pile.</para></listitem>
+ be removed in the next major release.</para></listitem>
<listitem><para>If you install a Windows 9x driver for a printer
on your Samba host (in the printing TDB), this information will
@@ -643,6 +589,39 @@ Here are the possible scenarios for supporting migration:
</para></listitem>
</itemizedlist>
+
+<warning>
+<title>Achtung!</title>
+
+<para>
+The following <filename>smb.conf</filename> parameters are considered to
+be deprecated and will be removed soon. Do not use them in new
+installations
+</para>
+
+<itemizedlist>
+ <listitem><para><parameter>printer driver file (G)</parameter>
+ </para></listitem>
+
+ <listitem><para><parameter>printer driver (S)</parameter>
+ </para></listitem>
+
+ <listitem><para><parameter>printer driver location (S)</parameter>
+ </para></listitem>
+</itemizedlist>
+</warning>
+
+
+<para>
+The have been two new parameters add in Samba 2.2.2 to for
+better support of Samba 2.0.x backwards capability (<parameter>disable
+spoolss</parameter>) and for using local printers drivers on Windows
+NT/2000 clients (<parameter>use client driver</parameter>). Both of
+these options are described in the smb.coinf(5) man page and are
+disabled by default.
+</para>
+
+
</sect1>
@@ -686,8 +665,8 @@ Here are the possible scenarios for supporting migration:
* NT4:
*
* On NT4, you only have a global devicemode. This global devicemode can be changed
- * by the administrator (or by a user with enough privs). Everytime a user
- * wants to print, the devicemode is resetted to the default. In Word, everytime
+ * by the administrator (or by a user with enough privs). Every time a user
+ * wants to print, the devicemode is reset to the default. In Word, every time
* you print, the printer's characteristics are always reset to the global devicemode.
*
* NT 2000:
@@ -695,7 +674,7 @@ Here are the possible scenarios for supporting migration:
* In W2K, there is the notion of per-user devicemode. The first time you use
* a printer, a per-user devicemode is build from the global devicemode.
* If you change your per-user devicemode, it is saved in the registry, under the
- * H_KEY_CURRENT_KEY sub_tree. So that everytime you print, you have your default
+ * H_KEY_CURRENT_KEY sub_tree. So that every time you print, you have your default
* printer preferences available.
*
* To change the per-user devicemode: it's the "Printing Preferences ..." button
diff --git a/docs/docbook/projdoc/samba-doc.sgml b/docs/docbook/projdoc/samba-doc.sgml
index 7f3f09f1f3..f1211c0ac6 100644
--- a/docs/docbook/projdoc/samba-doc.sgml
+++ b/docs/docbook/projdoc/samba-doc.sgml
@@ -10,6 +10,8 @@
<!ENTITY Samba-PDC-HOWTO SYSTEM "Samba-PDC-HOWTO.sgml">
<!ENTITY CVS-Access SYSTEM "CVS-Access.sgml">
<!ENTITY IntegratingWithWindows SYSTEM "Integrating-with-Windows.sgml">
+<!ENTITY Samba-PAM SYSTEM "PAM-Authentication-And-Samba.sgml">
+<!ENTITY INDEX-FILE SYSTEM "index.sgml">
]>
<book id="Samba-Project-Documentation">
@@ -21,13 +23,16 @@
<surname>SAMBA Team</surname>
</author>
<address><email>samba@samba.org</email></address>
- <pubdate>$rcsId</pubdate>
</bookinfo>
<dedication>
<title>Abstract</title>
<para>
+<emphasis>Last Update</emphasis> : Tue Jul 31 15:58:03 CDT 2001
+</para>
+
+<para>
This book is a collection of HOWTOs added to Samba documentation over the years.
I try to ensure that all are current, but sometimes the is a larger job
than one person can maintain. The most recent version of this document
@@ -42,16 +47,20 @@ Cheers, jerry
</dedication>
+<!-- Chapters -->
&UNIX-INSTALL;
&IntegratingWithWindows;
-&ENCRYPTION;
+&Samba-PAM;
&MS-Dfs-Setup;
+&NT-Security;
&PRINTER-DRIVER2;
&DOMAIN-MEMBER;
&Samba-PDC-HOWTO;
&WINBIND;
-&NT-Security;
&OS2-Client;
&CVS-Access;
+<!-- Autogenerated Index -->
+&INDEX-FILE;
+
</book>
diff --git a/docs/docbook/projdoc/winbind.sgml b/docs/docbook/projdoc/winbind.sgml
index 8a380c206d..b496f30dd7 100644
--- a/docs/docbook/projdoc/winbind.sgml
+++ b/docs/docbook/projdoc/winbind.sgml
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="winbind">
<chapterinfo>
@@ -21,16 +21,17 @@
<pubdate>16 Oct 2000</pubdate>
</chapterinfo>
-<title>Unifed Logons between Windows NT and UNIX using Winbind</title>
+<title>Unified Logons between Windows NT and UNIX using Winbind</title>
<sect1>
<title>Abstract</title>
<para>Integration of UNIX and Microsoft Windows NT through
a unified logon has been considered a "holy grail" in heterogeneous
- computing environments for a long time. We present <emphasis>winbind
- </emphasis>, a component of the Samba suite of programs as a
- solution to the unied logon problem. Winbind uses a UNIX implementation
+ computing environments for a long time. We present
+ <emphasis>winbind</emphasis>, a component of the Samba suite
+ of programs as a solution to the unified logon problem. Winbind
+ uses a UNIX implementation
of Microsoft RPC calls, Pluggable Authentication Modules, and the Name
Service Switch to allow Windows NT domain users to appear and operate
as UNIX users on a UNIX machine. This paper describes the winbind
@@ -53,11 +54,11 @@
and use the Samba suite of programs to provide file and print services
between the two. This solution is far from perfect however, as
adding and deleting users on both sets of machines becomes a chore
- and two sets of passwords are required both of which which
+ and two sets of passwords are required both of which
can lead to synchronization problems between the UNIX and Windows
systems and confusion for users.</para>
- <para>We divide the unifed logon problem for UNIX machines into
+ <para>We divide the unified logon problem for UNIX machines into
three smaller problems:</para>
<itemizedlist>
@@ -77,7 +78,7 @@
information on the UNIX machines and without creating additional
tasks for the system administrator when maintaining users and
groups on either system. The winbind system provides a simple
- and elegant solution to all three components of the unifed logon
+ and elegant solution to all three components of the unified logon
problem.</para>
</sect1>
@@ -95,7 +96,7 @@
<para>The end result is that whenever any
program on the UNIX machine asks the operating system to lookup
a user or group name, the query will be resolved by asking the
- NT domain controller for the specied domain to do the lookup.
+ NT domain controller for the specified domain to do the lookup.
Because Winbind hooks into the operating system at a low level
(via the NSS name resolution modules in the C library) this
redirection to the NT domain controller is completely
@@ -112,11 +113,11 @@
that redirection to a domain controller is wanted for a particular
lookup and which trusted domain is being referenced.</para>
- <para>Additionally, Winbind provides a authentication service
+ <para>Additionally, Winbind provides an authentication service
that hooks into the Pluggable Authentication Modules (PAM) system
to provide authentication via a NT domain to any PAM enabled
applications. This capability solves the problem of synchronizing
- passwords between systems as all passwords are stored in a single
+ passwords between systems since all passwords are stored in a single
location (on the domain controller).</para>
<sect2>
@@ -126,9 +127,9 @@
existing NT based domain infrastructure into which they wish
to put UNIX workstations or servers. Winbind will allow these
organizations to deploy UNIX workstations without having to
- maintain a separate account infrastructure. This greatly simplies
- the administrative overhead of deploying UNIX workstations into
- a NT based organization.</para>
+ maintain a separate account infrastructure. This greatly
+ simplifies the administrative overhead of deploying UNIX
+ workstations into a NT based organization.</para>
<para>Another interesting way in which we expect Winbind to
be used is as a central part of UNIX based appliances. Appliances
@@ -179,11 +180,11 @@
<para>The Name Service Switch, or NSS, is a feature that is
present in many UNIX operating systems. It allows system
information such as hostnames, mail aliases and user information
- to be resolved from dierent sources. For example, a standalone
+ to be resolved from different sources. For example, a standalone
UNIX workstation may resolve system information from a series of
- flat files stored on the local lesystem. A networked workstation
+ flat files stored on the local filesystem. A networked workstation
may first attempt to resolve system information from local files,
- then consult a NIS database for user information or a DNS server
+ and then consult a NIS database for user information or a DNS server
for hostname information.</para>
<para>The NSS application programming interface allows winbind
@@ -196,13 +197,14 @@
a NT domain plus any trusted domain as though they were local
users and groups.</para>
- <para>The primary control le for NSS is <filename>/etc/nsswitch.conf
- </filename>. When a UNIX application makes a request to do a lookup
+ <para>The primary control file for NSS is
+ <filename>/etc/nsswitch.conf</filename>.
+ When a UNIX application makes a request to do a lookup
the C library looks in <filename>/etc/nsswitch.conf</filename>
for a line which matches the service type being requested, for
example the "passwd" service type is used when user or group names
are looked up. This config line species which implementations
- of that service should be tried andin what order. If the passwd
+ of that service should be tried and in what order. If the passwd
config line is:</para>
<para><command>passwd: files example</command></para>
@@ -229,7 +231,7 @@
<para>Pluggable Authentication Modules, also known as PAM,
is a system for abstracting authentication and authorization
technologies. With a PAM module it is possible to specify different
- authentication methods for dierent system applications without
+ authentication methods for different system applications without
having to recompile these applications. PAM is also useful
for implementing a particular policy for authorization. For example,
a system administrator may only allow console logins from users
@@ -241,10 +243,10 @@
UNIX system. This allows Windows NT users to log in to a UNIX
machine and be authenticated against a suitable Primary Domain
Controller. These users can also change their passwords and have
- this change take eect directly on the Primary Domain Controller.
+ this change take effect directly on the Primary Domain Controller.
</para>
- <para>PAM is congured by providing control files in the directory
+ <para>PAM is configured by providing control files in the directory
<filename>/etc/pam.d/</filename> for each of the services that
require authentication. When an authentication request is made
by an application the PAM code in the C library looks up this
@@ -252,7 +254,7 @@
authentication check and in what order. This interface makes adding
a new authentication service for Winbind very easy, all that needs
to be done is that the <filename>pam_winbind.so</filename> module
- is copied to <filename>/lib/security/</filename> and the pam
+ is copied to <filename>/lib/security/</filename> and the PAM
control files for relevant services are updated to allow
authentication via winbind. See the PAM documentation
for more details.</para>
@@ -263,11 +265,11 @@
<title>User and Group ID Allocation</title>
<para>When a user or group is created under Windows NT
- is it allocated a numerical relative identier (RID). This is
- slightly dierent to UNIX which has a range of numbers which are
+ is it allocated a numerical relative identifier (RID). This is
+ slightly different to UNIX which has a range of numbers that are
used to identify users, and the same range in which to identify
groups. It is winbind's job to convert RIDs to UNIX id numbers and
- vice versa. When winbind is congured it is given part of the UNIX
+ vice versa. When winbind is configured it is given part of the UNIX
user id space and a part of the UNIX group id space in which to
store Windows NT users and groups. If a Windows NT user is
resolved for the first time, it is allocated the next UNIX id from
@@ -276,7 +278,7 @@
to UNIX user ids and group ids.</para>
<para>The results of this mapping are stored persistently in
- a ID mapping database held in a tdb database). This ensures that
+ an ID mapping database held in a tdb database). This ensures that
RIDs are mapped to UNIX IDs in a consistent way.</para>
</sect2>
@@ -290,7 +292,7 @@
by NT domain controllers. User or group information returned
by a PDC is cached by winbind along with a sequence number also
returned by the PDC. This sequence number is incremented by
- Windows NT whenever any user or group information is modied. If
+ Windows NT whenever any user or group information is modified. If
a cached entry has expired, the sequence number is requested from
the PDC and compared against the sequence number of the cached entry.
If the sequence numbers do not match, then the cached information
@@ -302,29 +304,553 @@
<sect1>
<title>Installation and Configuration</title>
+
+<para>
+Many thanks to John Trostel <ulink
+url="mailto:jtrostel@snapserver.com">jtrostel@snapserver.com</ulink>
+for providing the HOWTO for this section.
+</para>
+
+<para>
+This HOWTO describes how to get winbind services up and running
+to control access and authenticate users on your Linux box using
+the winbind services which come with SAMBA 2.2.2.
+</para>
+
+
+<sect2>
+<title>Introduction</title>
+
+<para>
+This HOWTO describes the procedures used to get winbind up and
+running on my RedHat 7.1 system. Winbind is capable of providing access
+and authentication control for Windows Domain users through an NT
+or Win2K PDC for 'regular' services, such as telnet a nd ftp, as
+well for SAMBA services.
+</para>
+
+<para>
+This HOWTO has been written from a 'RedHat-centric' perspective, so if
+you are using another distribution, you may have to modify the instructions
+somewhat to fit the way your distribution works.
+</para>
+
+
+<itemizedlist>
+<listitem>
+ <para>
+ <emphasis>Why should I to this?</emphasis>
+ </para>
+
+ <para>This allows the SAMBA administrator to rely on the
+ authentication mechanisms on the NT/Win2K PDC for the authentication
+ of domain members. NT/Win2K users no longer need to have separate
+ accounts on the SAMBA server.
+ </para>
+</listitem>
+
+<listitem>
+ <para>
+ <emphasis>Who should be reading this document?</emphasis>
+ </para>
+
+ <para>
+ This HOWTO is designed for system administrators. If you are
+ implementing SAMBA on a file server and wish to (fairly easily)
+ integrate existing NT/Win2K users from your PDC onto the
+ SAMBA server, this HOWTO is for you. That said, I am no NT or PAM
+ expert, so you may find a better or easier way to accomplish
+ these tasks.
+ </para>
+</listitem>
+</itemizedlist>
+</sect2>
+
+
+<sect2>
+<title>Requirements</title>
+
+<para>
+If you have a samba configuration file that you are currently
+using... BACK IT UP! If your system already uses PAM, BACK UP
+THE <filename>/etc/pam.d</filename> directory contents! If you
+haven't already made a boot disk, MAKE ON NOW!
+</para>
+
+<para>
+Messing with the pam configuration files can make it nearly impossible
+to log in to yourmachine. That's why you want to be able to boot back
+into your machine in single user mode and restore your
+<filename>/etc/pam.d</filename> back to the original state they were in if
+you get frustrated with the way things are going. ;-)
+</para>
+
+<para>
+The newest version of SAMBA (version 2.2.2), available from
+cvs.samba.org, now include a functioning winbindd daemon. Please refer
+to the main SAMBA web page or, better yet, your closest SAMBA mirror
+site for instructions on downloading the source code.
+</para>
+
+<para>
+To allow Domain users the ability to access SAMBA shares and
+files, as well as potentially other services provided by your
+SAMBA machine, PAM (pluggable authentication modules) must
+be setup properly on your machine. In order to compile the
+winbind modules, you should have at least the pam libraries resident
+on your system. For recent RedHat systems (7.1, for instance), that
+means 'pam-0.74-22'. For best results, it is helpful to also
+install the development packages in 'pam-devel-0.74-22'.
+</para>
+
+</sect2>
+
+
+<sect2>
+<title>Testing Things Out</title>
+
+<para>
+Before starting, it is probably best to kill off all the SAMBA
+related daemons running on your server. Kill off all <command>smbd</command>,
+<command>nmbd</command>, and <command>winbindd</command> processes that may
+be running. To use PAM, you will want to make sure that you have the
+standard PAM package (for RedHat) which supplies the <filename>/etc/pam.d</filename>
+directory structure, including the pam modules are used by pam-aware
+services, several pam libraries, and the <filename>/usr/doc</filename>
+and <filename>/usr/man</filename> entries for pam. Winbind built better
+in SAMBA if the pam-devel package was also installed. This package includes
+the header files needed to compile pam-aware applications. For instance, my RedHat
+system has both 'pam-0.74-22' and 'pam-devel-0.74-22' RPMs installed.
+</para>
+
+<sect3>
+<title>Configure and compile SAMBA</title>
+
+<para>
+The configuration and compilation of SAMBA is pretty straightforward.
+The first three steps maynot be necessary depending upon
+whether or not you have previously built the Samba binaries.
+</para>
+
+<para><programlisting>
+<prompt>root# </prompt> autoconf
+<prompt>root# </prompt> make clean
+<prompt>root# </prompt> rm config.cache
+<prompt>root# </prompt> ./configure --with-winbind
+<prompt>root# </prompt> make
+<prompt>root# </prompt> make install
+</programlisting></para>
+
+
+<para>
+This will, by default, install SAMBA in /usr/local/samba. See the
+main SAMBA documentation if you want to install SAMBA somewhere else.
+It will also build the winbindd executable and libraries.
+</para>
+
+</sect3>
+
+<sect3>
+<title>Configure nsswitch.conf and the winbind libraries</title>
+
+<para>
+The libraries needed to run the winbind daemon through nsswitch
+need to be copied to their proper locations, so
+</para>
+
+<para>
+<prompt>root# </prompt> cp ../samba/source/nsswitch/libnss_winbind.so /lib
+</para>
+
+<para>
+I also found it necessary to make the following symbolic link:
+</para>
+
+<para>
+<prompt>root# </prompt> ln -s /lib/libnss_winbind.so /lib/libnss_winbind.so.2
+</para>
+
+<para>
+Now, as root you need to edit <filename>/etc/nsswitch.conf</filename> to
+allow user and group entries to be visible from the <command>winbindd</command>
+daemon, as well as from your /etc/hosts files and NIS servers. My
+<filename>/etc/nsswitch.conf</filename> file look like this after editing:
+</para>
+
+<para><programlisting>
+ passwd: files winbind
+ shadow: files winbind
+ group: files winbind
+</programlisting></para>
+
+<para>
+The libraries needed by the winbind daemon will be automatically
+entered into the ldconfig cache the next time your system reboots, but it
+is faster (and you don't need to reboot) if you do it manually:
+</para>
+
+<para>
+<prompt>root# </prompt> /sbin/ldconfig -v | grep winbind
+</para>
+
+<para>
+This makes <filename>libnss_winbind</filename> available to winbindd
+and echos back a check to you.
+</para>
+
+</sect3>
+
+
+<sect3>
+<title>Configure smb.conf</title>
+
+<para>
+Several parameters are needed in the smb.conf file to control
+the behavior of <command>winbindd</command>. Configure
+<filename>smb.conf</filename> These are described in more detail in
+the <ulink url="winbindd.8.html">winbindd(8)</ulink> man page. My
+<filename>smb.conf</filename> file was modified to
+include the following entries in the [global] section:
+</para>
+
+<para><programlisting>
+[global]
+ <...>
+ # separate domain and username with '+', like DOMAIN+username
+ winbind separator = +
+ # use uids from 10000 to 20000 for domain users
+ winbind uid = 10000-20000
+ # use gids from 10000 to 20000 for domain groups
+ winbind gid = 10000-20000
+ # allow enumeration of winbind users and groups
+ winbind enum users = yes
+ winbind enum groups = yes
+ # give winbind users a real shell (only needed if they have telnet access)
+ template shell = /bin/bash
+</programlisting></para>
+
+</sect3>
+
+
+<sect3>
+<title>Join the SAMBA server to the PDC domain</title>
+
+<para>
+Enter the following command to make the SAMBA server join the
+PDC domain, where <replaceable>DOMAIN</replaceable> is the name of
+your Windows domain and <replaceable>Administrator</replaceable> is
+a domain user who has administrative privileges in the domain.
+</para>
+
+
+<para>
+<prompt>root# </prompt>/usr/local/samba/bin/smbpasswd -j DOMAIN -r PDC -U Administrator
+</para>
+
+
+<para>
+The proper response to the command should be: "Joined the domain
+<replaceable>DOMAIN</replaceable>" where <replaceable>DOMAIN</replaceable>
+is your DOMAIN name.
+</para>
+
+</sect3>
- <para>The easiest way to install winbind is by using the packages
- provided in the <filename>pub/samba/appliance/</filename>
- directory on your nearest
- Samba mirror. These packages provide snapshots of the Samba source
- code and binaries already setup to provide the full functionality
- of winbind. This setup is a little more complex than a normal Samba
- build as winbind needs a small amount of functionality from a
- development code branch called SAMBA_TNG.</para>
+
+<sect3>
+<title>Start up the winbindd daemon and test it!</title>
+
+<para>
+Eventually, you will want to modify your smb startup script to
+automatically invoke the winbindd daemon when the other parts of
+SAMBA start, but it is possible to test out just the winbind
+portion first. To start up winbind services, enter the following
+command as root:
+</para>
+
+<para>
+<prompt>root# </prompt>/usr/local/samba/bin/winbindd
+</para>
+
+<para>
+I'm always paranoid and like to make sure the daemon
+is really running...
+</para>
+
+<para>
+<prompt>root# </prompt> ps -ae | grep winbindd
+3025 ? 00:00:00 winbindd
+</para>
+
+<para>
+Now... for the real test, try to get some information about the
+users on your PDC
+</para>
+
+<para>
+<prompt>root# </prompt> # /usr/local/samba/bin/wbinfo -u
+</para>
+
+<para>
+This should echo back a list of users on your Windows users on
+your PDC. For example, I get the following response:
+</para>
+
+<para><programlisting>
+CEO+Administrator
+CEO+burdell
+CEO+Guest
+CEO+jt-ad
+CEO+krbtgt
+CEO+TsInternetUser
+</programlisting></para>
+
+<para>
+Obviously, I have named my domain 'CEO' and my winbindd separator is '+'.
+</para>
+
+<para>
+You can do the same sort of thing to get group information from
+the PDC:
+</para>
+
+<para><programlisting>
+<prompt>root# </prompt>/usr/local/samba/bin/wbinfo -g
+CEO+Domain Admins
+CEO+Domain Users
+CEO+Domain Guests
+CEO+Domain Computers
+CEO+Domain Controllers
+CEO+Cert Publishers
+CEO+Schema Admins
+CEO+Enterprise Admins
+CEO+Group Policy Creator Owners
+</programlisting></para>
+
+<para>
+The function 'getent' can now be used to get unified
+lists of both local and PDC users and groups.
+Try the following command:
+</para>
+
+<para>
+<prompt>root# </prompt> getent passwd
+</para>
- <para>Once you have installed the packages you should read
- the <command>winbindd(8)</command> man page which will provide you
- with conguration information and give you sample conguration files.
- You may also wish to update the main Samba daemons smbd and nmbd)
- with a more recent development release, such as the recently
- announced Samba 2.2 alpha release.</para>
+<para>
+You should get a list that looks like your <filename>/etc/passwd</filename>
+list followed by the domain users with their new uids, gids, home
+directories and default shells.
+</para>
+
+<para>
+The same thing can be done for groups with the command
+</para>
+
+<para>
+<prompt>root# </prompt> getent group
+</para>
+
+</sect3>
+
+
+<sect3>
+<title>Fix the /etc/rc.d/init.d/smb startup files</title>
+
+<para>
+The <command>winbindd</command> daemon needs to start up after the
+<command>smbd</command> and <command>nmbd</command> daemons are running.
+To accomplish this task, you need to modify the <filename>/etc/init.d/smb</filename>
+script to add commands to invoke this daemon in the proper sequence. My
+<filename>/etc/init.d/smb</filename> file starts up <command>smbd</command>,
+<command>nmbd</command>, and <command>winbindd</command> from the
+<filename>/usr/local/samba/bin</filename> directory directly. The 'start'
+function in the script looks like this:
+</para>
+
+<para><programlisting>
+start() {
+ KIND="SMB"
+ echo -n $"Starting $KIND services: "
+ daemon /usr/local/samba/bin/smbd $SMBDOPTIONS
+ RETVAL=$?
+ echo
+ KIND="NMB"
+ echo -n $"Starting $KIND services: "
+ daemon /usr/local/samba/bin/nmbd $NMBDOPTIONS
+ RETVAL2=$?
+ echo
+ KIND="Winbind"
+ echo -n $"Starting $KIND services: "
+ daemon /usr/local/samba/bin/winbindd
+ RETVAL3=$?
+ echo
+ [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && touch /var/lock/subsys/smb || \
+ RETVAL=1
+ return $RETVAL
+}
+</programlisting></para>
+
+<para>
+The 'stop' function has a corresponding entry to shut down the
+services and look s like this:
+</para>
+
+<para><programlisting>
+stop() {
+ KIND="SMB"
+ echo -n $"Shutting down $KIND services: "
+ killproc smbd
+ RETVAL=$?
+ echo
+ KIND="NMB"
+ echo -n $"Shutting down $KIND services: "
+ killproc nmbd
+ RETVAL2=$?
+ echo
+ KIND="Winbind"
+ echo -n $"Shutting down $KIND services: "
+ killproc winbindd
+ RETVAL3=$?
+ [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && rm -f /var/lock/subsys/smb
+ echo ""
+ return $RETVAL
+}
+</programlisting></para>
+
+</sect3>
+
+
+
+<sect3>
+<title>Configure Winbind and PAM</title>
+
+<para>
+If you have made it this far, you know that winbindd is working.
+Now it is time to integrate it into the operation of samba and other
+services. The pam configuration files need to be altered in
+this step. (Did you remember to make backups of your original
+<filename>/etc/pam.d</filename> files? If not, do it now.)
+</para>
+
+<para>
+To get samba to allow domain users and groups, I modified the
+<filename>/etc/pam.d/samba</filename> file from
+</para>
+
+
+<para><programlisting>
+auth required /lib/security/pam_stack.so service=system-auth
+account required /lib/security/pam_stack.so service=system-auth
+</programlisting></para>
+
+<para>
+to
+</para>
+
+<para><programlisting>
+auth required /lib/security/pam_winbind.so
+auth required /lib/security/pam_stack.so service=system-auth
+account required /lib/security/pam_winbind.so
+account required /lib/security/pam_stack.so service=system-auth
+</programlisting></para>
+
+<para>
+The other services that I modified to allow the use of winbind
+as an authentication service were the normal login on the console (or a terminal
+session), telnet logins, and ftp service. In order to enable these
+services, you may first need to change the entries in
+<filename>/etc/xinetd.d</filename> (or <filename>/etc/inetd.conf</filename>).
+RedHat 7.1 uses the new xinetd.d structure, in this case you need
+to change the lines in <filename>/etc/xinetd.d/telnet</filename>
+and <filename>/etc/xinetd.d/wu-ftp</filename> from
+</para>
+
+<para><programlisting>
+enable = no
+</programlisting></para>
+
+<para>
+to
+</para>
+
+<para><programlisting>
+enable = yes
+</programlisting></para>
+
+<para>
+For ftp services to work properly, you will also need to either
+have individual directories for the domain users already present on
+the server, or change the home directory template to a general
+directory for all domain users. These can be easily set using
+the <filename>smb.conf</filename> global entry
+<command>template homedir</command>.
+</para>
+
+<para>
+The <filename>/etc/pam.d/ftp</filename> file can be changed
+to allow winbind ftp access in a manner similar to the
+samba file. My <filename>/etc/pam.d/ftp</filename> file was
+changed to look like this:
+</para>
+
+<para><programlisting>
+auth sufficient /lib/security/pam_winbind.so
+auth required /lib/security/pam_listfile.so item=user sense=deny file=/etc/ftpusers onerr=succeed
+auth required /lib/security/pam_stack.so service=system-auth
+auth required /lib/security/pam_shells.so
+account required /lib/security/pam_stack.so service=system-auth
+session required /lib/security/pam_stack.so service=system-auth
+</programlisting></para>
+
+<para>
+The <filename>/etc/pam.d/login</filename> file can be changed nearly the
+same way. It now looks like this:
+</para>
+
+<para><programlisting>
+auth required /lib/security/pam_securetty.so
+auth sufficient /lib/security/pam_winbind.so
+auth sufficient /lib/security/pam_unix.so use_first_pass
+auth required /lib/security/pam_stack.so service=system-auth
+auth required /lib/security/pam_nologin.so
+account sufficient /lib/security/pam_winbind.so
+account required /lib/security/pam_stack.so service=system-auth
+password required /lib/security/pam_stack.so service=system-auth
+session required /lib/security/pam_stack.so service=system-auth
+session optional /lib/security/pam_console.so
+</programlisting></para>
+
+<para>
+In this case, I added the <command>auth sufficient /lib/security/pam_winbind.so</command>
+lines as before, but also added the <command>required pam_securetty.so</command>
+above it, to disallow root logins over the network. I also added a
+<command>sufficient /lib/security/pam_unix.so use_first_pass</command>
+line after the <command>winbind.so</command> line to get rid of annoying
+double prompts for passwords.
+</para>
+
+<para>
+Finally, don't forget to copy the winbind pam modules from
+the source directory in which you originally compiled the new
+SAMBA up to the /lib/security directory so that pam can use it:
+</para>
+
+<para>
+<prompt>root# </prompt> cp ../samba/source/nsswitch/pam_winbind.so /lib/security
+</para>
+
+</sect3>
+
+</sect2>
+
</sect1>
<sect1>
<title>Limitations</title>
<para>Winbind has a number of limitations in its current
- released version which we hope to overcome in future
+ released version that we hope to overcome in future
releases:</para>
<itemizedlist>
@@ -346,12 +872,6 @@
<listitem><para>Currently the winbind PAM module does not take
into account possible workstation and logon time restrictions
that may be been set for Windows NT users.</para></listitem>
-
- <listitem><para>Building winbind from source is currently
- quite tedious as it requires combining source code from two Samba
- branches. Work is underway to solve this by providing all
- the necessary functionality in the main Samba code branch.</para>
- </listitem>
</itemizedlist>
</sect1>
@@ -369,4 +889,3 @@
</sect1>
</chapter>
-
diff --git a/docs/docbook/scripts/collateindex.pl b/docs/docbook/scripts/collateindex.pl
new file mode 100644
index 0000000000..fd757edb32
--- /dev/null
+++ b/docs/docbook/scripts/collateindex.pl
@@ -0,0 +1,595 @@
+# -*- Perl -*-
+#
+
+use Getopt::Std;
+
+$usage = "Usage: $0 <opts> file
+Where <opts> are:
+ -p Link to points in the document. The default is to link
+ to the closest containing section.
+ -g Group terms with IndexDiv based on the first letter
+ of the term (or its sortas attribute).
+ (This probably doesn't handle i10n particularly well)
+ -s name Name the IndexDiv that contains symbols. The default
+ is 'Symbols'. Meaningless if -g is not used.
+ -t name Title for the index.
+ -P file Read a preamble from file. The content of file will
+ be inserted before the <index> tag.
+ -i id The ID for the <index> tag.
+ -o file Output to file. Defaults to stdout.
+ -S scope Scope of the index, must be 'all', 'local', or 'global'.
+ If unspecified, 'all' is assumed.
+ -I scope The implied scope, must be 'all', 'local', or 'global'.
+ IndexTerms which do not specify a scope will have the
+ implied scope. If unspecified, 'all' is assumed.
+ -x Make a SetIndex.
+ -f Force the output file to be written, even if it appears
+ to have been edited by hand.
+ -N New index (generates an empty index file).
+ file The file containing index data generated by Jade
+ with the DocBook HTML Stylesheet.\n";
+
+die $usage if ! getopts('Dfgi:NpP:s:o:S:I:t:x');
+
+$linkpoints = $opt_p;
+$lettergroups = $opt_g;
+$symbolsname = $opt_s || "Symbols";
+$title = $opt_t;
+$preamble = $opt_P;
+$outfile = $opt_o || '-';
+$indexid = $opt_i;
+$scope = uc($opt_S) || 'ALL';
+$impliedscope = uc($opt_I) || 'ALL';
+$setindex = $opt_x;
+$forceoutput = $opt_f;
+$newindex = $opt_N;
+$debug = $opt_D;
+
+$indextag = $setindex ? 'setindex' : 'index';
+
+if ($newindex) {
+ safe_open(*OUT, $outfile);
+ if ($indexid) {
+ print OUT "<$indextag id='$indexid'>\n\n";
+ } else {
+ print OUT "<$indextag>\n\n";
+ }
+
+ print OUT "<!-- This file was produced by collateindex.pl. -->\n";
+ print OUT "<!-- Remove this comment if you edit this file by hand! -->\n";
+
+ print OUT "</$indextag>\n";
+ exit 0;
+}
+
+$dat = shift @ARGV || die $usage;
+die "$0: cannot find $dat.\n" if ! -f $dat;
+
+%legal_scopes = ('ALL' => 1, 'LOCAL' => 1, 'GLOBAL' => 1);
+if ($scope && !$legal_scopes{$scope}) {
+ die "Invalid scope.\n$usage\n";
+}
+if ($impliedscope && !$legal_scopes{$impliedscope}) {
+ die "Invalid implied scope.\n$usage\n";
+}
+
+@term = ();
+%id = ();
+
+$termcount = 0;
+
+print STDERR "Processing $dat...\n";
+
+# Read the index file, creating an array of objects. Each object
+# represents and indexterm and has fields for the content of the
+# indexterm
+
+open (F, $dat);
+while (<F>) {
+ chop;
+
+ if (/^\/indexterm/i) {
+ push (@term, $idx);
+ next;
+ }
+
+ if (/^indexterm (.*)$/i) {
+ $termcount++;
+ $idx = {};
+ $idx->{'zone'} = {};
+ $idx->{'href'} = $1;
+ $idx->{'count'} = $termcount;
+ $idx->{'scope'} = $impliedscope;
+ next;
+ }
+
+ if (/^indexpoint (.*)$/i) {
+ $idx->{'hrefpoint'} = $1;
+ next;
+ }
+
+ if (/^title (.*)$/i) {
+ $idx->{'title'} = $1;
+ next;
+ }
+
+ if (/^primary[\[ ](.*)$/i) {
+ if (/^primary\[(.*?)\] (.*)$/i) {
+ $idx->{'psortas'} = $1;
+ $idx->{'primary'} = $2;
+ } else {
+ $idx->{'psortas'} = $1;
+ $idx->{'primary'} = $1;
+ }
+ next;
+ }
+
+ if (/^secondary[\[ ](.*)$/i) {
+ if (/^secondary\[(.*?)\] (.*)$/i) {
+ $idx->{'ssortas'} = $1;
+ $idx->{'secondary'} = $2;
+ } else {
+ $idx->{'ssortas'} = $1;
+ $idx->{'secondary'} = $1;
+ }
+ next;
+ }
+
+ if (/^tertiary[\[ ](.*)$/i) {
+ if (/^tertiary\[(.*?)\] (.*)$/i) {
+ $idx->{'tsortas'} = $1;
+ $idx->{'tertiary'} = $2;
+ } else {
+ $idx->{'tsortas'} = $1;
+ $idx->{'tertiary'} = $1;
+ }
+ next;
+ }
+
+ if (/^see (.*)$/i) {
+ $idx->{'see'} = $1;
+ next;
+ }
+
+ if (/^seealso (.*)$/i) {
+ $idx->{'seealso'} = $1;
+ next;
+ }
+
+ if (/^significance (.*)$/i) {
+ $idx->{'significance'} = $1;
+ next;
+ }
+
+ if (/^class (.*)$/i) {
+ $idx->{'class'} = $1;
+ next;
+ }
+
+ if (/^scope (.*)$/i) {
+ $idx->{'scope'} = uc($1);
+ next;
+ }
+
+ if (/^startref (.*)$/i) {
+ $idx->{'startref'} = $1;
+ next;
+ }
+
+ if (/^id (.*)$/i) {
+ $idx->{'id'} = $1;
+ $id{$1} = $idx;
+ next;
+ }
+
+ if (/^zone (.*)$/i) {
+ my($href) = $1;
+ $_ = scalar(<F>);
+ chop;
+ die "Bad zone: $_\n" if !/^title (.*)$/i;
+ $idx->{'zone'}->{$href} = $1;
+ next;
+ }
+
+ die "Unrecognized: $_\n";
+}
+close (F);
+
+print STDERR "$termcount entries loaded...\n";
+
+# Fixup the startrefs...
+# In DocBook, STARTREF is a #CONREF attribute; support this by copying
+# all of the fields from the indexterm with the id specified by STARTREF
+# to the indexterm that has the STARTREF.
+foreach $idx (@term) {
+ my($ididx, $field);
+ if ($idx->{'startref'}) {
+ $ididx = $id{$idx->{'startref'}};
+ foreach $field ('primary', 'secondary', 'tertiary', 'see', 'seealso',
+ 'psortas', 'ssortas', 'tsortas', 'significance',
+ 'class', 'scope') {
+ $idx->{$field} = $ididx->{$field};
+ }
+ }
+}
+
+# Sort the index terms
+@term = sort termsort @term;
+
+# Move all of the non-alphabetic entries to the front of the index.
+@term = sortsymbols(@term);
+
+safe_open(*OUT, $outfile);
+
+# Write the index...
+if ($indexid) {
+ print OUT "<$indextag id='$indexid'>\n\n";
+} else {
+ print OUT "<$indextag>\n\n";
+}
+
+print OUT "<!-- This file was produced by collateindex.pl. -->\n";
+print OUT "<!-- Remove this comment if you edit this file by hand! -->\n";
+
+print OUT "<!-- ULINK is abused here.
+
+ The URL attribute holds the URL that points from the index entry
+ back to the appropriate place in the output produced by the HTML
+ stylesheet. (It's much easier to calculate this URL in the first
+ pass.)
+
+ The Role attribute holds the ID (either real or manufactured) of
+ the corresponding INDEXTERM. This is used by the print backends
+ to produce page numbers.
+
+ The entries below are sorted and collated into the correct order.
+ Duplicates may be removed in the HTML backend, but in the print
+ backends, it is impossible to suppress duplicate pages or coalesce
+ sequences of pages into a range.
+-->\n\n";
+
+print OUT "<title>$title</title>\n\n" if $title;
+
+$last = {}; # the last indexterm we processed
+$first = 1; # this is the first one
+$group = ""; # we're not in a group yet
+$lastout = ""; # we've not put anything out yet
+
+foreach $idx (@term) {
+ next if $idx->{'startref'}; # no way to represent spans...
+ next if ($idx->{'scope'} eq 'LOCAL') && ($scope eq 'GLOBAL');
+ next if ($idx->{'scope'} eq 'GLOBAL') && ($scope eq 'LOCAL');
+ next if &same($idx, $last); # suppress duplicates
+
+ $termcount--;
+
+ # If primary changes, output a whole new index term, otherwise just
+ # output another secondary or tertiary, as appropriate. We know from
+ # sorting that the terms will always be in the right order.
+ if (!&tsame($last, $idx, 'primary')) {
+ print "DIFF PRIM\n" if $debug;
+ &end_entry() if not $first;
+
+ if ($lettergroups) {
+ # If we're grouping, make the right indexdivs
+ $letter = $idx->{'psortas'};
+ $letter = $idx->{'primary'} if !$letter;
+ $letter = uc(substr($letter, 0, 1));
+
+ # symbols are a special case
+ if (($letter lt 'A') || ($letter gt 'Z')) {
+ if (($group eq '')
+ || (($group ge 'A') && ($group le 'Z'))) {
+ print OUT "</indexdiv>\n" if !$first;
+ print OUT "<indexdiv><title>$symbolsname</title>\n\n";
+ $group = $letter;
+ }
+ } elsif (($group eq '') || ($group ne $letter)) {
+ print OUT "</indexdiv>\n" if !$first;
+ print OUT "<indexdiv><title>$letter</title>\n\n";
+ $group = $letter;
+ }
+ }
+
+ $first = 0; # there can only be on first ;-)
+
+ print OUT "<indexentry>\n";
+ print OUT " <primaryie>", $idx->{'primary'};
+ $lastout = "primaryie";
+
+ if ($idx->{'secondary'}) {
+ print OUT "\n </primaryie>\n";
+ print OUT " <secondaryie>", $idx->{'secondary'};
+ $lastout = "secondaryie";
+ };
+
+ if ($idx->{'tertiary'}) {
+ print OUT "\n </secondaryie>\n";
+ print OUT " <tertiaryie>", $idx->{'tertiary'};
+ $lastout = "tertiaryie";
+ }
+ } elsif (!&tsame($last, $idx, 'secondary')) {
+ print "DIFF SEC\n" if $debug;
+
+ print OUT "\n </$lastout>\n" if $lastout;
+
+ print OUT " <secondaryie>", $idx->{'secondary'};
+ $lastout = "secondaryie";
+ if ($idx->{'tertiary'}) {
+ print OUT "\n </secondaryie>\n";
+ print OUT " <tertiaryie>", $idx->{'tertiary'};
+ $lastout = "tertiaryie";
+ }
+ } elsif (!&tsame($last, $idx, 'tertiary')) {
+ print "DIFF TERT\n" if $debug;
+
+ print OUT "\n </$lastout>\n" if $lastout;
+
+ if ($idx->{'tertiary'}) {
+ print OUT " <tertiaryie>", $idx->{'tertiary'};
+ $lastout = "tertiaryie";
+ }
+ }
+
+ &print_term($idx);
+
+ $last = $idx;
+}
+
+# Termcount is > 0 iff some entries were skipped.
+print STDERR "$termcount entries ignored...\n";
+
+&end_entry();
+
+print OUT "</indexdiv>\n" if $lettergroups;
+print OUT "</$indextag>\n";
+
+close (OUT);
+
+print STDERR "Done.\n";
+
+sub same {
+ my($a) = shift;
+ my($b) = shift;
+
+ my($aP) = $a->{'psortas'} || $a->{'primary'};
+ my($aS) = $a->{'ssortas'} || $a->{'secondary'};
+ my($aT) = $a->{'tsortas'} || $a->{'tertiary'};
+
+ my($bP) = $b->{'psortas'} || $b->{'primary'};
+ my($bS) = $b->{'ssortas'} || $b->{'secondary'};
+ my($bT) = $b->{'tsortas'} || $b->{'tertiary'};
+
+ my($same);
+
+ $aP =~ s/^\s*//; $aP =~ s/\s*$//; $aP = uc($aP);
+ $aS =~ s/^\s*//; $aS =~ s/\s*$//; $aS = uc($aS);
+ $aT =~ s/^\s*//; $aT =~ s/\s*$//; $aT = uc($aT);
+ $bP =~ s/^\s*//; $bP =~ s/\s*$//; $bP = uc($bP);
+ $bS =~ s/^\s*//; $bS =~ s/\s*$//; $bS = uc($bS);
+ $bT =~ s/^\s*//; $bT =~ s/\s*$//; $bT = uc($bT);
+
+# print "[$aP]=[$bP]\n";
+# print "[$aS]=[$bS]\n";
+# print "[$aT]=[$bT]\n";
+
+ # Two index terms are the same if:
+ # 1. the primary, secondary, and tertiary entries are the same
+ # (or have the same SORTAS)
+ # AND
+ # 2. They occur in the same titled section
+ # AND
+ # 3. They point to the same place
+ #
+ # Notes: Scope is used to suppress some entries, but can't be used
+ # for comparing duplicates.
+ # Interpretation of "the same place" depends on whether or
+ # not $linkpoints is true.
+
+ $same = (($aP eq $bP)
+ && ($aS eq $bS)
+ && ($aT eq $bT)
+ && ($a->{'title'} eq $b->{'title'})
+ && ($a->{'href'} eq $b->{'href'}));
+
+ # If we're linking to points, they're only the same if they link
+ # to exactly the same spot. (surely this is redundant?)
+ $same = $same && ($a->{'hrefpoint'} eq $b->{'hrefpoint'})
+ if $linkpoints;
+
+ $same;
+}
+
+sub tsame {
+ # Unlike same(), tsame only compares a single term
+ my($a) = shift;
+ my($b) = shift;
+ my($term) = shift;
+ my($sterm) = substr($term, 0, 1) . "sortas";
+ my($A, $B);
+
+ $A = $a->{$sterm} || $a->{$term};
+ $B = $b->{$sterm} || $b->{$term};
+
+ $A =~ s/^\s*//; $A =~ s/\s*$//; $A = uc($A);
+ $B =~ s/^\s*//; $B =~ s/\s*$//; $B = uc($B);
+
+ return $A eq $B;
+}
+
+sub end_entry {
+ # End any open elements...
+ print OUT "\n </$lastout>\n" if $lastout;
+ print OUT "</indexentry>\n\n";
+ $lastout = "";
+}
+
+sub print_term {
+ # Print out the links for an indexterm. There can be more than
+ # one if the term has a ZONE that points to more than one place.
+ # (do we do the right thing in that case?)
+ my($idx) = shift;
+ my($key, $indent, @hrefs);
+ my(%href) = ();
+ my(%phref) = ();
+
+ $indent = " ";
+
+ if ($idx->{'see'}) {
+ # it'd be nice to make this a link...
+ if ($lastout) {
+ print OUT "\n </$lastout>\n";
+ $lastout = "";
+ }
+ print OUT $indent, "<seeie>", $idx->{'see'}, "</seeie>\n";
+ return;
+ }
+
+ if ($idx->{'seealso'}) {
+ # it'd be nice to make this a link...
+ if ($lastout) {
+ print OUT "\n </$lastout>\n";
+ $lastout = "";
+ }
+ print OUT $indent, "<seealsoie>", $idx->{'seealso'}, "</seealsoie>\n";
+ return;
+ }
+
+ if (keys %{$idx->{'zone'}}) {
+ foreach $key (keys %{$idx->{'zone'}}) {
+ $href{$key} = $idx->{'zone'}->{$key};
+ $phref{$key} = $idx->{'zone'}->{$key};
+ }
+ } else {
+ $href{$idx->{'href'}} = $idx->{'title'};
+ $phref{$idx->{'href'}} = $idx->{'hrefpoint'};
+ }
+
+ # We can't use <LINK> because we don't know the ID of the term in the
+ # original source (and, in fact, it might not have one).
+ print OUT ",\n";
+ @hrefs = keys %href;
+ while (@hrefs) {
+ my($linkend) = "";
+ my($role) = "";
+ $key = shift @hrefs;
+ if ($linkpoints) {
+ $linkend = $phref{$key};
+ } else {
+ $linkend = $key;
+ }
+
+ $role = $linkend;
+ $role = $1 if $role =~ /\#(.*)$/;
+
+ print OUT $indent;
+ print OUT "<ulink url=\"$linkend\" role=\"$role\">";
+ print OUT "<emphasis>" if ($idx->{'significance'} eq 'PREFERRED');
+ print OUT $href{$key};
+ print OUT "</emphasis>" if ($idx->{'significance'} eq 'PREFERRED');
+ print OUT "</ulink>";
+ }
+}
+
+sub termsort {
+ my($aP) = $a->{'psortas'} || $a->{'primary'};
+ my($aS) = $a->{'ssortas'} || $a->{'secondary'};
+ my($aT) = $a->{'tsortas'} || $a->{'tertiary'};
+ my($ap) = $a->{'count'};
+
+ my($bP) = $b->{'psortas'} || $b->{'primary'};
+ my($bS) = $b->{'ssortas'} || $b->{'secondary'};
+ my($bT) = $b->{'tsortas'} || $b->{'tertiary'};
+ my($bp) = $b->{'count'};
+
+ $aP =~ s/^\s*//; $aP =~ s/\s*$//; $aP = uc($aP);
+ $aS =~ s/^\s*//; $aS =~ s/\s*$//; $aS = uc($aS);
+ $aT =~ s/^\s*//; $aT =~ s/\s*$//; $aT = uc($aT);
+ $bP =~ s/^\s*//; $bP =~ s/\s*$//; $bP = uc($bP);
+ $bS =~ s/^\s*//; $bS =~ s/\s*$//; $bS = uc($bS);
+ $bT =~ s/^\s*//; $bT =~ s/\s*$//; $bT = uc($bT);
+
+ if ($aP eq $bP) {
+ if ($aS eq $bS) {
+ if ($aT eq $bT) {
+ # make sure seealso's always sort to the bottom
+ return 1 if ($a->{'seealso'});
+ return -1 if ($b->{'seealso'});
+ # if everything else is the same, keep these elements
+ # in document order (so the index links are in the right
+ # order)
+ return $ap <=> $bp;
+ } else {
+ return $aT cmp $bT;
+ }
+ } else {
+ return $aS cmp $bS;
+ }
+ } else {
+ return $aP cmp $bP;
+ }
+}
+
+sub sortsymbols {
+ my(@term) = @_;
+ my(@new) = ();
+ my(@sym) = ();
+ my($letter);
+ my($idx);
+
+ # Move the non-letter things to the front. Should digits be thier
+ # own group? Maybe...
+ foreach $idx (@term) {
+ $letter = $idx->{'psortas'};
+ $letter = $idx->{'primary'} if !$letter;
+ $letter = uc(substr($letter, 0, 1));
+
+ if (($letter lt 'A') || ($letter gt 'Z')) {
+ push (@sym, $idx);
+ } else {
+ push (@new, $idx);
+ }
+ }
+
+ return (@sym, @new);
+}
+
+sub safe_open {
+ local(*OUT) = shift;
+ local(*F, $_);
+
+ if (($outfile ne '-') && (!$forceoutput)) {
+ my($handedit) = 1;
+ if (open (OUT, $outfile)) {
+ while (<OUT>) {
+ if (/<!-- Remove this comment if you edit this file by hand! -->/){
+ $handedit = 0;
+ last;
+ }
+ }
+ close (OUT);
+ } else {
+ $handedit = 0;
+ }
+
+ if ($handedit) {
+ print "\n$outfile appears to have been edited by hand; use -f or\n";
+ print " change the output file.\n";
+ exit 1;
+ }
+ }
+
+ open (OUT, ">$outfile") || die "$usage\nCannot write to $outfile.\n";
+
+ if ($preamble) {
+ # Copy the preamble
+ if (open(F, $preamble)) {
+ while (<F>) {
+ print OUT $_;
+ }
+ close(F);
+ } else {
+ warn "$0: cannot open preamble $preamble.\n";
+ }
+ }
+}
diff --git a/docs/docbook/scripts/strip-links.pl b/docs/docbook/scripts/strip-links.pl
index 495822264e..dbbdceaabc 100644
--- a/docs/docbook/scripts/strip-links.pl
+++ b/docs/docbook/scripts/strip-links.pl
@@ -6,8 +6,9 @@
while (<STDIN>) {
+ chomp ($_);
$_ =~ s/\s*<URL:.*html.*>\s*//g;
- print "$_";
+ print "$_\n";
}
exit 0;