diff options
author | Gerald Carter <jerry@samba.org> | 2003-09-09 02:58:53 +0000 |
---|---|---|
committer | Gerald Carter <jerry@samba.org> | 2003-09-09 02:58:53 +0000 |
commit | 99bde6889d3d8b7a9e950c86c30e82662e1dacdd (patch) | |
tree | bb7d34722e3b2b98ae7e36c11f4e7e4d4538b6fb /docs/docbook | |
parent | a50367ee119d0acf1bcaaf93f8c6fcc8fa68c999 (diff) | |
download | samba-99bde6889d3d8b7a9e950c86c30e82662e1dacdd.tar.gz samba-99bde6889d3d8b7a9e950c86c30e82662e1dacdd.tar.bz2 samba-99bde6889d3d8b7a9e950c86c30e82662e1dacdd.zip |
syncing files from 3.0 into HEAD again
(This used to be commit bca0bba209255d0effbae6a3d3b6d298f0952c3a)
Diffstat (limited to 'docs/docbook')
119 files changed, 7090 insertions, 5087 deletions
diff --git a/docs/docbook/Makefile.in b/docs/docbook/Makefile.in index ba3d0845ef..7169cc90c4 100644 --- a/docs/docbook/Makefile.in +++ b/docs/docbook/Makefile.in @@ -1,16 +1,14 @@ ################################################################# # Makefile.in for Samba Documentation # Authors: James Moore <jmoore@php.net> -# Gerald Carter <jerry@samba.org> -# Jelmer Vernooij <jelmer@samba.org> +# Gerald Carter <jerry@samba.org> +# Jelmer Vernooij <jelmer@samba.org> # # Please see http://www.samba.org/samba/cvs.html # for information on getting the latest # source and documentation source files. # - -# Autoconf Variables - +# MANPAGES_NAMES=findsmb.1 smbclient.1 \ smbspool.8 lmhosts.5 \ smbcontrol.1 smbstatus.1 \ @@ -23,24 +21,23 @@ MANPAGES_NAMES=findsmb.1 smbclient.1 \ smbcacls.1 smbsh.1 winbindd.8 \ tdbbackup.8 vfstest.1 \ profiles.1 smbtree.1 ntlm_auth.1 \ - editreg.1 smbcquotas.1 + editreg.1 smbcquotas.1 log2pcap.1 \ + mount.cifs.8 ## This part contains only rules. You shouldn't need to change it ## if you are adding docs -XSLTPROC = @XSLTPROC@ -PDFLATEX = @PDFLATEX@ -LATEX = @LATEX@ +TEXSTYLESHEET = @TEXSTYLESHEET@ +XSLTPROC = @XSLTPROC@ @PAPERSIZE@ --stringparam samba-book 1 --stringparam duplicate_ulinks "@DUPLICATE_ULINKS@" @FONTSIZE@ @CROP@ DVIPS = @DVIPS@ -HTMLDOC = @HTMLDOC@ PNGTOPNM = @PNGTOPNM@ PNMTOPS = @PNMTOPS@ XMLTO = @XMLTO@ SRCDIR = @srcdir@ MANDIR=../manpages -HTMLDIR=../htmldocs MANPROJDOC = manpages PROJDOC = projdoc +MAKEINDEX = @MAKEINDEX@ IMAGEPROJDIR = $(PROJDOC)/imagefiles DEVDOC = devdoc SMBDOTCONFDOC = smbdotconf @@ -50,22 +47,26 @@ DVIDIR = .. TXTDIR = ../textdocs FAQPROJDOC = faq FAQDIR = ../faq +HTMLDIR=../htmldocs +PDFLATEX = TEXINPUTS=xslt/latex:.: @PDFLATEX@ --interaction nonstopmode +LATEX = TEXINPUTS=xslt/latex:.: @LATEX@ --interaction nonstopmode MANPAGES=$(patsubst %,$(MANDIR)/%,$(MANPAGES_NAMES)) MANPAGES_HTML=$(patsubst %,$(HTMLDIR)/%.html,$(MANPAGES_NAMES)) PROJDOC_IMAGES_PNG = $(wildcard $(IMAGEPROJDIR)/*.png) PROJDOC_IMAGES_EPS=$(patsubst %.png,%.eps,$(wildcard $(IMAGEPROJDIR)/*.png)) -PROJDOC_DEPS = $(PROJDOC)/*.xml $(PROJDOC)/attributions.xml +PROJDOC_DEPS = $(PROJDOC)/*.xml $(PROJDOC)/attributions.xml $(MANPROJDOC)/*.xml $(SMBDOTCONFDOC)/smb.conf.5.xml $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/parameters.service.xml DEVDOC_DEPS = $(DEVDOC)/*.xml $(DEVDOC)/attributions.xml all: @echo "Supported make targets:" + @echo "pdf - Build PDF version of book" + @echo "tex - Build Latex version of book" + @echo "dvi - Build Device Independant File of book" + @echo "ps - Build PostScript version of book" + @echo "everything - Build all of the above" @echo "manpages - Build manpages" - @echo "pdf - Build PDF version of HOWTO Collection and Developers Guide" - @echo "tex - Build Latex version of HOWTO Collection and Developers Guide" - @echo "dvi - Build Device Independant Files of HOWTO Collection and Developers Guide" - @echo "ps - Build PostScript version of HOWTO Collection and Developers Guide" @echo "txt - Build plain text version of HOWTO Collection and Developers Guide" @echo -n "html-single - Build single file HTML version of HOWTO Collection" @echo " and developers guide" @@ -79,106 +80,92 @@ everything: manpages pdf html-single html htmlman htmlfaq txt ps # Global rules -manpages: $(MANDIR) $(MANPAGES) -tex: samba-doc.tex dev-doc.tex pdf: $(PDFDIR) $(PDFDIR)/Samba-HOWTO-Collection.pdf $(PDFDIR)/Samba-Developers-Guide.pdf dvi: $(DVIDIR) $(DVIDIR)/Samba-HOWTO-Collection.dvi $(DVIDIR)/Samba-Developers-Guide.dvi ps: $(PSDIR) $(PSDIR)/Samba-HOWTO-Collection.ps $(PSDIR)/Samba-Developers-Guide.ps -hpdf: $(PDFDIR) $(PDFDIR)/Samba-HOWTO-Collection.pdf txt: $(TXTDIR) $(TXTDIR)/Samba-HOWTO-Collection.txt $(TXTDIR)/Samba-Developers-Guide.txt htmlman: $(HTMLDIR) $(MANPAGES_HTML) CSS htmlfaq: $(HTMLDIR) CSS - @$(XSLTPROC) --stringparam base.dir "$(FAQDIR)/" --stringparam root.filename samba-faq xslt/html-chunk.xsl $(FAQPROJDOC)/sambafaq.xml + $(XSLTPROC) --stringparam base.dir "$(FAQDIR)/" --stringparam root.filename samba-faq xslt/html-chunk.xsl $(FAQPROJDOC)/sambafaq.xml html-single: $(HTMLDIR) CSS $(HTMLDIR)/Samba-HOWTO-Collection.html $(HTMLDIR)/Samba-Developers-Guide.html -html: $(HTMLDIR) CSS $(PROJDOC_DEPS) - @$(XSLTPROC) xslt/html-chunk.xsl $(PROJDOC)/samba-doc.xml +html: $(HTMLDIR) CSS Samba-HOWTO-Collection.xml + $(XSLTPROC) -o $(HTMLDIR) xslt/html-chunk.xsl Samba-HOWTO-Collection.xml +manpages: $(MANDIR) $(MANPAGES) +tex: Samba-HOWTO-Collection.tex Samba-Developers-Guide.tex + +Samba-HOWTO-Collection.xml: $(PROJDOC)/samba-doc.xml $(PROJDOC_DEPS) + $(XSLTPROC) --xinclude --output $@ xslt/expand-sambadoc.xsl $< + +Samba-Developers-Guide.xml: $(DEVDOC)/dev-doc.xml $(DEVDOC_DEPS) + $(XSLTPROC) --xinclude --output $@ xslt/expand-sambadoc.xsl $< + +$(PROJDOC)/attributions.xml: $(PROJDOC)/samba-doc.xml + @echo > $@ # Make sure we don't get recursive dependencies, etc! + $(XSLTPROC) --output $@ xslt/generate-attributions.xsl $< + +$(DEVDOC)/attributions.xml: $(DEVDOC)/dev-doc.xml + @echo > $@ # Make sure we don't get recursive dependencies, etc! + $(XSLTPROC) --output $@ xslt/generate-attributions.xsl $< + +clean: + @rm -f *.xml $(MANPAGES) $(TXTDIR)/*.txt $(PSDIR)/*.ps $(PDFDIR)/*.pdf + @rm -f $(SMBDOTCONFDOC)/parameters.*.xml $(DVIDIR)/*.dvi + @rm -f samba-doc.* dev-doc.* $(PROJDOC)/attributions.xml $(DEVDOC)/attributions.xml + @rm -f $(IMAGEPROJDIR)/*.eps $(MANPROJDOC)/smb.conf.5.xml # Text files $(TXTDIR): mkdir $(TXTDIR) -$(TXTDIR)/Samba-HOWTO-Collection.txt: $(PROJDOC)/samba-doc.xml $(PROJDOC_DEPS) - @echo "Converting samba-doc to plain text..." - @$(XMLTO) txt -o $(TXTDIR) $< - @mv $(TXTDIR)/samba-doc.txt $(TXTDIR)/Samba-HOWTO-Collection.txt - -$(TXTDIR)/Samba-Developers-Guide.txt: $(DEVDOC)/dev-doc.xml $(DEVDOC_DEPS) - @echo "Converting dev-doc to plain text..." - @$(XMLTO) txt -o $(TXTDIR) $< - @mv $(TXTDIR)/dev-doc.txt $(TXTDIR)/Samba-Developers-Guide.txt +$(TXTDIR)/%.txt: %.xml + $(XMLTO) txt -o $(TXTDIR) $< > $@ # Tex files -samba-doc.tex: $(PROJDOC)/samba-doc.xml $(PROJDOC_DEPS) - @echo "Converting samba-doc to LaTeX..." - @$(XSLTPROC) --output $@ xslt/latex.xsl $< +%.tex: %.xml + $(XSLTPROC) --output $@ xslt/latex.xsl $< -dev-doc.tex: $(DEVDOC)/dev-doc.xml $(DEVDOC_DEPS) - @echo "Converting dev-doc to LaTeX..." - @$(XSLTPROC) --output $@ xslt/latex.xsl $< - # Adobe PDF files -$(PDFDIR)/Samba-HOWTO-Collection.pdf: samba-doc.tex $(PROJDOC_IMAGES_PNG) - @echo "Building LaTeX sources via $(PDFLATEX)..." - @$(PDFLATEX) $< | grep 'Rerun to get cross-references right' && \ - $(PDFLATEX) $< | grep 'Rerun to get cross-references right' && \ - $(PDFLATEX) $< || echo - @echo "done" - @mv samba-doc.pdf $@ - -$(PDFDIR)/Samba-Developers-Guide.pdf: dev-doc.tex - @echo "Building LaTeX sources via $(PDFLATEX)..." - @$(PDFLATEX) $< | grep 'Rerun to get cross-references right' && \ - $(PDFLATEX) $< | grep 'Rerun to get cross-references right' && \ - $(PDFLATEX) $< || echo - @echo "done" - @mv dev-doc.pdf $@ +$(PDFDIR)/%.pdf: %.tex + $(PDFLATEX) $< + $(PDFLATEX) $< + $(PDFLATEX) $< + mv $(patsubst %.tex,%.pdf,$<) $@ epsimages: $(PROJDOC_IMAGES_EPS) # DVI files -$(DVIDIR)/Samba-HOWTO-Collection.dvi: samba-doc.tex $(PROJDOC_IMAGES_EPS) - @echo "Building LaTeX sources via $(LATEX)..." - @$(LATEX) $< 2>&1 | grep 'Rerun to get cross-references right' && \ - $(LATEX) $< 2>&1 | grep 'Rerun to get cross-references right' && \ - $(LATEX) $< 2>&1 || echo - @echo "done" - @mv samba-doc.dvi $@ - -$(DVIDIR)/Samba-Developers-Guide.dvi: dev-doc.tex - @echo "Building LaTeX sources via $(LATEX)..." - @$(LATEX) $< 2>&1 | grep 'Rerun to get cross-references right' && \ - $(LATEX) $< 2>&1 | grep 'Rerun to get cross-references right' && \ - $(LATEX) $< 2>&1 || echo - @echo "done" - @mv dev-doc.dvi $@ - -$(IMAGEPROJDIR)/%.eps: $(IMAGEPROJDIR)/%.png - @$(PNGTOPNM) $< | $(PNMTOPS) > $@ +$(DVIDIR)/%.dvi: %.tex epsimages + $(LATEX) $< + $(LATEX) $< + $(LATEX) $< + mv $(patsubst %.tex,%.dvi,$<) $@ -# PostScript files -$(PSDIR)/Samba-HOWTO-Collection.ps: $(DVIDIR)/Samba-HOWTO-Collection.dvi - $(DVIPS) -o $@ $< +%.eps: %.png + $(PNGTOPNM) $< | $(PNMTOPS) > $@ -$(PSDIR)/Samba-Developers-Guide.ps: $(DVIDIR)/Samba-Developers-Guide.dvi +# PostScript files +$(PSDIR)/%.ps: $(DVIDIR)/%.dvi $(DVIPS) -o $@ $< # Single large HTML files $(HTMLDIR): - @mkdir $(HTMLDIR) + mkdir $(HTMLDIR) CSS: $(HTMLDIR) xslt/html/samba.css - @cp xslt/html/samba.css $(HTMLDIR)/ + cp xslt/html/samba.css $(HTMLDIR)/ -$(HTMLDIR)/Samba-HOWTO-Collection.html: $(PROJDOC)/samba-doc.xml $(PROJDOC_DEPS) $(PROJDOC_IMAGES_PNG) - @$(XSLTPROC) --output $@ xslt/html.xsl $< +$(HTMLDIR)/Samba-HOWTO-Collection.html: Samba-HOWTO-Collection.xml $(PROJDOC_DEPS) $(PROJDOC_IMAGES_PNG) + $(XSLTPROC) --output $@ xslt/html.xsl $< -$(HTMLDIR)/Samba-Developers-Guide.html: $(DEVDOC)/dev-doc.xml $(DEVDOC_DEPS) - @$(XSLTPROC) --output $@ xslt/html.xsl $< +$(HTMLDIR)/Samba-Developers-Guide.html: Samba-Developers-Guide.xml $(DEVDOC_DEPS) + $(XSLTPROC) --output $@ xslt/html.xsl $< +$(HTMLDIR)/%.html: %.xml + $(XSLTPROC) --output $@ xslt/html.xsl $< -$(HTMLDIR)/%.html: $(MANPROJDOC)/%.xml - @$(XSLTPROC) --output $@ xslt/html.xsl $< +%.xml: $(MANPROJDOC)/%.xml + $(XSLTPROC) --output $@ xslt/expand-sambadoc.xsl $< # Manpages $(SMBDOTCONFDOC)/parameters.all.xml: $(SMBDOTCONFDOC)/generate-file-list.sh @@ -202,33 +189,15 @@ $(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(S generate-context.xsl parameters.all.xml && \ cd .. -$(MANPROJDOC)/smb.conf.5.xml: $(SMBDOTCONFDOC)/smb.conf.5.xml $(SMBDOTCONFDOC)/parameters.all.xml \ - $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/parameters.service.xml \ - $(SMBDOTCONFDOC)/expand-smb.conf.xsl - @$(XSLTPROC) --xinclude --output $(MANPROJDOC)/smb.conf.5.xml $(SMBDOTCONFDOC)/expand-smb.conf.xsl $(SMBDOTCONFDOC)/smb.conf.5.xml - -$(PROJDOC)/attributions.xml: $(PROJDOC)/samba-doc.xml - @echo > $@ # Make sure we don't get recursive dependencies, etc! - @echo "Generating attributions page" - @$(XSLTPROC) --output $@ xslt/generate-attributions.xsl $< - -$(DEVDOC)/attributions.xml: $(DEVDOC)/dev-doc.xml - @echo > $@ # Make sure we don't get recursive dependencies, etc! - @echo "Generating attributions page" - @$(XSLTPROC) --output $@ xslt/generate-attributions.xsl $< +smb.conf.5.xml: $(SMBDOTCONFDOC)/smb.conf.5.xml $(SMBDOTCONFDOC)/parameters.all.xml \ + $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/parameters.service.xml + $(XSLTPROC) --xinclude --output $@ xslt/expand-sambadoc.xsl $< $(MANDIR): mkdir $(MANDIR) -$(MANDIR)/%: $(MANPROJDOC)/%.xml - @$(XSLTPROC) xslt/man.xsl $< +$(MANDIR)/%: %.xml + $(XSLTPROC) --output $@ xslt/man.xsl $< undocumented: $(SMBDOTCONFDOC)/parameters.all.xml $(PERL) scripts/find_missing_doc.pl ../.. - -clean: - @rm -f $(MANPAGES) $(MANPAGES_HTML) $(HTMLDIR)/*.html $(HTMLDIR)/*.css $(TXTDIR)/*.txt $(PSDIR)/*.ps $(PDFDIR)/*.pdf - @rm -f $(MANPROJDOC)/smb.conf.5.xml $(SMBDOTCONFDOC)/parameters.*.xml $(DVIDIR)/*.dvi - @rm -f samba-doc.* dev-doc.* $(PROJDOC)/attributions.xml - @rm -f $(IMAGEPROJDIR)/*.eps - diff --git a/docs/docbook/configure b/docs/docbook/configure index 303ea97f57..d51cdfc48c 100755 --- a/docs/docbook/configure +++ b/docs/docbook/configure @@ -11,6 +11,12 @@ ac_help= ac_default_prefix=/usr/local # Any additions from configure.in: +ac_help="$ac_help + --enable-crop Whether to use a crop template" +ac_help="$ac_help + --with-papersize Specify papersize (a4paper,letter) " +ac_help="$ac_help + --with-fontsize Specify the fontsize in points (default: 10.5) " # Initialize some variables set by options. # The variables have the same names as the options, with @@ -525,7 +531,7 @@ fi # Extract the first word of "xsltproc", so it can be a program name with args. set dummy xsltproc; ac_word=$2 echo $ac_n "checking for $ac_word""... $ac_c" 1>&6 -echo "configure:529: checking for $ac_word" >&5 +echo "configure:535: checking for $ac_word" >&5 if eval "test \"`echo '$''{'ac_cv_path_XSLTPROC'+set}'`\" = set"; then echo $ac_n "(cached) $ac_c" 1>&6 else @@ -563,7 +569,7 @@ fi # Extract the first word of "pdflatex", so it can be a program name with args. set dummy pdflatex; ac_word=$2 echo $ac_n "checking for $ac_word""... $ac_c" 1>&6 -echo "configure:567: checking for $ac_word" >&5 +echo "configure:573: checking for $ac_word" >&5 if eval "test \"`echo '$''{'ac_cv_path_PDFLATEX'+set}'`\" = set"; then echo $ac_n "(cached) $ac_c" 1>&6 else @@ -598,20 +604,19 @@ fi if test "x$PDFLATEX" = x; then { echo "configure: error: "pdflatex is required"" 1>&2; exit 1; } fi - -# Extract the first word of "xmlto", so it can be a program name with args. -set dummy xmlto; ac_word=$2 +# Extract the first word of "makeindex", so it can be a program name with args. +set dummy makeindex; ac_word=$2 echo $ac_n "checking for $ac_word""... $ac_c" 1>&6 -echo "configure:606: checking for $ac_word" >&5 -if eval "test \"`echo '$''{'ac_cv_path_XMLTO'+set}'`\" = set"; then +echo "configure:611: checking for $ac_word" >&5 +if eval "test \"`echo '$''{'ac_cv_path_MAKEINDEX'+set}'`\" = set"; then echo $ac_n "(cached) $ac_c" 1>&6 else - case "$XMLTO" in + case "$MAKEINDEX" in /*) - ac_cv_path_XMLTO="$XMLTO" # Let the user override the test with a path. + ac_cv_path_MAKEINDEX="$MAKEINDEX" # Let the user override the test with a path. ;; ?:/*) - ac_cv_path_XMLTO="$XMLTO" # Let the user override the test with a dos path. + ac_cv_path_MAKEINDEX="$MAKEINDEX" # Let the user override the test with a dos path. ;; *) IFS="${IFS= }"; ac_save_ifs="$IFS"; IFS=":" @@ -619,7 +624,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_XMLTO="$ac_dir/$ac_word" + ac_cv_path_MAKEINDEX="$ac_dir/$ac_word" break fi done @@ -627,17 +632,52 @@ else ;; esac fi -XMLTO="$ac_cv_path_XMLTO" -if test -n "$XMLTO"; then - echo "$ac_t""$XMLTO" 1>&6 +MAKEINDEX="$ac_cv_path_MAKEINDEX" +if test -n "$MAKEINDEX"; then + echo "$ac_t""$MAKEINDEX" 1>&6 else echo "$ac_t""no" 1>&6 fi +if test "x$MAKEINDEX" = x; then + { echo "configure: error: "makeindex is required"" 1>&2; exit 1; } +fi + +PAPERSIZE="" +TEXSTYLESHEET=xslt/latex.xsl +DUPLICATE_ULINKS="" + +CROP="--stringparam docrop 0" + +# Check whether --enable-crop or --disable-crop was given. +if test "${enable_crop+set}" = set; then + enableval="$enable_crop" + test "$withval" && CROP="--stringparam docrop 1" +fi + + +PAPERSIZE="--stringparam papersize a4paper" + +# Check whether --with-papersize or --without-papersize was given. +if test "${with_papersize+set}" = set; then + withval="$with_papersize" + test "$withval" && PAPERSIZE="--stringparam papersize $withval" +fi + + +FONTSIZE="--stringparam fontsize 10.5" + +# Check whether --with-fontsize or --without-fontsize was given. +if test "${with_fontsize+set}" = set; then + withval="$with_fontsize" + test "$withval" && FONTSIZE="--stringparam fontsize $withval" +fi + + # Extract the first word of "latex", so it can be a program name with args. set dummy latex; ac_word=$2 echo $ac_n "checking for $ac_word""... $ac_c" 1>&6 -echo "configure:641: checking for $ac_word" >&5 +echo "configure:681: checking for $ac_word" >&5 if eval "test \"`echo '$''{'ac_cv_path_LATEX'+set}'`\" = set"; then echo $ac_n "(cached) $ac_c" 1>&6 else @@ -672,7 +712,7 @@ fi # Extract the first word of "dvips", so it can be a program name with args. set dummy dvips; ac_word=$2 echo $ac_n "checking for $ac_word""... $ac_c" 1>&6 -echo "configure:676: checking for $ac_word" >&5 +echo "configure:716: checking for $ac_word" >&5 if eval "test \"`echo '$''{'ac_cv_path_DVIPS'+set}'`\" = set"; then echo $ac_n "(cached) $ac_c" 1>&6 else @@ -707,7 +747,7 @@ fi # Extract the first word of "pngtopnm", so it can be a program name with args. set dummy pngtopnm; ac_word=$2 echo $ac_n "checking for $ac_word""... $ac_c" 1>&6 -echo "configure:711: checking for $ac_word" >&5 +echo "configure:751: checking for $ac_word" >&5 if eval "test \"`echo '$''{'ac_cv_path_PNGTOPNM'+set}'`\" = set"; then echo $ac_n "(cached) $ac_c" 1>&6 else @@ -742,7 +782,7 @@ fi # Extract the first word of "pnmtops", so it can be a program name with args. set dummy pnmtops; ac_word=$2 echo $ac_n "checking for $ac_word""... $ac_c" 1>&6 -echo "configure:746: checking for $ac_word" >&5 +echo "configure:786: checking for $ac_word" >&5 if eval "test \"`echo '$''{'ac_cv_path_PNMTOPS'+set}'`\" = set"; then echo $ac_n "(cached) $ac_c" 1>&6 else @@ -774,10 +814,85 @@ else echo "$ac_t""no" 1>&6 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:821: 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 + case "$PERL" in + /*) + ac_cv_path_PERL="$PERL" # Let the user override the test with a path. + ;; + ?:/*) + ac_cv_path_PERL="$PERL" # Let the user override the test with a dos path. + ;; + *) + IFS="${IFS= }"; ac_save_ifs="$IFS"; IFS=":" + ac_dummy="$PATH" + for ac_dir in $ac_dummy; do + test -z "$ac_dir" && ac_dir=. + if test -f $ac_dir/$ac_word; then + ac_cv_path_PERL="$ac_dir/$ac_word" + break + fi + done + IFS="$ac_save_ifs" + ;; +esac +fi +PERL="$ac_cv_path_PERL" +if test -n "$PERL"; then + echo "$ac_t""$PERL" 1>&6 +else + echo "$ac_t""no" 1>&6 +fi + +# Extract the first word of "xmlto", so it can be a program name with args. +set dummy xmlto; ac_word=$2 +echo $ac_n "checking for $ac_word""... $ac_c" 1>&6 +echo "configure:856: checking for $ac_word" >&5 +if eval "test \"`echo '$''{'ac_cv_path_XMLTO'+set}'`\" = set"; then + echo $ac_n "(cached) $ac_c" 1>&6 +else + case "$XMLTO" in + /*) + ac_cv_path_XMLTO="$XMLTO" # Let the user override the test with a path. + ;; + ?:/*) + ac_cv_path_XMLTO="$XMLTO" # Let the user override the test with a dos path. + ;; + *) + IFS="${IFS= }"; ac_save_ifs="$IFS"; IFS=":" + ac_dummy="$PATH" + for ac_dir in $ac_dummy; do + test -z "$ac_dir" && ac_dir=. + if test -f $ac_dir/$ac_word; then + ac_cv_path_XMLTO="$ac_dir/$ac_word" + break + fi + done + IFS="$ac_save_ifs" + ;; +esac +fi +XMLTO="$ac_cv_path_XMLTO" +if test -n "$XMLTO"; then + echo "$ac_t""$XMLTO" 1>&6 +else + echo "$ac_t""no" 1>&6 +fi + DOC_BUILD_DATE=`date '+%d-%m-%Y'` + + + + + trap '' 1 2 15 cat > confcache <<\EOF # This file is a shell script that caches the results of configure @@ -924,12 +1039,19 @@ s%@infodir@%$infodir%g s%@mandir@%$mandir%g s%@XSLTPROC@%$XSLTPROC%g s%@PDFLATEX@%$PDFLATEX%g -s%@XMLTO@%$XMLTO%g +s%@MAKEINDEX@%$MAKEINDEX%g s%@LATEX@%$LATEX%g s%@DVIPS@%$DVIPS%g s%@PNGTOPNM@%$PNGTOPNM%g s%@PNMTOPS@%$PNMTOPS%g +s%@PERL@%$PERL%g +s%@XMLTO@%$XMLTO%g s%@DOC_BUILD_DATE@%$DOC_BUILD_DATE%g +s%@TEXSTYLESHEET@%$TEXSTYLESHEET%g +s%@PAPERSIZE@%$PAPERSIZE%g +s%@DUPLICATE_ULINKS@%$DUPLICATE_ULINKS%g +s%@FONTSIZE@%$FONTSIZE%g +s%@CROP@%$CROP%g CEOF EOF diff --git a/docs/docbook/configure.in b/docs/docbook/configure.in index 25abecafe1..9df4795022 100644 --- a/docs/docbook/configure.in +++ b/docs/docbook/configure.in @@ -8,14 +8,46 @@ AC_PATH_PROG(PDFLATEX, pdflatex) if test "x$PDFLATEX" = x; then AC_MSG_ERROR("pdflatex is required") fi +AC_PATH_PROG(MAKEINDEX, makeindex) +if test "x$MAKEINDEX" = x; then + AC_MSG_ERROR("makeindex is required") +fi + +PAPERSIZE="" +TEXSTYLESHEET=xslt/latex.xsl +DUPLICATE_ULINKS="" + +CROP="--stringparam docrop 0" + +AC_ARG_ENABLE(crop, +[ --enable-crop Whether to use a crop template], +[ test "$withval" && CROP="--stringparam docrop 1" ]) + +PAPERSIZE="--stringparam papersize a4paper" + +AC_ARG_WITH(papersize, +[ --with-papersize Specify papersize (a4paper,letter) ], +[ test "$withval" && PAPERSIZE="--stringparam papersize $withval" ]) + +FONTSIZE="--stringparam fontsize 10.5" + +AC_ARG_WITH(fontsize, +[ --with-fontsize Specify the fontsize in points (default: 10.5) ], +[ test "$withval" && FONTSIZE="--stringparam fontsize $withval" ]) -AC_PATH_PROG(XMLTO, xmlto) AC_PATH_PROG(LATEX, latex) AC_PATH_PROG(DVIPS, dvips) AC_PATH_PROG(PNGTOPNM, pngtopnm) AC_PATH_PROG(PNMTOPS, pnmtops) +AC_PATH_PROG(PERL, perl) +AC_PATH_PROG(XMLTO, xmlto) DOC_BUILD_DATE=`date '+%d-%m-%Y'` AC_SUBST(DOC_BUILD_DATE) +AC_SUBST(TEXSTYLESHEET) +AC_SUBST(PAPERSIZE) +AC_SUBST(DUPLICATE_ULINKS) +AC_SUBST(FONTSIZE) +AC_SUBST(CROP) AC_OUTPUT( Makefile ) diff --git a/docs/docbook/devdoc/dev-doc.xml b/docs/docbook/devdoc/dev-doc.xml index 9236b18986..7000d09c98 100644 --- a/docs/docbook/devdoc/dev-doc.xml +++ b/docs/docbook/devdoc/dev-doc.xml @@ -27,10 +27,6 @@ <title>SAMBA Developers Guide</title> <bookinfo> - <author> - <surname>SAMBA Team</surname> - </author> - <address><email>samba@samba.org</email></address> <abstract> <para> <emphasis>Last Update</emphasis> : Fri Jun 6 00:45:54 CEST 2003 @@ -56,18 +52,13 @@ url="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</u </abstract> -<legalnotice> - -<formalpara> +</bookinfo> +<preface> <title>Attributions</title> - <para> &attributions-dev; - </para> -</formalpara> +</preface> -</legalnotice> -</bookinfo> <!-- Contents --> <toc/> diff --git a/docs/docbook/devdoc/modules.xml b/docs/docbook/devdoc/modules.xml index e2eb78d6c9..171ee27f90 100644 --- a/docs/docbook/devdoc/modules.xml +++ b/docs/docbook/devdoc/modules.xml @@ -136,13 +136,14 @@ for each module and SMB_SUBSYSTEM() for each subsystem. <para><programlisting> SMB_MODULE(<replaceable>subsystem</replaceable>_<replaceable>backend</replaceable>, <replaceable>object files</replaceable>, <replaceable>plugin name</replaceable>, <replaceable>subsystem name</replaceable>, <replaceable>static_action</replaceable>, <replaceable>shared_action</replaceable>) -SMB_SUBSYSTEM(<replaceable>subsystem</replaceable>) +SMB_SUBSYSTEM(<replaceable>subsystem</replaceable>,<replaceable>depfile</replaceable>) </programlisting></para> -<para>Also, make sure to add the correct directives to -<filename>Makefile.in</filename>. <replaceable>@SUBSYSTEM_STATIC@</replaceable> -will be replaced with a list of objects files of the modules that need to -be linked in statically. <replaceable>@SUBSYSTEM_MODULES@</replaceable> will +<para>The depfile for a certain subsystem is the file that calls the +initialisation functions for the statically built in modules.</para> + +<para> +<replaceable>@SUBSYSTEM_MODULES@</replaceable> in Makefile.in will be replaced with the names of the plugins to build. </para> @@ -151,6 +152,13 @@ be changed by ./configure are rebuilded in the 'modules_clean' make target. Practically, this means all c files that contain <command>static_init_subsystem;</command> calls need to be rebuilded. </para> +<note> +<para> +There currently also is a configure.in command called SMB_MODULE_PROVIVES(). +This is used for modules that register multiple things. It should not +be used as probing will most likely disappear in the future.</para> +</note> + </sect2> </sect1> </chapter> diff --git a/docs/docbook/global.ent b/docs/docbook/global.ent index bb1e586cb8..297d1bc883 100644 --- a/docs/docbook/global.ent +++ b/docs/docbook/global.ent @@ -12,7 +12,7 @@ <!-- Author entities --> <!ENTITY person.jelmer ' -<firstname>Jelmer</firstname><surname>Vernooij</surname><othername>R.</othername> +<firstname>Jelmer</firstname><othername>R.</othername><surname>Vernooij</surname><othername>R.</othername> <affiliation> <orgname>The Samba Team</orgname> <address><email>jelmer@samba.org</email></address> @@ -57,14 +57,14 @@ </affiliation> </author>'> -<!ENTITY author.jmcd ' -<author> +<!ENTITY person.jmcd ' <firstname>Jim</firstname><surname>McDonough</surname> <affiliation> <orgname>IBM</orgname> <address><email>jmcd@us.ibm.com</email></address> - </affiliation> -</author>'> + </affiliation>'> + +<!ENTITY author.jmcd '<author>&person.jmcd;</author>'> <!ENTITY author.vl ' <author> @@ -75,6 +75,15 @@ </affiliation> </author>'> +<!ENTITY author.dbannon ' +<author> + <firstname>David</firstname><surname>Bannon</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>dbannon@samba.org</email></address> + </affiliation> +</author>'> + <!ENTITY author.mimir ' <author> <firstname>Rafal</firstname><surname>Szczesniak</surname> @@ -149,9 +158,8 @@ use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.</para> <para>Note that specifying this parameter here will -override the <ulink url="smb.conf.5.html#loglevel">log -level</ulink> parameter in the <ulink url="smb.conf.5.html"> -<filename>smb.conf(5)</filename></ulink> file.</para> +override the <smbconfoption><name>log level</name></smbconfoption> parameter +in the &smb.conf; file.</para> </listitem> </varlistentry>'> @@ -163,8 +171,7 @@ configuration details required by the server. 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. See <ulink url="smb.conf.5.html"><filename> -smb.conf(5)</filename></ulink> for more information. +to provide. See &smb.conf; for more information. The default configuration file name is determined at compile time.</para></listitem> </varlistentry>'> @@ -172,8 +179,8 @@ compile time.</para></listitem> <!ENTITY stdarg.version ' <varlistentry> <term>-V</term> -<listitem><para>Prints the version number for -<command>smbd</command>.</para></listitem> +<listitem><para>Prints the program version number. +</para></listitem> </varlistentry>'> <!ENTITY stdarg.logfile ' @@ -241,15 +248,13 @@ being on a locally connected subnet. </itemizedlist> <para>If this parameter is not set then the name resolve order -defined in the <citerefentry><refentrytitle>smb.conf</refentrytitle> -<manvolnum>5</manvolnum></citerefentry> file parameter -(<parameter>name resolve order</parameter>) will be used. </para> +defined in the &smb.conf; file parameter +(<smbconfoption><name>name resolve order</name></smbconfoption>) will be used. +</para> <para>The default order is lmhosts, host, wins, bcast. Without -this parameter or any entry in the <parameter>name resolve order -</parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle> -<manvolnum>5</manvolnum></citerefentry> file, the name resolution methods -will be attempted in this order. </para></listitem> +this parameter or any entry in the <smbconfoption><name>name resolve order</name></smbconfoption> parameter of the &smb.conf; file, the name +resolution methods will be attempted in this order. </para></listitem> </varlistentry>'> <!ENTITY stdarg.netbios.name ' @@ -257,12 +262,10 @@ will be attempted in this order. </para></listitem> <term>-n <primary NetBIOS name></term> <listitem><para>This option allows you to override the NetBIOS name that Samba uses for itself. This is identical -to setting the <ulink url="smb.conf.5.html#netbiosname"><parameter>NetBIOS -name</parameter></ulink> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle> -<manvolnum>5</manvolnum></citerefentry> file. However, a command +to setting the <smbconfoption><name>netbios name</name></smbconfoption> parameter in the &smb.conf; file. +However, a command line setting will take precedence over settings in -<citerefentry><refentrytitle>smb.conf</refentrytitle> -<manvolnum>5</manvolnum></citerefentry>.</para></listitem> +&smb.conf;.</para></listitem> </varlistentry>'> <!ENTITY stdarg.scope ' @@ -292,8 +295,7 @@ SAM (as opposed to the Domain SAM). </para></listitem> <term>-O socket options</term> <listitem><para>TCP socket options to set on the client socket. See the socket options parameter in -the <citerefentry><refentrytitle>smb.conf</refentrytitle> -<manvolnum>5</manvolnum></citerefentry> manual page for the list of valid +the &smb.conf; manual page for the list of valid options. </para></listitem> </varlistentry> '> @@ -317,12 +319,14 @@ this parameter is specified, the client will request a password.</para></listitem> </varlistentry>'> +<!ENTITY pct "%"> + <!ENTITY stdarg.username ' <varlistentry> -<term>-U|--user=username[%password]</term> +<term>-U|--user=username[&pct;password]</term> <listitem><para>Sets the SMB username or username and password. </para> -<para>If %password is not specified, the user will be prompted. The +<para>If &pct;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 exists, the string is uppercased. If these environmental variables are not @@ -435,13 +439,12 @@ an Active Directory environment. <!ENTITY MAN-SMBCLIENT SYSTEM "manpages/smbclient.1.xml"> <!ENTITY MAN-SMBCONTROL SYSTEM "manpages/smbcontrol.1.xml"> <!ENTITY MAN-LMHOSTS SYSTEM "manpages/lmhosts.5.xml"> -<!ENTITY MAN-SMBCONF SYSTEM "smbdotconf/smb.conf.5.expanded.xml"> +<!ENTITY MAN-SMBCONF SYSTEM "smbdotconf/smb.conf.5.xml"> <!ENTITY MAN-SAMBA SYSTEM "manpages/samba.7.xml"> <!ENTITY MAN-NET SYSTEM "manpages/net.8.xml"> <!ENTITY MAN-NMBD SYSTEM "manpages/nmbd.8.xml"> <!ENTITY MAN-PDBEDIT SYSTEM "manpages/pdbedit.8.xml"> <!ENTITY MAN-SMBD SYSTEM "manpages/smbd.8.xml"> -<!ENTITY MAN-SMBGROUPEDIT SYSTEM "manpages/smbgroupedit.8.xml"> <!ENTITY MAN-SMBMOUNT SYSTEM "manpages/smbmount.8.xml"> <!ENTITY MAN-SMBMNT SYSTEM "manpages/smbmnt.8.xml"> <!ENTITY MAN-SMBPASSWDCONF SYSTEM "manpages/smbpasswd.5.xml"> @@ -507,7 +510,18 @@ an Active Directory environment. <!ENTITY unicode SYSTEM "projdoc/unicode.xml"> <!ENTITY attributions SYSTEM "projdoc/attributions.xml"> <!ENTITY attributions-dev SYSTEM "devdoc/attributions.xml"> -<!ENTITY windows-debug SYSTEM "devdoc/windows-debug.xml"> +<!ENTITY glossary SYSTEM "projdoc/glossary.xml"> +<!ENTITY foreword-tridge SYSTEM "projdoc/foreword-tridge.xml"> <!ENTITY not.implemented "<note><para>Currently NOT implemented.</para></note>"> <!ENTITY rootprompt "<prompt>root# </prompt>"> +<!ENTITY prompt "<prompt>$ </prompt>"> +<!ENTITY dosprompt "<prompt>C:\> </prompt>"> + +<!ENTITY example.workgroup "MIDEARTH"> +<!ENTITY example.server.samba "GANDALF"> +<!ENTITY example.server.windows "SARUMAN"> +<!ENTITY example.workstation.windows "FRODO"> +<!ENTITY example.workstation.samba "BILBO"> +<!ENTITY example.pdc.samba "SAURON"> +<!ENTITY example.server.wins "noldor"> diff --git a/docs/docbook/manpages/editreg.1.xml b/docs/docbook/manpages/editreg.1.xml index 3427552356..0a6b36bcf0 100644 --- a/docs/docbook/manpages/editreg.1.xml +++ b/docs/docbook/manpages/editreg.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="editreg.1"> diff --git a/docs/docbook/manpages/findsmb.1.xml b/docs/docbook/manpages/findsmb.1.xml index e5ec26c4df..8a89b2ce24 100644 --- a/docs/docbook/manpages/findsmb.1.xml +++ b/docs/docbook/manpages/findsmb.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="findsmb.1"> diff --git a/docs/docbook/manpages/lmhosts.5.xml b/docs/docbook/manpages/lmhosts.5.xml index 12d69a7e56..7e1988c121 100644 --- a/docs/docbook/manpages/lmhosts.5.xml +++ b/docs/docbook/manpages/lmhosts.5.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="lmhosts.5"> diff --git a/docs/docbook/manpages/log2pcap.1.xml b/docs/docbook/manpages/log2pcap.1.xml new file mode 100644 index 0000000000..2a336dc326 --- /dev/null +++ b/docs/docbook/manpages/log2pcap.1.xml @@ -0,0 +1,138 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; +]> +<refentry id="log2pcap.1"> + +<refmeta> + <refentrytitle>log2pcap</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>log2pcap</refname> + <refpurpose>Extract network traces from Samba log files</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>log2pcap</command> + <arg choice="opt">-h</arg> + <arg choice="opt">-q</arg> + <arg choice="opt">logfile</arg> + <arg choice="opt">pcap_file</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>log2pcap</command> reads in a + samba log file and generates a pcap file (readable + by most sniffers, such as ethereal or tcpdump) based on the packet + dumps in the log file.</para> + + <para>The log file must have a <parameter>log level</parameter> + of at least <constant>5</constant> to get the SMB header/parameters + right, <constant>10</constant> to get the first 512 data bytes of the + packet and <constant>50</constant> to get the whole packet. + </para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-h</term> + <listitem><para>If this parameter is + specified the output file will be a + hex dump, in a format that is readable + by the <application>text2pcap</application> utility.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-q</term> + <listitem><para>Be quiet. No warning messages about missing + or incomplete data will be given.</para></listitem> + </varlistentry> + + <varlistentry> + <term>logfile</term> + <listitem><para> + Samba log file. log2pcap will try to read the log from stdin + if the log file is not specified. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>pcap_file</term> + <listitem><para> + Name of the output file to write the pcap (or hexdump) data to. + If this argument is not specified, output data will be written + to stdout. + </para></listitem> + </varlistentry> + + &stdarg.help; + + </variablelist> +</refsect1> + +<refsect1> + <title>EXAMPLES</title> + + <para>Extract all network traffic from all samba log files:</para> + + <para><screen> + <prompt>$</prompt> cat /var/log/* | log2pcap > trace.pcap + </screen></para> + + <para>Convert to pcap using text2pcap:</para> + + <para><screen> + <prompt>$</prompt> log2pcap -h samba.log | text2pcap -T 139,139 - trace.pcap + </screen></para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>BUGS</title> + + <para>Only SMB data is extracted from the samba logs, no LDAP, + NetBIOS lookup or other data.</para> + + <para>The generated TCP and IP headers don't contain a valid + checksum.</para> + +</refsect1> + + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>text2pcap</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>ethereal</refentrytitle><manvolnum>1</manvolnum></citerefentry></para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>This manpage was written by Jelmer Vernooij.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/mount.cifs.8.xml b/docs/docbook/manpages/mount.cifs.8.xml new file mode 100644 index 0000000000..99bd6b23d5 --- /dev/null +++ b/docs/docbook/manpages/mount.cifs.8.xml @@ -0,0 +1,302 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; +]> +<refentry id="mount.cifs.8"> + +<refmeta> + <refentrytitle>mount.cifs</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>mount.cifs</refname> + <refpurpose>mount using the Common Internet File System (CIFS)</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + + <command>mount.cifs</command> + <arg choice="req">service</arg> + <arg choice="req">mount-point</arg> + <arg choice="opt">-o options</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>mount.cifs mounts a Linux CIFS filesystem. It +is usually invoked indirectly by +the <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> command when using the +"-t cifs" option. This command only works in Linux, and the kernel must +support the cifs filesystem. The CIFS protocol is the successor to the +SMB protocol and is supported by most Windows servers and many other +commercial servers and Network Attached Storage appliances as well as +by the popular Open Source server Samba. + </para> + + <para> + The mount.cifs utility attaches the UNC name (exported network resource) to + the local directory <emphasis>mount-point</emphasis>. It is possible to set the mode for mount.cifs to +setuid root to allow non-root users to mount shares to directories for which they +have write permission. + </para> + + <para> + Options to <emphasis>mount.cifs</emphasis> are specified as a comma-separated +list of key=value pairs. It is possible to send options other +than those listed here, assuming that cifs supports them. If +you get mount failures, check your kernel log for errors on +unknown options. + </para> + + <para><emphasis>mount.cifs</emphasis> is a daemon. After mounting it keeps running until + the mounted resource is unmounted (usually via the umount utility) + </para> + +</refsect1> + +<refsect1> + <title>OPTIONS</title> + <variablelist> + <varlistentry><term>username=<replaceable>arg</replaceable></term> + + <listitem><para>specifies the username to connect as. If + this is not given, then the environment variable <emphasis>USER</emphasis> is used. This option can also take the +form "user%password" or "user/workgroup" or +"user/workgroup%password" to allow the password and workgroup +to be specified as part of the username. + </para></listitem> + </varlistentry> + + <varlistentry><term>password=<replaceable>arg</replaceable></term> + + <listitem><para>specifies the CIFS password. If this +option is not given then the environment variable +<emphasis>PASSWD</emphasis> is used. If it can find +no password <emphasis>mount.cifs</emphasis> will prompt +for a passeword, unless the guest option is +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><term>credentials=<replaceable>filename</replaceable></term> + + <listitem><para> + specifies a file that contains a username + and/or password. The format of the file is: + </para> + +<programlisting> +.nf + username = <replaceable>value</replaceable> + password = <replaceable>value</replaceable> +.fi +</programlisting> + + <para> +This is preferred over having passwords in plaintext in a +shared file, such as <filename>/etc/fstab</filename>. Be sure to protect any +credentials file properly. + </para> + </listitem></varlistentry> + + <varlistentry> + <term>uid=<replaceable>arg</replaceable></term> + + <listitem><para>sets the uid that will own all files on + the mounted filesystem. + It may be specified as either a username or a numeric uid. + This parameter is ignored when the target server supports + the CIFS Unix extensions.</para></listitem> + </varlistentry> + + <varlistentry> + <term>gid=<replaceable>arg</replaceable></term> + + <listitem><para>sets the gid that will own all files on +the mounted filesystem. +It may be specified as either a groupname or a numeric +gid. This parameter is ignored when the target server supports +the CIFS Unix extensions. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>port=<replaceable>arg</replaceable></term> + + <listitem><para>sets the port number on the server to attempt to contact to negotiate +CIFS support. If the CIFS server is not listening on this port or +if it is not specified, the default ports will be tried i.e. +port 445 is tried and if no response then port 139 is tried. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>file_mode=<replaceable>arg</replaceable></term> + + <listitem><para>If the server does not support the CIFS Unix extensions this + overrides default file mode which will be used locally.</para></listitem> + </varlistentry> + + <varlistentry> + <term>dir_mode=<replaceable>arg</replaceable></term> + + <listitem><para>If the server does not support the CIFS Unix extensions this + overrides the default mode for directories. </para></listitem> + </varlistentry> + + <varlistentry> + <term>ip=<replaceable>arg</replaceable></term> + + <listitem><para>sets the destination host or IP address.</para></listitem> + </varlistentry> + + <varlistentry> + <term>domain=<replaceable>arg</replaceable></term> + + <listitem><para>sets the domain (workgroup) of the user </para></listitem> + </varlistentry> + + <varlistentry> + <term>guest</term> + + <listitem><para>don't prompt for a password </para></listitem> + + </varlistentry> + + <varlistentry> + <term>ro</term> + + <listitem><para>mount read-only</para></listitem> + + </varlistentry> + + <varlistentry> + <term>rw</term> + <listitem><para>mount read-write</para></listitem> + </varlistentry> + + <varlistentry> + <term>rsize</term> + <listitem><para>default network read size</para></listitem> + </varlistentry> + + <varlistentry> + <term>wsize</term> + + <listitem><para>default network write size</para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <para> + The variable <emphasis>USER</emphasis> 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. The variable can be used to set both username and +password by using the format username%password. + </para> + + <para> + The variable <emphasis>PASSWD</emphasis> 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 <emphasis>PASSWD_FILE</emphasis> 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>NOTES</title> + + <para>This command may be used only by root.</para> +</refsect1> + +<refsect1> + <title>CONFIGURATION</title> + <para> +The primary mechanism for making configuration changes and for reading +debug information for the cifs vfs is via the Linux /proc filesystem. +In the directory /proc/fs/cifs are various configuration files and +pseudo files which can display debug information. For more +information see the kernel file fs/cifs/README +</para> +</refsect1> + +<refsect1> + <title>BUGS</title> + + <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> +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> +</refsect1> + + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para> + Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel + source tree may contain additional options and information. +</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>Steve French</para> + + <para>The syntax and manpage were loosely based on that of smbmount. It + was converted to Docbook/XML by Jelmer Vernooij.</para> + + <para>The current maintainer of the Linux cifs vfs and the userspace + tool <emphasis>mount.cifs</emphasis> is <ulink url="mailto:sfrench@samba.org">Steve French</ulink>. + The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink> + is the preferred place to ask questions regarding these programs. + </para> + +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/net.8.xml b/docs/docbook/manpages/net.8.xml index 9787f4e0b0..21dc54d452 100644 --- a/docs/docbook/manpages/net.8.xml +++ b/docs/docbook/manpages/net.8.xml @@ -1,34 +1,8 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; - -<!-- This one is only used by shutdown (RPC) --> -<!ENTITY net.arg.shutdown ' -<varlistentry> -<term>-r</term> -<listitem><para> -Reboot after shutdown. -</para></listitem> -</varlistentry> - -<varlistentry> -<term>-f</term> -<listitem><para> -Force shutting down all applications. -</para></listitem> -</varlistentry> - -<varlistentry> -<term>-t timeout</term> -<listitem><para> -Timeout before system will be shut down. An interactive -user of the system can use this time to cancel the shutdown. -</para></listitem> -</varlistentry>'> +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> - <refentry id="net.8"> <refmeta> @@ -158,6 +132,20 @@ user of the system can use this time to cancel the shutdown. <title>COMMANDS</title> <refsect2> +<title>CHANGESECRETPW</title> + +<para>This command allows the Samba machine account password to be set from an external application +to a machine account password that has already been stored in Active Directory. DO NOT USE this command +unless you know exactly what you are doing. The use of this command requires that the force flag (-f) +be used also. There will be NO command prompt. Whatever information is piped into stdin, either by +typing at the command line or otherwise, will be stored as the literal machine password. Do NOT use +this without care and attention as it will overwrite a legitimate machine password without warning. +YOU HAVE BEEN WARNED. +</para> + +</refsect2> + +<refsect2> <title>TIME</title> <para>The <command>NET TIME</command> command allows you to view the time on a remote server @@ -175,7 +163,7 @@ displays the time on the remote server. <refsect3> <title>TIME SYSTEM</title> -<para> Displays the time on the remote server in a format ready for <command>/bin/date</command></para> +<para>Displays the time on the remote server in a format ready for <command>/bin/date</command></para> </refsect3> @@ -754,7 +742,28 @@ Interdomain account must already be created on the remote PDC. <para>Shut down the remote server.</para> <variablelist> -&net.arg.shutdown; +<varlistentry> +<term>-r</term> +<listitem><para> +Reboot after shutdown. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>-f</term> +<listitem><para> +Force shutting down all applications. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>-t timeout</term> +<listitem><para> +Timeout before system will be shut down. An interactive +user of the system can use this time to cancel the shutdown. +</para></listitem> +</varlistentry>'> + <varlistentry> <term>-C message</term> <listitem><para>Display the specified message on the screen to diff --git a/docs/docbook/manpages/nmbd.8.xml b/docs/docbook/manpages/nmbd.8.xml index a98d189839..056c12e342 100644 --- a/docs/docbook/manpages/nmbd.8.xml +++ b/docs/docbook/manpages/nmbd.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="nmbd.8"> @@ -134,8 +133,7 @@ <listitem><para>NetBIOS lmhosts file. The lmhosts file is a list of NetBIOS names to IP addresses that is loaded by the nmbd server and used via the name - resolution mechanism <ulink url="smb.conf.5.html#nameresolveorder"><parameter>name resolve - order</parameter></ulink> described in <citerefentry><refentrytitle>smb.conf</refentrytitle> + resolution mechanism <smbconfoption><name>name resolve order</name></smbconfoption> described in <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> to resolve any NetBIOS name queries needed by the server. Note that the contents of this file are <emphasis>NOT</emphasis> @@ -174,9 +172,7 @@ <listitem><para>If the server is to be run by the <command>inetd</command> meta-daemon, this file must contain suitable startup information for the - meta-daemon. See the <ulink - url="install.html">install</ulink> document - for details. + meta-daemon. </para></listitem> </varlistentry> @@ -187,9 +183,7 @@ <para>If running the server as a daemon at startup, this file will need to contain an appropriate startup - sequence for the server. See the <ulink - url="install.html">"How to Install and Test SAMBA"</ulink> document - for details.</para></listitem> + sequence for the server.</para></listitem> </varlistentry> <varlistentry> @@ -198,8 +192,7 @@ meta-daemon <command>inetd</command>, this file must contain a mapping of service name (e.g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp). - See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink> - document for details.</para></listitem> + </para></listitem> </varlistentry> <varlistentry> @@ -212,7 +205,7 @@ and <filename>/etc/samba/smb.conf</filename>.</para> <para>When run as a WINS server (see the - <ulink url="smb.conf.5.html#WINSSUPPORT"><constant>wins support</constant></ulink> + <smbconfoption><name>wins support</name></smbconfoption> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> man page), <command>nmbd</command> @@ -221,8 +214,7 @@ wherever Samba was configured to install itself.</para> <para>If <command>nmbd</command> is acting as a <emphasis> - browse master</emphasis> (see the <ulink - url="smb.conf.5.html#LOCALMASTER"><constant>local master</constant></ulink> + browse master</emphasis> (see the <smbconfoption><name>local master</name></smbconfoption> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> man page, <command>nmbd</command> will store the browsing database in the file <filename>browse.dat @@ -278,7 +270,7 @@ <manvolnum>1</manvolnum></citerefentry>, and the Internet RFC's <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>. In addition the CIFS (formerly SMB) specification is available - as a link from the Web page <ulink url="http://samba.org/cifs/"> + as a link from the Web page <ulink noescape="1" url="http://samba.org/cifs/"> http://samba.org/cifs/</ulink>.</para> </refsect1> diff --git a/docs/docbook/manpages/nmblookup.1.xml b/docs/docbook/manpages/nmblookup.1.xml index 3da0649dd5..14df0066f5 100644 --- a/docs/docbook/manpages/nmblookup.1.xml +++ b/docs/docbook/manpages/nmblookup.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="nmblookup"> diff --git a/docs/docbook/manpages/ntlm_auth.1.xml b/docs/docbook/manpages/ntlm_auth.1.xml index a37b5b3b7d..77794f0f3f 100644 --- a/docs/docbook/manpages/ntlm_auth.1.xml +++ b/docs/docbook/manpages/ntlm_auth.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="ntlm-auth.1"> diff --git a/docs/docbook/manpages/pdbedit.8.xml b/docs/docbook/manpages/pdbedit.8.xml index 8f7582dcb5..8647631f63 100644 --- a/docs/docbook/manpages/pdbedit.8.xml +++ b/docs/docbook/manpages/pdbedit.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="pdbedit.8"> @@ -31,6 +30,7 @@ <arg choice="opt">-p profile</arg> <arg choice="opt">-a</arg> <arg choice="opt">-m</arg> + <arg choice="opt">-r</arg> <arg choice="opt">-x</arg> <arg choice="opt">-i passdb-backend</arg> <arg choice="opt">-e passdb-backend</arg> @@ -40,6 +40,7 @@ <arg choice="opt">-s configfile</arg> <arg choice="opt">-P account-policy</arg> <arg choice="opt">-C value</arg> + <arg choice="opt">-c account-control</arg> </cmdsynopsis> </refsynopsisdiv> diff --git a/docs/docbook/manpages/profiles.1.xml b/docs/docbook/manpages/profiles.1.xml index 1dbff39efa..3ae823f634 100644 --- a/docs/docbook/manpages/profiles.1.xml +++ b/docs/docbook/manpages/profiles.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="profiles.1"> diff --git a/docs/docbook/manpages/rpcclient.1.xml b/docs/docbook/manpages/rpcclient.1.xml index 688eef14e8..98795f1775 100644 --- a/docs/docbook/manpages/rpcclient.1.xml +++ b/docs/docbook/manpages/rpcclient.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="rpcclient.1"> @@ -58,8 +57,7 @@ <term>server</term> <listitem><para>NetBIOS name of Server to which to connect. The server can be any SMB/CIFS server. The name is - resolved using the <ulink url="smb.conf.5.html#NAMERESOLVEORDER"> - <parameter>name resolve order</parameter></ulink> line from <citerefentry><refentrytitle>smb.conf</refentrytitle> + resolved using the <smbconfoption><name>name resolve order</name></smbconfoption> line from <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry>.</para></listitem> </varlistentry> diff --git a/docs/docbook/manpages/samba.7.xml b/docs/docbook/manpages/samba.7.xml index 1339f0bb87..35fd15dbf5 100644 --- a/docs/docbook/manpages/samba.7.xml +++ b/docs/docbook/manpages/samba.7.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="samba.7"> @@ -241,6 +240,14 @@ </varlistentry> <varlistentry> + <term><citerefentry><refentrytitle>log2pcap</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>log2pcap</command> is a utility + for generating pcap trace files from Samba log + files.</para></listitem> + </varlistentry> + + <varlistentry> <term><citerefentry><refentrytitle>vfstest</refentrytitle> <manvolnum>1</manvolnum></citerefentry></term> <listitem><para><command>vfstest</command> is a utility diff --git a/docs/docbook/manpages/smbcacls.1.xml b/docs/docbook/manpages/smbcacls.1.xml index ab4fe517eb..78980a6aec 100644 --- a/docs/docbook/manpages/smbcacls.1.xml +++ b/docs/docbook/manpages/smbcacls.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbcacls.1"> @@ -24,7 +23,7 @@ <arg choice="req">filename</arg> <arg choice="opt">-D acls</arg> <arg choice="opt">-M acls</arg> - <arg choice="opt">-A acls</arg> + <arg choice="opt">-a acls</arg> <arg choice="opt">-S acls</arg> <arg choice="opt">-C name</arg> <arg choice="opt">-G name</arg> @@ -56,7 +55,7 @@ <variablelist> <varlistentry> - <term>-A acls</term> + <term>-a acls</term> <listitem><para>Add the ACLs specified to the ACL list. Existing access control entries are unchanged. </para></listitem> </varlistentry> diff --git a/docs/docbook/manpages/smbclient.1.xml b/docs/docbook/manpages/smbclient.1.xml index 8e52e878dd..d3b0bb45cd 100644 --- a/docs/docbook/manpages/smbclient.1.xml +++ b/docs/docbook/manpages/smbclient.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbclient.1"> @@ -221,23 +220,6 @@ </varlistentry> - <varlistentry> - <term>-l logfilename</term> - <listitem><para>If specified, <replaceable>logfilename</replaceable> specifies a base filename - into which operational data from the running client will be - logged. </para> - - <para>The default base name is specified at compile time.</para> - - <para>The base name is used to generate actual log file names. - For example, if the name specified was "log", the debug file - would be <filename>log.client</filename>.</para> - - <para>The log file generated is never removed by the client. - </para></listitem> - </varlistentry> - - &stdarg.help; <varlistentry> diff --git a/docs/docbook/manpages/smbcontrol.1.xml b/docs/docbook/manpages/smbcontrol.1.xml index 7bcb7420ba..af6054de58 100644 --- a/docs/docbook/manpages/smbcontrol.1.xml +++ b/docs/docbook/manpages/smbcontrol.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbcontrol.1"> diff --git a/docs/docbook/manpages/smbcquotas.1.xml b/docs/docbook/manpages/smbcquotas.1.xml index 90166beaf1..53735b76d1 100644 --- a/docs/docbook/manpages/smbcquotas.1.xml +++ b/docs/docbook/manpages/smbcquotas.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbcquotas.1"> @@ -177,7 +176,7 @@ by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.</para> - <para><command>smbcacls</command> was written by Stefan Metzmacher.</para> + <para><command>smbcquotas</command> was written by Stefan Metzmacher.</para> </refsect1> </refentry> diff --git a/docs/docbook/manpages/smbd.8.xml b/docs/docbook/manpages/smbd.8.xml index 0566c67fcb..ded41f995f 100644 --- a/docs/docbook/manpages/smbd.8.xml +++ b/docs/docbook/manpages/smbd.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbd.8"> @@ -144,8 +143,8 @@ file will be created for informational and debug messages from the running server. The log file generated is never removed by the server although - its size may be controlled by the <ulink - url="smb.conf.5.html#maxlogsize"><parameter>max log size</parameter></ulink> + its size may be controlled by the + <smbconfoption><name>max log size</name></smbconfoption> option in the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> file. <emphasis>Beware:</emphasis> If the directory specified does not exist, <command>smbd</command> @@ -192,8 +191,7 @@ <listitem><para>If the server is to be run by the <command>inetd</command> meta-daemon, this file must contain suitable startup information for the - meta-daemon. See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink> - document for details. + meta-daemon. </para></listitem> </varlistentry> @@ -204,8 +202,7 @@ <para>If running the server as a daemon at startup, this file will need to contain an appropriate startup - sequence for the server. See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink> - document for details.</para></listitem> + sequence for the server. </para></listitem> </varlistentry> <varlistentry> @@ -214,8 +211,7 @@ meta-daemon <command>inetd</command>, this file must contain a mapping of service name (e.g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp). - See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink> - document for details.</para></listitem> + </para></listitem> </varlistentry> <varlistentry> @@ -265,8 +261,7 @@ <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"><parameter>obey - pam restricions</parameter></ulink> <citerefentry><refentrytitle>smb.conf</refentrytitle> + by the limitations of the SMB protocol and the <smbconfoption><name>obey pam restrictions</name></smbconfoption> <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> paramater. When this is set, the following restrictions apply: </para> @@ -352,7 +347,7 @@ <manvolnum>1</manvolnum></citerefentry>, and the Internet RFC's <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>. In addition the CIFS (formerly SMB) specification is available - as a link from the Web page <ulink url="http://samba.org/cifs/"> + as a link from the Web page <ulink noescape="1" url="http://samba.org/cifs/"> http://samba.org/cifs/</ulink>.</para> </refsect1> diff --git a/docs/docbook/manpages/smbmnt.8.xml b/docs/docbook/manpages/smbmnt.8.xml index 86596f3ded..0495fa5be0 100644 --- a/docs/docbook/manpages/smbmnt.8.xml +++ b/docs/docbook/manpages/smbmnt.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbmnt.8"> diff --git a/docs/docbook/manpages/smbmount.8.xml b/docs/docbook/manpages/smbmount.8.xml index f3f7d1a99b..0017c99cd5 100644 --- a/docs/docbook/manpages/smbmount.8.xml +++ b/docs/docbook/manpages/smbmount.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbmount.8"> diff --git a/docs/docbook/manpages/smbpasswd.5.xml b/docs/docbook/manpages/smbpasswd.5.xml index c3bd654564..cb6a6070bd 100644 --- a/docs/docbook/manpages/smbpasswd.5.xml +++ b/docs/docbook/manpages/smbpasswd.5.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbpasswd.5"> @@ -140,9 +139,9 @@ 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 - url="smb.conf.5.html#NULLPASSWORDS"><citerefentry><refentrytitle>smb.conf</refentrytitle> - <manvolnum>5</manvolnum></citerefentry></ulink> config file. </para></listitem> + null passwords</parameter> parameter is set in the + <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> config file. </para></listitem> <listitem><para><emphasis>D</emphasis> - This means the account is disabled and no SMB/CIFS logins will be allowed for this user. </para></listitem> @@ -199,7 +198,7 @@ <para>The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + excellent piece of Open Source software, available at <ulink noescape="1" url="ftp://ftp.icce.rug.nl/pub/unix/"> ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 diff --git a/docs/docbook/manpages/smbpasswd.8.xml b/docs/docbook/manpages/smbpasswd.8.xml index 37f617e46a..3ee3a9e12e 100644 --- a/docs/docbook/manpages/smbpasswd.8.xml +++ b/docs/docbook/manpages/smbpasswd.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbpasswd.8"> @@ -318,8 +317,7 @@ has been configured to use the experimental <command>--with-ldapsam</command> option. The <parameter>-w</parameter> switch is used to specify the password to be used with the - <ulink url="smb.conf.5.html#LDAPADMINDN"><parameter>ldap admin - dn</parameter></ulink>. Note that the password is stored in + <smbconfoption><name>ldap admin dn</name></smbconfoption>. Note that the password is stored in the <filename>secrets.tdb</filename> and is keyed off of the admin's DN. This means that if the value of <parameter>ldap admin dn</parameter> ever changes, the password will need to be @@ -370,9 +368,7 @@ allow "localhost" access to the smbd. </para> <para>In addition, the smbpasswd command is only useful if Samba - has been set up to use encrypted passwords. See the document <ulink url="pwencrypt.html"> - "LanMan and NT Password Encryption in Samba"</ulink> in the docs directory for details - on how to do this. </para> + has been set up to use encrypted passwords. </para> </refsect1> diff --git a/docs/docbook/manpages/smbsh.1.xml b/docs/docbook/manpages/smbsh.1.xml index 1bd29917b9..73eb04d4c6 100644 --- a/docs/docbook/manpages/smbsh.1.xml +++ b/docs/docbook/manpages/smbsh.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbsh.1"> @@ -14,7 +13,7 @@ <refnamediv> <refname>smbsh</refname> - <refpurpose>Allows access to Windows NT filesystem + <refpurpose>Allows access to remote SMB shares using UNIX commands</refpurpose> </refnamediv> diff --git a/docs/docbook/manpages/smbspool.8.xml b/docs/docbook/manpages/smbspool.8.xml index 340c7ffff2..ec62a0d5df 100644 --- a/docs/docbook/manpages/smbspool.8.xml +++ b/docs/docbook/manpages/smbspool.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbspool.8"> diff --git a/docs/docbook/manpages/smbstatus.1.xml b/docs/docbook/manpages/smbstatus.1.xml index 657175bf48..1e96b39263 100644 --- a/docs/docbook/manpages/smbstatus.1.xml +++ b/docs/docbook/manpages/smbstatus.1.xml @@ -1,10 +1,8 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> - <refentry id="smbstatus.1"> <refmeta> diff --git a/docs/docbook/manpages/smbtar.1.xml b/docs/docbook/manpages/smbtar.1.xml index 40c915f1f6..c773937844 100644 --- a/docs/docbook/manpages/smbtar.1.xml +++ b/docs/docbook/manpages/smbtar.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbtar.1"> @@ -222,13 +221,13 @@ by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.</para> - <para><ulink url="mailto:poultenr@logica.co.uk">Ricky Poulten</ulink> +<para><ulink noescape="1" url="mailto:poultenr@logica.co.uk">Ricky Poulten</ulink> wrote the tar extension and this man page. The <command>smbtar</command> - script was heavily rewritten and improved by <ulink + script was heavily rewritten and improved by <ulink noescape="1" url="mailto:Martin.Kraemer@mch.sni.de">Martin Kraemer</ulink>. Many thanks to everyone who suggested extensions, improvements, bug fixes, etc. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + excellent piece of Open Source software, available at <ulink noescape="1" url="ftp://ftp.icce.rug.nl/pub/unix/"> ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for diff --git a/docs/docbook/manpages/smbtree.1.xml b/docs/docbook/manpages/smbtree.1.xml index 05f0256b87..9ed2ed4ed8 100644 --- a/docs/docbook/manpages/smbtree.1.xml +++ b/docs/docbook/manpages/smbtree.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbtree.1"> diff --git a/docs/docbook/manpages/smbumount.8.xml b/docs/docbook/manpages/smbumount.8.xml index 665ffdceb3..d8feb8e938 100644 --- a/docs/docbook/manpages/smbumount.8.xml +++ b/docs/docbook/manpages/smbumount.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="smbumount.8"> diff --git a/docs/docbook/manpages/swat.8.xml b/docs/docbook/manpages/swat.8.xml index ad6829c3a6..c0579a9f1f 100644 --- a/docs/docbook/manpages/swat.8.xml +++ b/docs/docbook/manpages/swat.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="swat.8"> diff --git a/docs/docbook/manpages/tdbbackup.8.xml b/docs/docbook/manpages/tdbbackup.8.xml index c8c5b7e33d..e5f060b101 100644 --- a/docs/docbook/manpages/tdbbackup.8.xml +++ b/docs/docbook/manpages/tdbbackup.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="tdbbackup.8"> diff --git a/docs/docbook/manpages/testparm.1.xml b/docs/docbook/manpages/testparm.1.xml index 085a645a88..84ead17234 100644 --- a/docs/docbook/manpages/testparm.1.xml +++ b/docs/docbook/manpages/testparm.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="testparm.1"> @@ -182,7 +181,7 @@ <para>The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + excellent piece of Open Source software, available at <ulink noescape="1" url="ftp://ftp.icce.rug.nl/pub/unix/"> ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 diff --git a/docs/docbook/manpages/testprns.1.xml b/docs/docbook/manpages/testprns.1.xml index 2afeba22d3..50584f5a18 100644 --- a/docs/docbook/manpages/testprns.1.xml +++ b/docs/docbook/manpages/testprns.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="testprns.1"> @@ -138,7 +137,7 @@ <para>The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + excellent piece of Open Source software, available at <ulink noescape="1" url="ftp://ftp.icce.rug.nl/pub/unix/"> ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 diff --git a/docs/docbook/manpages/vfstest.1.xml b/docs/docbook/manpages/vfstest.1.xml index baf45fb0e4..28b543dd81 100644 --- a/docs/docbook/manpages/vfstest.1.xml +++ b/docs/docbook/manpages/vfstest.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="vfstest.1"> diff --git a/docs/docbook/manpages/wbinfo.1.xml b/docs/docbook/manpages/wbinfo.1.xml index 075ce140cc..728e4f166a 100644 --- a/docs/docbook/manpages/wbinfo.1.xml +++ b/docs/docbook/manpages/wbinfo.1.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="wbinfo.1"> @@ -20,24 +19,31 @@ <refsynopsisdiv> <cmdsynopsis> <command>wbinfo</command> - <arg choice="opt">-u</arg> - <arg choice="opt">-g</arg> - <arg choice="opt">-N netbios-name</arg> + <arg choice="opt">-a user%password</arg> + <arg choice="opt">-c username</arg> + <arg choice="opt">-C groupname</arg> + <arg choice="opt">--domain domain</arg> <arg choice="opt">-I ip</arg> - <arg choice="opt">-n name</arg> <arg choice="opt">-s sid</arg> + <arg choice="opt">-u</arg> <arg choice="opt">-U uid</arg> + <arg choice="opt">-g</arg> + <arg choice="opt">--get-auth-user</arg> <arg choice="opt">-G gid</arg> - <arg choice="opt">-S sid</arg> - <arg choice="opt">-Y sid</arg> - <arg choice="opt">-t</arg> <arg choice="opt">-m</arg> - <arg choice="opt">--sequence</arg> + <arg choice="opt">-n name</arg> + <arg choice="opt">-N netbios-name</arg> + <arg choice="opt">-o user:group</arg> + <arg choice="opt">-O user:group</arg> + <arg choice="opt">-p</arg> <arg choice="opt">-r user</arg> - <arg choice="opt">-a user%password</arg> <arg choice="opt">--set-auth-user user%password</arg> - <arg choice="opt">--get-auth-user</arg> - <arg choice="opt">-p</arg> + <arg choice="opt">--sequence</arg> + <arg choice="opt">-S sid</arg> + <arg choice="opt">-t</arg> + <arg choice="opt">-x username</arg> + <arg choice="opt">-X groupname</arg> + <arg choice="opt">-Y sid</arg> </cmdsynopsis> </refsynopsisdiv> @@ -60,19 +66,37 @@ <refsect1> <title>OPTIONS</title> - <variablelist> + <variablelist> <varlistentry> - <term>-u</term> - <listitem><para>This option will list all users available - in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains - will also be listed. Note that this operation does not assign - user ids to any users that have not already been seen by <citerefentry> - <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> - .</para></listitem> + <term>-a username%password</term> + <listitem><para>Attempt to authenticate a user via winbindd. + This checks both authenticaion methods and reports its results. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-c user</term> + <listitem><para>Create a local winbind user. + </para></listitem> </varlistentry> <varlistentry> + <term>-C group</term> + <listitem><para>Create a local winbindd group. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>--domain name</term> + <listitem><para>This parameter sets the domain on which any specified + operations will performed. If special domain name '.' is used to represent + the current domain to which winbindd belongs. Currently only the + <option>--sequence</option>, + <option>-u</option>, and <option>-g</option> options honor this parameter. + </para></listitem> + </varlistentry> + + <varlistentry> <term>-g</term> <listitem><para>This option will list all groups available in the Windows NT domain for which the <citerefentry><refentrytitle>Samba</refentrytitle> @@ -82,18 +106,22 @@ seen by <citerefentry><refentrytitle>winbindd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>. </para></listitem> </varlistentry> + + <varlistentry> + <term>--get-auth-user</term> + <listitem><para>Print username and password used by winbindd + during session setup to a domain controller. Username + and password can be set using '-A'. Only available for + root.</para></listitem> + </varlistentry> <varlistentry> - <term>-N name</term> - <listitem><para>The <parameter>-N</parameter> option - queries <citerefentry><refentrytitle>winbindd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> to query the WINS - server for the IP address associated with the NetBIOS name - specified by the <parameter>name</parameter> parameter. - </para></listitem> + <term>-G gid</term> + <listitem><para>Try to convert a UNIX group id to a Windows + NT SID. If the gid specified does not refer to one within + the idmap gid range then the operation will fail. </para></listitem> </varlistentry> - - + <varlistentry> <term>-I ip</term> <listitem><para>The <parameter>-I</parameter> option @@ -106,6 +134,16 @@ <varlistentry> + <term>-m</term> + <listitem><para>Produce a list of domains trusted by the + Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> contacts + when resolving names. This list does not include the Windows + NT domain the server is a Primary Domain Controller for. + </para></listitem> + </varlistentry> + + <varlistentry> <term>-n name</term> <listitem><para>The <parameter>-n</parameter> option queries <citerefentry><refentrytitle>winbindd</refentrytitle> @@ -118,9 +156,47 @@ <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup </parameter> parameter. </para></listitem> </varlistentry> + + <varlistentry> + <term>-N name</term> + <listitem><para>The <parameter>-N</parameter> option + queries <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to query the WINS + server for the IP address associated with the NetBIOS name + specified by the <parameter>name</parameter> parameter. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-o user:group</term> + <listitem><para>Add a winbindd local group as a secondary group + for the specified winbindd local user. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-O user:group</term> + <listitem><para>Remove a winbindd local group as a secondary group + for the specified winbindd local user. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-p</term> + <listitem><para>Check whether winbindd is still alive. + Prints out either 'succeeded' or 'failed'. + </para></listitem> + </varlistentry> <varlistentry> + <term>-r username</term> + <listitem><para>Try to obtain the list of UNIX group ids + to which the user belongs. This only works for users + defined on a Domain Controller. + </para></listitem> + </varlistentry> + + <varlistentry> <term>-s sid</term> <listitem><para>Use <parameter>-s</parameter> to resolve a SID to a name. This is the inverse of the <parameter>-n @@ -129,23 +205,22 @@ S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem> </varlistentry> - <varlistentry> - <term>-U uid</term> - <listitem><para>Try to convert a UNIX user id to a Windows NT - SID. If the uid specified does not refer to one within - the winbind uid range then the operation will fail. </para></listitem> + <term>--set-auth-user username%password</term> + <listitem><para>Store username and password used by winbindd + during session setup to a domain controller. This enables + winbindd to operate in a Windows 2000 domain with Restrict + Anonymous turned on (a.k.a. Permissions compatiable with + Windows 2000 servers only). + </para></listitem> </varlistentry> - <varlistentry> - <term>-G gid</term> - <listitem><para>Try to convert a UNIX group id to a Windows - NT SID. If the gid specified does not refer to one within - the winbind gid range then the operation will fail. </para></listitem> + <term>--sequence</term> + <listitem><para>Show sequence numbers of + all known domains</para></listitem> </varlistentry> - <varlistentry> <term>-S sid</term> <listitem><para>Convert a SID to a UNIX user id. If the SID @@ -154,17 +229,6 @@ </citerefentry> then the operation will fail. </para></listitem> </varlistentry> - - <varlistentry> - <term>-Y sid</term> - <listitem><para>Convert a SID to a UNIX group id. If the SID - does not correspond to a UNIX group mapped by <citerefentry> - <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then - the operation will fail. </para></listitem> - </varlistentry> - - - <varlistentry> <term>-t</term> <listitem><para>Verify that the workstation trust account @@ -172,64 +236,44 @@ domain is working. </para></listitem> </varlistentry> - <varlistentry> - <term>-m</term> - <listitem><para>Produce a list of domains trusted by the - Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> contacts - when resolving names. This list does not include the Windows - NT domain the server is a Primary Domain Controller for. - </para></listitem> - </varlistentry> - - <varlistentry> - <term>--sequence</term> - <listitem><para>Show sequence numbers of - all known domains</para></listitem> + <term>-u</term> + <listitem><para>This option will list all users available + in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains + will also be listed. Note that this operation does not assign + user ids to any users that have not already been seen by <citerefentry> + <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> + .</para></listitem> </varlistentry> - + <varlistentry> - <term>-r username</term> - <listitem><para>Try to obtain the list of UNIX group ids - to which the user belongs. This only works for users - defined on a Domain Controller. - </para></listitem> + <term>-U uid</term> + <listitem><para>Try to convert a UNIX user id to a Windows NT + SID. If the uid specified does not refer to one within + the idmap uid range then the operation will fail. </para></listitem> </varlistentry> - - + <varlistentry> - <term>-a username%password</term> - <listitem><para>Attempt to authenticate a user via winbindd. - This checks both authenticaion methods and reports its results. + <term>-x user</term> + <listitem><para>Delete an existing local winbind user. </para></listitem> </varlistentry> - - + <varlistentry> - <term>--set-auth-user username%password</term> - <listitem><para>Store username and password used by winbindd - during session setup to a domain controller. This enables - winbindd to operate in a Windows 2000 domain with Restrict - Anonymous turned on (a.k.a. Permissions compatiable with - Windows 2000 servers only). + <term>-X group</term> + <listitem><para>Delete an existing local winbindd group. </para></listitem> </varlistentry> - + <varlistentry> - <term>--get-auth-user</term> - <listitem><para>Print username and password used by winbindd - during session setup to a domain controller. Username - and password can be set using '-A'. Only available for - root.</para></listitem> + <term>-Y sid</term> + <listitem><para>Convert a SID to a UNIX group id. If the SID + does not correspond to a UNIX group mapped by <citerefentry> + <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then + the operation will fail. </para></listitem> </varlistentry> - <varlistentry> - <term>-p</term> - <listitem><para>Check whether winbindd is still alive. - Prints out either 'succeeded' or 'failed'. - </para></listitem> - </varlistentry> &stdarg.version; &stdarg.help; diff --git a/docs/docbook/manpages/winbindd.8.xml b/docs/docbook/manpages/winbindd.8.xml index d41620b707..b13ec718cf 100644 --- a/docs/docbook/manpages/winbindd.8.xml +++ b/docs/docbook/manpages/winbindd.8.xml @@ -1,8 +1,7 @@ -<?xml version="1.0" encoding="iso8859-1"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> <refentry id="winbindd.8"> @@ -207,24 +206,24 @@ group: files winbind [global] section of smb.conf. </para> <itemizedlist> - <listitem><para><ulink url="smb.conf.5.html#WINBINDSEPARATOR"> - <parameter>winbind separator</parameter></ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#WINBINDUID"> - <parameter>winbind uid</parameter></ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#WINBINDGID"> - <parameter>winbind gid</parameter></ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#WINBINDCACHETIME"> - <parameter>winbind cache time</parameter></ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#WINBINDENUMUSERS"> - <parameter>winbind enum users</parameter></ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#WINBINDENUMGROUPS"> - <parameter>winbind enum groups</parameter></ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#TEMPLATEHOMEDIR"> - <parameter>template homedir</parameter></ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#TEMPLATESHELL"> - <parameter>template shell</parameter></ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#WINBINDUSEDEFAULTDOMAIN"> - <parameter>winbind use default domain</parameter></ulink></para></listitem> + <listitem><para> + <smbconfoption><name>winbind separator</name></smbconfoption></para></listitem> + <listitem><para> + <smbconfoption><name>idmap uid</name></smbconfoption></para></listitem> + <listitem><para> + <smbconfoption><name>idmap gid</name></smbconfoption></para></listitem> + <listitem><para> + <smbconfoption><name>winbind cache time</name></smbconfoption></para></listitem> + <listitem><para> + <smbconfoption><name>winbind enum users</name></smbconfoption></para></listitem> + <listitem><para> + <smbconfoption><name>winbind enum groups</name></smbconfoption></para></listitem> + <listitem><para> + <smbconfoption><name>template homedir</name></smbconfoption></para></listitem> + <listitem><para> + <smbconfoption><name>template shell</name></smbconfoption></para></listitem> + <listitem><para> + <smbconfoption><name>winbind use default domain</name></smbconfoption></para></listitem> </itemizedlist> </refsect1> @@ -287,8 +286,8 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok winbind cache time = 10 template shell = /bin/bash template homedir = /home/%D/%U - winbind uid = 10000-20000 - winbind gid = 10000-20000 + idmap uid = 10000-20000 + idmap gid = 10000-20000 workgroup = DOMAIN security = domain password server = * @@ -350,8 +349,8 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok </varlistentry> <varlistentry> - <term>SIGUSR1</term> - <listitem><para>The SIGUSR1 signal will cause <command> + <term>SIGUSR2</term> + <listitem><para>The SIGUSR2 signal will cause <command> winbindd</command> to write status information to the winbind log file including information about the number of user and group ids allocated by <command>winbindd</command>.</para> diff --git a/docs/docbook/projdoc/AccessControls.xml b/docs/docbook/projdoc/AccessControls.xml index 44780501fe..344e51e5c0 100644 --- a/docs/docbook/projdoc/AccessControls.xml +++ b/docs/docbook/projdoc/AccessControls.xml @@ -2,20 +2,21 @@ <chapterinfo> &author.jht; &author.jeremy; + <author>&person.jelmer;<contrib>drawing</contrib></author> <pubdate>May 10, 2003</pubdate> </chapterinfo> <title>File, Directory and Share Access Controls</title> +<indexterm><primary>ACLs</primary></indexterm> <para> Advanced MS Windows users are frequently perplexed when file, directory and share manipulation of resources shared via Samba do not behave in the manner they might expect. MS Windows network -administrators are often confused regarding network access controls and what is the best way to -provide users with the type of access they need while protecting resources from the consequences -of untoward access capabilities. +administrators are often confused regarding network access controls and how to +provide users with the access they need while protecting resources from unauthorised access. </para> <para> -Unix administrators frequently are not familiar with the MS Windows environment and in particular +Many UNIX administrators are unfamiliar with the MS Windows environment and in particular have difficulty in visualizing what the MS Windows user wishes to achieve in attempts to set file and directory access permissions. </para> @@ -23,12 +24,13 @@ and directory access permissions. <para> The problem lies in the differences in how file and directory permissions and controls work between the two environments. This difference is one that Samba can not completely hide, even -though it does try to make the chasm transparent. +though it does try to bridge the chasm to a degree. </para> +<indexterm><primary>Extended Attributes</primary></indexterm> <para> POSIX Access Control List technology has been available (along with Extended Attributes) -for Unix for many years, yet there is little evidence today of any significant use. This +for UNIX for many years, yet there is little evidence today of any significant use. This explains to some extent the slow adoption of ACLs into commercial Linux products. MS Windows administrators are astounded at this given that ACLs were a foundational capability of the now decade old MS Windows NT operating system. @@ -41,12 +43,11 @@ for delivering the best environment for MS Windows desktop users. </para> <para> -This is an opportune point to mention that it should be borne in mind that Samba was created to -provide a means of interoperability and interchange of data between two operating environments -that are quite different. It was never the intent to make Unix/Linux like MS Windows NT. Instead -the purpose was an is to provide a sufficient level of exchange of data between the two environments. -What is available today extends well beyond early plans and expectations, yet the gap continues to -shrink. +This is an opportune point to mention that Samba was created to provide a means of interoperability +and interchange of data between differing operating environments. Samba has no intent change +UNIX/Linux into a platform like MS Windows. Instead the purpose was and is to provide a sufficient +level of exchange of data between the two environments. What is available today extends well +beyond early plans and expectations, yet the gap continues to shrink. </para> <sect1> @@ -60,17 +61,17 @@ shrink. <itemizedlist> <title>Samba Access Control Facilities</title> <listitem><para> - <emphasis>Unix File and Directory Permissions</emphasis> + <emphasis>UNIX File and Directory Permissions</emphasis> </para> <para> - Samba honours and implements Unix file system access controls. Users + Samba honours and implements UNIX file system access controls. Users who access a Samba server will do so as a particular MS Windows user. This information is passed to the Samba server as part of the logon or connection setup process. Samba uses this user identity to validate whether or not the user should be given access to file system resources (files and directories). This chapter provides an overview for those - to whom the Unix permissions and controls are a little strange or unknown. + to whom the UNIX permissions and controls are a little strange or unknown. </para> </listitem> @@ -102,13 +103,13 @@ shrink. </listitem> <listitem><para> - <emphasis>MS Windows ACLs through Unix POSIX ACLs</emphasis> + <emphasis>MS Windows ACLs through UNIX POSIX ACLs</emphasis> </para> <para> - The use of POSIX ACLs on Unix/Linux is possible ONLY if the underlying + The use of POSIX ACLs on UNIX/Linux is possible ONLY if the underlying operating system supports them. If not, then this option will not be - available to you. Current Unix technology platforms have native support + available to you. Current UNIX technology platforms have native support for POSIX ACLs. There are patches for the Linux kernel that provide this also. Sadly, few Linux platforms ship today with native ACLs and Extended Attributes enabled. This chapter has pertinent information @@ -124,16 +125,18 @@ shrink. <para> Perhaps the most important recognition to be made is the simple fact that MS Windows NT4 / 200x / XP -implement a totally divergent file system technology from what is provided in the Unix operating system +implement a totally divergent file system technology from what is provided in the UNIX operating system environment. Firstly we should consider what the most significant differences are, then we shall look at how Samba helps to bridge the differences. </para> +<indexterm><primary>NTFS</primary></indexterm> +<indexterm><primary>File System</primary></indexterm> <sect2> - <title>MS Windows NTFS Comparison with Unix File Systems</title> + <title>MS Windows NTFS Comparison with UNIX File Systems</title> <para> - Samba operates on top of the Unix file system. This means it is subject to Unix file system conventions + Samba operates on top of the UNIX file system. This means it is subject to UNIX file system conventions and permissions. It also means that if the MS Windows networking environment requires file system behaviour that differs from unix file system behaviour then somehow Samba is responsible for emulating that in a transparent and consistent manner. @@ -152,12 +155,12 @@ at how Samba helps to bridge the differences. <term>Name Space</term> <listitem> <para> - MS Windows NT4 / 200x/ XP files names may be up to 254 characters long, Unix file names + MS Windows NT4 / 200x/ XP files names may be up to 254 characters long, UNIX file names may be 1023 characters long. In MS Windows file extensions indicate particular file types, - in Unix this is not so rigorously observed as all names are considered arbitrary. + in UNIX this is not so rigorously observed as all names are considered arbitrary. </para> <para> - What MS Windows calls a Folder, Unix calls a directory, + What MS Windows calls a Folder, UNIX calls a directory. </para> </listitem> </varlistentry> @@ -166,25 +169,26 @@ at how Samba helps to bridge the differences. <term>Case Sensitivity</term> <listitem> <para> - MS Windows file names are generally Upper Case if made up of 8.3 (ie: 8 character file name + <indexterm><primary>8.3</primary><secondary>file names</secondary></indexterm> + MS Windows file names are generally upper case if made up of 8.3 (ie: 8 character file name and 3 character extension. If longer than 8.3 file names are Case Preserving, and Case Insensitive. </para> <para> - Unix file and directory names are Case Sensitive and Case Preserving. Samba implements the - MS Windows file name behaviour, but it does so as a user application. The Unix file system + UNIX file and directory names are case sensitive and case preserving. Samba implements the + MS Windows file name behaviour, but it does so as a user application. The UNIX file system provides no mechanism to perform case insensitive file name lookups. MS Windows does this by default. This means that Samba has to carry the processing overhead to provide features - that are NOT native to the Unix operating system environment. + that are NOT native to the UNIX operating system environment. </para> <para> - Consider the following, all are unique Unix names but one single MS Windows file name: + Consider the following, all are unique UNIX names but one single MS Windows file name: <computeroutput> MYFILE.TXT MyFile.txt myfile.txt </computeroutput> - So clearly, In an MS Windows file name space these three files CAN NOT co-exist! But in Unix + So clearly, In an MS Windows file name space these three files CAN NOT co-exist! But in UNIX they can. So what should Samba do if all three are present? Answer, the one that is lexically first will be accessible to MS Windows users, the others are invisible and unaccessible - any other solution would be suicidal. @@ -196,7 +200,7 @@ at how Samba helps to bridge the differences. <term>Directory Separators</term> <listitem> <para> - MS Windows and DOS uses the back-slash '\' as a directory delimiter, Unix uses the forward-slash '/' + MS Windows and DOS uses the back-slash '\' as a directory delimiter, UNIX uses the forward-slash '/' as it's directory delimiter. This is transparently handled by Samba. </para> </listitem> @@ -207,9 +211,9 @@ at how Samba helps to bridge the differences. <listitem> <para> MS Windows products support a notion of drive letters, like <command>C:</command> to represent - disk partitions. Unix has NO concept if separate identifiers for file partitions since each + disk partitions. UNIX has NO concept if separate identifiers for file partitions since each such file system is <filename>mounted</filename> to become part of the over-all directory tree. - The Unix directory tree begins at '/', just like the root of a DOS drive is specified like + The UNIX directory tree begins at '/', just like the root of a DOS drive is specified like <command>C:\</command>. </para> </listitem> @@ -219,9 +223,9 @@ at how Samba helps to bridge the differences. <term>File Naming Conventions</term> <listitem> <para> - MS Windows generally never experiences file names that begin with a '.', while in Unix these + MS Windows generally never experiences file names that begin with a '.', while in UNIX these are commonly found in a user's home directory. Files that begin with a '.' are typically - either start up files for various Unix applications, or they may be files that contain + either start up files for various UNIX applications, or they may be files that contain start-up configuration data. </para> </listitem> @@ -231,12 +235,16 @@ at how Samba helps to bridge the differences. <term>Links and Short-Cuts</term> <listitem> <para> + <indexterm><primary>Links</primary><secondary>hard</secondary></indexterm> + <indexterm><primary>Links</primary><secondary>soft</secondary></indexterm> + <indexterm><primary>Short-Cuts</primary></indexterm> + MS Windows make use of "links and Short-Cuts" that are actually special types of files that will - redirect an attempt to execute the file to the real location of the file. Unix knows of file and directory + redirect an attempt to execute the file to the real location of the file. UNIX knows of file and directory links, but they are entirely different from what MS Windows users are used to. </para> <para> - Symbolic links are files in Unix that contain the actual location of the data (file OR directory). An + Symbolic links are files in UNIX that contain the actual location of the data (file OR directory). An operation (like read or write) will operate directly on the file referenced. Symbolic links are also referred to as 'soft links'. A hard link is something that MS Windows is NOT familiar with. It allows one physical file to be known simultaneously by more than one file name. @@ -247,8 +255,8 @@ at how Samba helps to bridge the differences. <para> There are many other subtle differences that may cause the MS Windows administrator some temporary discomfort - in the process of becoming familiar with Unix/Linux. These are best left for a text that is dedicated to the - purpose of Unix/Linux training/education. + in the process of becoming familiar with UNIX/Linux. These are best left for a text that is dedicated to the + purpose of UNIX/Linux training/education. </para> </sect2> @@ -262,7 +270,7 @@ at how Samba helps to bridge the differences. <title>Managing directories with unix and windows</title> <tgroup align="center" cols="3"> <thead> - <row><entry>Action</entry><entry>MS Windows Command</entry><entry>Unix Command</entry></row> + <row><entry>Action</entry><entry>MS Windows Command</entry><entry>UNIX Command</entry></row> </thead> <tbody> @@ -281,67 +289,44 @@ at how Samba helps to bridge the differences. <para> The network administrator is strongly advised to read foundational training manuals and reference materials - regarding file and directory permissions maintenance. Much can be achieved with the basic Unix permissions + regarding file and directory permissions maintenance. Much can be achieved with the basic UNIX permissions without having to resort to more complex facilities like POSIX Access Control Lists (ACLs) or Extended Attributes (EAs). </para> <para> - Unix/Linux file and directory access permissions involves setting three (3) primary sets of data and one (1) control set. - A Unix file listing looks as follows:- - - <screen> - <prompt>jht@frodo:~/stuff> </prompt><userinput>ls -la</userinput> - total 632 - drwxr-xr-x 13 jht users 816 2003-05-12 22:56 . - drwxr-xr-x 37 jht users 3800 2003-05-12 22:29 .. - d--------- 2 jht users 48 2003-05-12 22:29 muchado00 - d--x--x--x 2 jht users 48 2003-05-12 22:29 muchado01 - dr-xr-xr-x 2 jht users 48 2003-05-12 22:29 muchado02 - drwxrwxrwx 2 jht users 48 2003-05-12 22:29 muchado03 - drw-rw-rw- 2 jht users 48 2003-05-12 22:29 muchado04 - d-w--w--w- 2 jht users 48 2003-05-12 22:29 muchado05 - dr--r--r-- 2 jht users 48 2003-05-12 22:29 muchado06 - drwxrwxrwt 2 jht users 48 2003-05-12 22:29 muchado07 - drwsrwsrwx 2 jht users 48 2003-05-12 22:29 muchado08 - ---------- 1 jht users 1242 2003-05-12 22:31 mydata00.lst - ---x--x--x 1 jht users 1674 2003-05-12 22:33 mydata01.lst - --w--w--w- 1 jht users 7754 2003-05-12 22:33 mydata02.lst - --wx-wx-wx 1 jht users 260179 2003-05-12 22:33 mydata03.lst - -r--r--r-- 1 jht users 21017 2003-05-12 22:32 mydata04.lst - -r-xr-xr-x 1 jht users 206339 2003-05-12 22:32 mydata05.lst - -rw-rw-rw- 1 jht users 41105 2003-05-12 22:32 mydata06.lst - -rwxrwxrwx 1 jht users 19312 2003-05-12 22:32 mydata07.lst - <prompt>jht@frodo:~/stuff></prompt> - </screen> + UNIX/Linux file and directory access permissions involves setting three (3) primary sets of data and one (1) control set. + A UNIX file listing looks as follows:- + +<screen> +&prompt;<userinput>ls -la</userinput> +total 632 +drwxr-xr-x 13 maryo gnomes 816 2003-05-12 22:56 . +drwxrwxr-x 37 maryo gnomes 3800 2003-05-12 22:29 .. +dr-xr-xr-x 2 maryo gnomes 48 2003-05-12 22:29 muchado02 +drwxrwxrwx 2 maryo gnomes 48 2003-05-12 22:29 muchado03 +drw-rw-rw- 2 maryo gnomes 48 2003-05-12 22:29 muchado04 +d-w--w--w- 2 maryo gnomes 48 2003-05-12 22:29 muchado05 +dr--r--r-- 2 maryo gnomes 48 2003-05-12 22:29 muchado06 +drwsrwsrwx 2 maryo gnomes 48 2003-05-12 22:29 muchado08 +---------- 1 maryo gnomes 1242 2003-05-12 22:31 mydata00.lst +--w--w--w- 1 maryo gnomes 7754 2003-05-12 22:33 mydata02.lst +-r--r--r-- 1 maryo gnomes 21017 2003-05-12 22:32 mydata04.lst +-rw-rw-rw- 1 maryo gnomes 41105 2003-05-12 22:32 mydata06.lst +&prompt; +</screen> </para> <para> - The columns above represent (from left to right): permissions, no blocks used, owner, group, size (bytes), access date, access time, file name. + The columns above represent (from left to right): permissions, number of hard links to file, owner, group, size (bytes), access date, access time, file name. </para> <para> - The permissions field is made up of: - - <programlisting> - <comment> JRV: Put this into a diagram of some sort</comment> - [ type ] [ users ] [ group ] [ others ] [File, Directory Permissions] - [ d | l ] [ r w x ] [ r w x ] [ r w x ] - | | | | | | | | | | | - | | | | | | | | | | |-----> Can Execute, List files - | | | | | | | | | |-------> Can Write, Create files - | | | | | | | | |---------> Can Read, Read files - | | | | | | | |---------------> Can Execute, List files - | | | | | | |-----------------> Can Write, Create files - | | | | | |-------------------> Can Read, Read files - | | | | |-------------------------> Can Execute, List files - | | | |---------------------------> Can Write, Create files - | | |-----------------------------> Can Read, Read files - | |-----------------------------------> Is a symbolic Link - |---------------------------------------> Is a directory - </programlisting> + An overview of the permissions field can be found in <link linkend="access1">the image below</link>. </para> + <image scale="40"><imagedescription>Overview of unix permissions field</imagedescription><imagefile>access1</imagefile></image> + <para> Any bit flag may be unset. An unset bit flag is the equivalent of 'Can NOT' and is represented as a '-' character. @@ -357,7 +342,7 @@ at how Samba helps to bridge the differences. </para> <para> - Additional possibilities in the [type] field are: c = character device, b = block device, p = pipe device, s = Unix Domain Socket. + Additional possibilities in the [type] field are: c = character device, b = block device, p = pipe device, s = UNIX Domain Socket. </para> <para> @@ -403,10 +388,10 @@ Before using any of the following options please refer to the man page for &smb. <para> User and group based controls can prove very useful. In some situations it is distinctly desirable to affect all - file system operations as if a single user is doing this, the use of the <parameter>force user</parameter> and - <parameter>force group</parameter> behaviour will achieve this. In other situations it may be necessary to affect a + file system operations as if a single user is doing this, the use of the <smbconfoption><name>force user</name></smbconfoption> and + <smbconfoption><name>force group</name></smbconfoption> behaviour will achieve this. In other situations it may be necessary to affect a paranoia level of control to ensure that only particular authorised persons will be able to access a share or - it's contents, here the use of the <parameter>valid users</parameter> or the <parameter>invalid users</parameter> may + it's contents, here the use of the <smbconfoption><name>valid users</name></smbconfoption> or the <smbconfoption><name>invalid users</name></smbconfoption> may be most useful. </para> @@ -417,8 +402,10 @@ Before using any of the following options please refer to the man page for &smb. Samba being removed and an alternative solution being adopted. </para> - <table frame='all'><title>User and Group Based Controls</title> + <table frame='all' pgwide='0'><title>User and Group Based Controls</title> <tgroup cols='2'> + <colspec align="left"/> + <colspec align="justify"/> <thead> <row> <entry align="center">Control Parameter</entry> @@ -427,7 +414,7 @@ Before using any of the following options please refer to the man page for &smb. </thead> <tbody> <row> - <entry>admin users</entry> + <entry><smbconfoption><name>admin users</name></smbconfoption></entry> <entry><para> List of users who will be granted administrative privileges on the share. They will do all file operations as the super-user (root). @@ -436,59 +423,59 @@ Before using any of the following options please refer to the man page for &smb. </para></entry> </row> <row> - <entry>force group</entry> + <entry><smbconfoption><name>force group</name></smbconfoption></entry> <entry><para> Specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service. </para></entry> </row> <row> - <entry>force user</entry> + <entry><smbconfoption><name>force user</name></smbconfoption></entry> <entry><para> Specifies a UNIX user name that will be assigned as the default user for all users connecting to this service. This is useful for sharing files. Incorrect use can cause security problems. </para></entry> </row> <row> - <entry>guest ok</entry> + <entry><smbconfoption><name>guest ok</name></smbconfoption></entry> <entry><para> If this parameter is set for a service, then no password is required to connect to the service. Privileges will be those of the guest account. </para></entry> </row> <row> - <entry>invalid users</entry> + <entry><smbconfoption><name>invalid users</name></smbconfoption></entry> <entry><para> List of users that should not be allowed to login to this service. </para></entry> </row> <row> - <entry>only user</entry> + <entry><smbconfoption><name>only user</name></smbconfoption></entry> <entry><para> Controls whether connections with usernames not in the user list will be allowed. </para></entry> </row> <row> - <entry>read list</entry> + <entry><smbconfoption><name>read list</name></smbconfoption></entry> <entry><para> List of users that are given read-only access to a service. Users in this list will not be given write access, no matter what the read only option is set to. </para></entry> </row> <row> - <entry>username</entry> + <entry><smbconfoption><name>username</name></smbconfoption></entry> <entry><para> Refer to the &smb.conf; man page for more information - this is a complex and potentially misused parameter. </para></entry> </row> <row> - <entry>valid users</entry> + <entry><smbconfoption><name>valid users</name></smbconfoption></entry> <entry><para> List of users that should be allowed to login to this service. </para></entry> </row> <row> - <entry>write list</entry> + <entry><smbconfoption><name>write list</name></smbconfoption></entry> <entry><para> List of users that are given read-write access to a service. </para></entry> @@ -510,7 +497,9 @@ Before using any of the following options please refer to the man page for &smb. </para> <table frame='all'><title>File and Directory Permission Based Controls</title> - <tgroup cols='2'> + <tgroup cols='2'> + <colspec align="left"/> + <colspec align="justify"/> <thead> <row> <entry align="center">Control Parameter</entry> @@ -519,67 +508,67 @@ Before using any of the following options please refer to the man page for &smb. </thead> <tbody> <row> - <entry>create mask</entry> + <entry><smbconfoption><name>create mask</name></smbconfoption></entry> <entry><para> Refer to the &smb.conf; man page. </para></entry> </row> <row> - <entry>directory mask</entry> + <entry><smbconfoption><name>directory mask</name></smbconfoption></entry> <entry><para> The octal modes used when converting DOS modes to UNIX modes when creating UNIX directories. See also: directory security mask. </para></entry></row> <row> - <entry>dos filemode</entry> + <entry><smbconfoption><name>dos filemode</name></smbconfoption></entry> <entry><para> Enabling this parameter allows a user who has write access to the file to modify the permissions on it. </para></entry> </row> <row> - <entry>force create mode</entry> + <entry><smbconfoption><name>force create mode</name></smbconfoption></entry> <entry><para> This parameter specifies a set of UNIX mode bit permissions that will always be set on a file created by Samba. </para></entry> </row> <row> - <entry>force directory mode</entry> + <entry><smbconfoption><name>force directory mode</name></smbconfoption></entry> <entry><para> This parameter specifies a set of UNIX mode bit permissions that will always be set on a directory created by Samba. </para></entry> </row> <row> - <entry>force directory security mode</entry> + <entry><smbconfoption><name>force directory security mode</name></smbconfoption></entry> <entry><para> Controls UNIX permission bits modified when a Windows NT client is manipulating UNIX permissions on a directory </para></entry> </row> <row> - <entry>force security mode</entry> + <entry><smbconfoption><name>force security mode</name></smbconfoption></entry> <entry><para> Controls UNIX permission bits modified when a Windows NT client manipulates UNIX permissions. </para></entry> </row> <row> - <entry>hide unreadable</entry> + <entry><smbconfoption><name>hide unreadable</name></smbconfoption></entry> <entry><para> Prevents clients from seeing the existence of files that cannot be read. </para></entry> </row> <row> - <entry>hide unwriteable files</entry> + <entry><smbconfoption><name>hide unwriteable files</name></smbconfoption></entry> <entry><para> Prevents clients from seeing the existence of files that cannot be written to. Unwriteable directories are shown as usual. </para></entry> </row> <row> - <entry>nt acl support</entry> + <entry><smbconfoption><name>nt acl support</name></smbconfoption></entry> <entry><para> This parameter controls whether smbd will attempt to map UNIX permissions into Windows NT access control lists. </para></entry> </row> <row> - <entry>security mask</entry> + <entry><smbconfoption><name>security mask</name></smbconfoption></entry> <entry><para> Controls UNIX permission bits modified when a Windows NT client is manipulating the UNIX permissions on a file. </para></entry> @@ -594,12 +583,14 @@ Before using any of the following options please refer to the man page for &smb. <title>Miscellaneous Controls</title> <para> - The following are documented because of the prevalence of administrators creating inadvertant barriers to file + The following are documented because of the prevalence of administrators creating inadvertent barriers to file access by not understanding the full implications of &smb.conf; file settings. </para> <table frame='all'><title>Other Controls</title> <tgroup cols='2'> + <colspec align="justify"/> + <colspec align="justify"/> <thead> <row> <entry align="center">Control Parameter</entry> @@ -608,58 +599,58 @@ Before using any of the following options please refer to the man page for &smb. </thead> <tbody> <row> - <entry>case sensitive, default case, short preserve case</entry> + <entry><smbconfoption><name>case sensitive</name></smbconfoption>, <smbconfoption><name>default case</name></smbconfoption>, <smbconfoption><name>short preserve case</name></smbconfoption></entry> <entry><para> This means that all file name lookup will be done in a case sensitive manner. Files will be created with the precise filename Samba received from the MS Windows client. </para></entry> </row> <row> - <entry>csc policy</entry> + <entry><smbconfoption><name>csc policy</name></smbconfoption></entry> <entry><para> Client Side Caching Policy - parallels MS Windows client side file caching capabilities. </para></entry> </row> <row> - <entry>dont descend</entry> + <entry><smbconfoption><name>dont descend</name></smbconfoption></entry> <entry><para> Allows to specify a comma-delimited list of directories that the server should always show as empty. </para></entry> </row> <row> - <entry>dos filetime resolution</entry> + <entry><smbconfoption><name>dos filetime resolution</name></smbconfoption></entry> <entry><para> This option is mainly used as a compatibility option for Visual C++ when used against Samba shares. </para></entry> </row> <row> - <entry>dos filetimes</entry> + <entry><smbconfoption><name>dos filetimes</name></smbconfoption></entry> <entry><para> DOS and Windows allows users to change file time stamps if they can write to the file. POSIX semantics prevent this. This options allows DOS and Windows behaviour. </para></entry> </row> <row> - <entry>fake oplocks</entry> + <entry><smbconfoption><name>fake oplocks</name></smbconfoption></entry> <entry><para> Oplocks are the way that SMB clients get permission from a server to locally cache file operations. If a server grants an oplock then the client is free to assume that it is the only one accessing the file and it will aggressively cache file data. </para></entry> </row> <row> - <entry>hide dot files, hide files, veto files</entry> + <entry><smbconfoption><name>hide dot files</name></smbconfoption>, <smbconfoption><name>hide files</name></smbconfoption>, <smbconfoption><name>veto files</name></smbconfoption></entry> <entry><para> Note: MS Windows Explorer allows over-ride of files marked as hidden so they will still be visible. </para></entry> </row> <row> - <entry>read only</entry> + <entry><smbconfoption><name>read only</name></smbconfoption></entry> <entry><para> If this parameter is yes, then users of a service may not create or modify files in the service's directory. </para></entry> </row> <row> - <entry>veto files</entry> + <entry><smbconfoption><name>veto files</name></smbconfoption></entry> <entry><para> List of files and directories that are neither visible nor accessible. </para></entry> @@ -733,7 +724,7 @@ Before using any of the following options please refer to the man page for &smb. <para> On <application>MS Windows NT4/200x/XP</application> system access control lists on the share itself are set using native - tools, usually from filemanager. For example, in Windows 200x: right click on the shared folder, + tools, usually from file manager. For example, in Windows 200x: right click on the shared folder, then select <guimenuitem>Sharing</guimenuitem>, then click on <guilabel>Permissions</guilabel>. The default Windows NT4/200x permission allows <emphasis>Everyone</emphasis> Full Control on the Share. </para> @@ -783,26 +774,31 @@ Before using any of the following options please refer to the man page for &smb. </sect1> <sect1> -<title>MS Windows Access Control Lists and Unix Interoperability</title> +<title>MS Windows Access Control Lists and UNIX Interoperability</title> <sect2> <title>Managing UNIX permissions Using NT Security Dialogs</title> - <para>Windows NT clients can use their native security settings - dialog box to view and modify the underlying UNIX permissions.</para> + <para> + Windows NT clients can use their native security settings dialog box to view and modify the + underlying UNIX permissions. + </para> - <para>Note that this ability is careful not to compromise - the security of the UNIX host Samba is running on, and - still obeys all the file permission rules that a Samba - administrator can set.</para> + <para> + Note that this ability is careful not to compromise the security of the UNIX host Samba is running on, and + still obeys all the file permission rules that a Samba administrator can set. + </para> + + <para> + Samba does not attempt to go beyond POSIX ACLs, so that the various finer-grained access control + options provided in Windows are actually ignore. + </para> <note> <para> - All access to Unix/Linux system file via Samba is controlled at - the operating system file access control level. When trying to - figure out file access problems it is vitally important to identify - the identity of the Windows user as it is presented by Samba at - the point of file access. This can best be determined from the + All access to UNIX/Linux system files via Samba is controlled by the operating system file access controls. + When trying to figure out file access problems it is vitally important to find the identity of the Windows + user as it is presented by Samba at the point of file access. This can best be determined from the Samba log files. </para> </note> @@ -811,93 +807,89 @@ Before using any of the following options please refer to the man page for &smb. <sect2> <title>Viewing File Security on a Samba Share</title> - <para>From an NT4/2000/XP client, single-click with the right - mouse button on any file or directory in a Samba mounted - drive letter or UNC path. When the menu pops-up, click - on the <guilabel>Properties</guilabel> entry at the bottom of - the menu. This brings up the file properties dialog - box. Click on the tab <guilabel>Security</guilabel> and you - will see three buttons, <guibutton>Permissions</guibutton>, - <guibutton>Auditing</guibutton>, and <guibutton>Ownership</guibutton>. - The <guibutton>Auditing</guibutton> button will cause either - an error message <errorname>A requested privilege is not held - by the client</errorname> to appear if the user is not the - NT Administrator, or a dialog which is intended to allow an - Administrator to add auditing requirements to a file if the - user is logged on as the NT Administrator. This dialog is - non-functional with a Samba share at this time, as the only - useful button, the <guibutton>Add</guibutton> button will not currently - allow a list of users to be seen.</para> + <para> + From an NT4/2000/XP client, single-click with the right mouse button on any file or directory in a Samba + mounted drive letter or UNC path. When the menu pops-up, click on the <guilabel>Properties</guilabel> + entry at the bottom of the menu. This brings up the file properties dialog box. Click on the tab + <guilabel>Security</guilabel> and you will see three buttons, <guibutton>Permissions</guibutton>, + <guibutton>Auditing</guibutton>, and <guibutton>Ownership</guibutton>. The <guibutton>Auditing</guibutton> + button will cause either an error message <errorname>A requested privilege is not held by the client</errorname> + to appear if the user is not the NT Administrator, or a dialog which is intended to allow an Administrator + to add auditing requirements to a file if the user is logged on as the NT Administrator. This dialog is + non-functional with a Samba share at this time, as the only useful button, the <guibutton>Add</guibutton> + button will not currently allow a list of users to be seen. + </para> </sect2> <sect2> <title>Viewing file ownership</title> - <para>Clicking on the <guibutton>Ownership</guibutton> button - brings up a dialog box telling you who owns the given file. The - owner name will be of the form :</para> - - <para><command>"SERVER\user (Long name)"</command></para> - - <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 descriptive string identifying the user (normally found in the - GECOS field of the UNIX password database). Click on the - <guibutton>Close </guibutton> button to remove this dialog.</para> - - <para>If the parameter <parameter>nt acl support</parameter> - is set to <constant>false</constant> then the file owner will - be shown as the NT user <constant>"Everyone"</constant>.</para> - - <para>The <guibutton>Take Ownership</guibutton> button will not allow - 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 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 privilege connected - to a Samba 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 <application>Seclib - </application> NT security library written by Jeremy Allison of - the Samba Team, available from the main Samba ftp site.</para> + <para> + Clicking on the <guibutton>Ownership</guibutton> button brings up a dialog box telling you who owns + the given file. The owner name will be of the form: + </para> + + <para> + <command>"SERVER\user (Long name)"</command> + </para> + + <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 + descriptive string identifying the user (normally found in the GECOS field of the UNIX password database). + Click on the <guibutton>Close </guibutton> button to remove this dialog. + </para> + + <para> + If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> is set to <constant>false</constant> + then the file owner will be shown as the NT user <constant>"Everyone"</constant>. + </para> + + <para> + The <guibutton>Take Ownership</guibutton> button will not allow 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 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 privilege connected + to a Samba 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 <application>Seclib</application> NT security library written + by Jeremy Allison of the Samba-Team, available from the main Samba FTP site.</para> </sect2> <sect2> <title>Viewing File or Directory Permissions</title> - <para>The third button is the <guibutton>Permissions</guibutton> - button. Clicking on this brings up a dialog box that shows both - the permissions and the UNIX owner of the file or directory. - The owner is displayed in the form :</para> + <para> + The third button is the <guibutton>Permissions</guibutton> button. Clicking on this brings up a dialog box + that shows both the permissions and the UNIX owner of the file or directory. The owner is displayed in the form: + </para> <para><command>"<replaceable>SERVER</replaceable>\ <replaceable>user</replaceable> <replaceable>(Long name)</replaceable>"</command></para> - <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 descriptive string identifying the user (normally found in the + <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 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> - is set to <constant>false</constant> then the file owner will - be shown as the NT user <constant>"Everyone"</constant> and the - permissions will be shown as NT "Full Control".</para> + <para> + If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> is set to <constant>false</constant> + then the file owner will be shown as the NT user <constant>"Everyone"</constant> and the permissions will be + shown as NT "Full Control". + </para> - <para>The permissions field is displayed differently for files - and directories, so I'll describe the way file permissions - are displayed first.</para> + <para> + The permissions field is displayed differently for files and directories, so I'll describe the way file permissions + are displayed first. + </para> <sect3> <title>File Permissions</title> @@ -921,7 +913,7 @@ Before using any of the following options please refer to the man page for &smb. "Special Access"</constant> in the NT display list.</para> <para>But what happens if the file has no permissions allowed - for a particular UNIX user group or world component ? In order + for a particular UNIX user group or world component? In order to allow "no permissions" to be seen and modified then Samba overloads the NT <command>"Take Ownership"</command> ACL attribute (which has no meaning in UNIX) and reports a component with @@ -963,7 +955,7 @@ Before using any of the following options please refer to the man page for &smb. with the standard Samba permission masks and mapping of DOS attributes that need to also be taken into account.</para> - <para>If the parameter <parameter>nt acl support</parameter> + <para>If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> is set to <constant>false</constant> then any attempt to set security permissions will fail with an <errorname>"Access Denied" </errorname> message.</para> @@ -1013,37 +1005,36 @@ Before using any of the following options please refer to the man page for &smb. to control interaction with the standard Samba create mask parameters. These are : - <simplelist> - <member><parameter>security mask</parameter></member> - <member><parameter>force security mode</parameter></member> - <member><parameter>directory security mask</parameter></member> - <member><parameter>force directory security mode</parameter></member> - </simplelist> + <itemizedlist> + <listitem><para><smbconfoption><name>security mask</name></smbconfoption></para></listitem> + <listitem><para><smbconfoption><name>force security mode</name></smbconfoption></para></listitem> + <listitem><para><smbconfoption><name>directory security mask</name></smbconfoption></para></listitem> + <listitem><para><smbconfoption><name>force directory security mode</name></smbconfoption></para></listitem> + </itemizedlist> </para> <para>Once a user clicks <guibutton>OK</guibutton> to apply the permissions Samba maps the given permissions into a user/group/world r/w/x triplet set, and then will check the changed permissions for a - file against the bits set in the <ulink url="smb.conf.5.html#SECURITYMASK"> - <parameter>security mask</parameter></ulink> parameter. Any bits that + file against the bits set in the + <smbconfoption><name>security mask</name></smbconfoption> parameter. Any bits that were changed that are not set to '1' in this parameter are left alone in the file permissions.</para> - <para>Essentially, zero bits in the <parameter>security mask</parameter> + <para>Essentially, zero bits in the <smbconfoption><name>security mask</name></smbconfoption> mask may be treated as a set of bits the user is <emphasis>not</emphasis> allowed to change, and one bits are those the user is allowed to change. </para> <para>If not set explicitly this parameter is set to the same value as - the <ulink url="smb.conf.5.html#CREATEMASK"><parameter>create mask - </parameter></ulink> parameter. To allow a user to modify all the + the <smbconfoption><name>create mask</name></smbconfoption> parameter. To allow a user to modify all the user/group/world permissions on a file, set this parameter to 0777.</para> <para>Next Samba checks the changed permissions for a file against - the bits set in the <ulink url="smb.conf.5.html#FORCESECURITYMODE"> - <parameter>force security mode</parameter></ulink> parameter. Any bits + the bits set in the + <smbconfoption><name>force security mode</name></smbconfoption> parameter. Any bits that were changed that correspond to bits set to '1' in this parameter are forced to be set.</para> @@ -1052,12 +1043,11 @@ Before using any of the following options please refer to the man page for &smb. modifying security on a file, the user has always set to be 'on'.</para> <para>If not set explicitly this parameter is set to the same value - as the <ulink url="smb.conf.5.html#FORCECREATEMODE"><parameter>force - create mode</parameter></ulink> parameter. + as the <smbconfoption><name>force create mode</name></smbconfoption> parameter. 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 + <para>The <smbconfoption><name>security mask</name></smbconfoption> and <parameter>force security mode</parameter> parameters are applied to the change request in that order.</para> @@ -1068,11 +1058,11 @@ Before using any of the following options please refer to the man page for &smb. </parameter> parameter instead of <parameter>force security mode </parameter>.</para> - <para>The <parameter>directory security mask</parameter> parameter + <para>The <smbconfoption><name>directory security mask</name></smbconfoption> parameter by default is set to the same value as the <parameter>directory mask </parameter> parameter and the <parameter>force directory security mode</parameter> parameter by default is set to the same value as - the <parameter>force directory mode</parameter> parameter. </para> + the <smbconfoption><name>force directory mode</name></smbconfoption> parameter. </para> <para>In this way Samba enforces the permission restrictions that an administrator can set on a Samba share, whilst still allowing users @@ -1084,23 +1074,24 @@ Before using any of the following options please refer to the man page for &smb. parameters in the &smb.conf; file in that share specific section : </para> - <simplelist> - <member><parameter>security mask = 0777</parameter></member> - <member><parameter>force security mode = 0</parameter></member> - <member><parameter>directory security mask = 0777</parameter></member> - <member><parameter>force directory security mode = 0</parameter></member> - </simplelist> + <smbconfblock> + <smbconfoption><name>security mask</name><value>0777</value></smbconfoption> + <smbconfoption><name>force security mode</name><value>0</value></smbconfoption> + <smbconfoption><name>directory security mask</name><value>0777</value></smbconfoption> + <smbconfoption><name>force directory security mode</name><value>0</value></smbconfoption> + </smbconfblock> </sect2> <sect2> - <title>Interaction with the standard Samba file attribute - mapping</title> + <title>Interaction with the standard Samba file attribute mapping</title> + <note> <para>Samba maps some of the DOS attribute bits (such as "read only") into the UNIX permissions of a file. This means there can be a conflict between the permission bits set via the security dialog and the permission bits set by the file attribute mapping. </para> + </note> <para>One way this can show up is if a file has no UNIX read access for the owner it will show up as "read only" in the standard @@ -1146,7 +1137,6 @@ are examples taken from the mailing list in recent times. </para> <procedure> - <title>Example Solution:</title> <step> <para> Go to the top of the directory that is shared @@ -1156,17 +1146,17 @@ are examples taken from the mailing list in recent times. <step> <para> Set the ownership to what ever public owner and group you want - <programlisting> - find 'directory_name' -type d -exec chown user.group {}\; - find 'directory_name' -type d -exec chmod 6775 'directory_name' - find 'directory_name' -type f -exec chmod 0775 {} \; - find 'directory_name' -type f -exec chown user.group {}\; - </programlisting> +<screen> +&prompt;find 'directory_name' -type d -exec chown user.group {}\; +&prompt;find 'directory_name' -type d -exec chmod 6775 'directory_name' +&prompt;find 'directory_name' -type f -exec chmod 0775 {} \; +&prompt;find 'directory_name' -type f -exec chown user.group {}\; +</screen> </para> <note><para> The above will set the 'sticky bit' on all directories. Read your - Unix/Linux man page on what that does. It causes the OS to assign + UNIX/Linux man page on what that does. It causes the OS to assign to all files created in the directories the ownership of the directory. </para></note> @@ -1175,62 +1165,62 @@ are examples taken from the mailing list in recent times. <para> Directory is: <replaceable>/foodbar</replaceable> - <screen> - <prompt>$ </prompt><userinput>chown jack.engr /foodbar</userinput> - </screen> +<screen> +&prompt;<userinput>chown jack.engr /foodbar</userinput> +</screen> </para> - <note><para> + <note> <para>This is the same as doing:</para> - <screen> - <prompt>$ </prompt><userinput>chown jack /foodbar</userinput> - <prompt>$ </prompt><userinput>chgrp engr /foodbar</userinput> - </screen> - </para></note> +<screen> +&prompt;<userinput>chown jack /foodbar</userinput> +&prompt;<userinput>chgrp engr /foodbar</userinput> +</screen> + </note> </step> <step> <para>Now do: - <screen> - <prompt>$ </prompt><userinput>chmod 6775 /foodbar</userinput> - <prompt>$ </prompt><userinput>ls -al /foodbar/..</userinput> - </screen> +<screen> +&prompt;<userinput>chmod 6775 /foodbar</userinput> +&prompt;<userinput>ls -al /foodbar/..</userinput> +</screen> </para> <para>You should see: - <screen> - drwsrwsr-x 2 jack engr 48 2003-02-04 09:55 foodbar - </screen> +<screen> +drwsrwsr-x 2 jack engr 48 2003-02-04 09:55 foodbar +</screen> </para> </step> <step> <para>Now do: - <screen> - <prompt>$ </prompt><userinput>su - jill</userinput> - <prompt>$ </prompt><userinput>cd /foodbar</userinput> - <prompt>$ </prompt><userinput>touch Afile</userinput> - <prompt>$ </prompt><userinput>ls -al</userinput> - </screen> +<screen> +&prompt;<userinput>su - jill</userinput> +&prompt;<userinput>cd /foodbar</userinput> +&prompt;<userinput>touch Afile</userinput> +&prompt;<userinput>ls -al</userinput> +</screen> </para> <para> You should see that the file <filename>Afile</filename> created by Jill will have ownership and permissions of Jack, as follows: - <screen> - -rw-r--r-- 1 jack engr 0 2003-02-04 09:57 Afile - </screen> +<screen> +-rw-r--r-- 1 jack engr 0 2003-02-04 09:57 Afile +</screen> </para> </step> <step> <para> Now in your &smb.conf; for the share add: - <programlisting> - force create mode = 0775 - force directory mode = 6775 - </programlisting> + <smbconfblock> +<smbconfoption><name>force create mode</name><value>0775</value></smbconfoption> +<smbconfoption><name>force direcrtory mode</name><value>6775</value></smbconfoption> + </smbconfblock> </para> <note><para> @@ -1241,10 +1231,10 @@ are examples taken from the mailing list in recent times. <para> An alternative is to set in the &smb.conf; entry for the share: - <programlisting> - force user = jack - force group = engr - </programlisting> + <smbconfblock> +<smbconfoption><name>force user</name><value>jack</value></smbconfoption> +<smbconfoption><name>force group</name><value>engr</value></smbconfoption> + </smbconfblock> </para> </step> </procedure> @@ -1252,14 +1242,49 @@ are examples taken from the mailing list in recent times. <sect2> - <title>I have set force user and Samba still makes <emphasis>root</emphasis> the owner of all the files - I touch!</title> + <title>I have set force user but Samba still makes <emphasis>root</emphasis> the owner of all the files I touch!</title> <para> - When you have a user in 'admin users', Samba will always do file operations for - this user as <emphasis>root</emphasis>, even if <parameter>force user</parameter> has been set. + When you have a user in <smbconfoption><name>admin users</name></smbconfoption>, samba will always do file operations for + this user as <emphasis>root</emphasis>, even if <smbconfoption><name>force user</name></smbconfoption> has been set. </para> </sect2> + <sect2> + <title>MS Word with Samba changes owner of file</title> + + <para> + <emphasis>Question:</emphasis> <quote>When userB saves a word document that is owned by userA the updated file is now owned by userB. + Why is Samba doing this? How do I fix this?</quote> + </para> + + <para> + <emphasis>Answer:</emphasis> Word does the following when you modify/change a Word document: Word Creates a NEW document with + a temporary name, Word then closes the old document and deletes it, Word then renames the new document to the original document name. + There is NO mechanism by which Samba CAN IN ANY WAY know that the new document really should be owned by the owners + of the original file. Samba has no way of knowing that the file will be renamed by MS Word. As far as Samba is able + to tell, the file that gets created is a NEW file, not one that the application (Word) is updating. + </para> + + <para> + There is a work-around to solve the permissions problem. That work-around involves understanding how you can manage file + system behaviour from within the &smb.conf; file, as well as understanding how Unix file systems work. Set on the directory + in which you are changing word documents: <command>chmod g+s 'directory_name'</command> This ensures that all files will + be created with the group that owns the directory. In smb.conf share declaration section set: + </para> + + <para> + <smbconfblock> + <smbconfoption><name>force create mode</name><value>0660</value></smbconfoption> + <smbconfoption><name>force directory mode</name><value>0770</value></smbconfoption> + </smbconfblock> + </para> + + <para> + These two settings will ensure that all directories and files that get created in the share will be read/writable by the + owner and group set on the directory itself. + </para> + + </sect2> </sect1> diff --git a/docs/docbook/projdoc/Backup.xml b/docs/docbook/projdoc/Backup.xml index b3c37aba53..bf391c5c6d 100644 --- a/docs/docbook/projdoc/Backup.xml +++ b/docs/docbook/projdoc/Backup.xml @@ -11,8 +11,6 @@ <para> This chapter did not make it into this release. It is planned for the published release of this document. -If you have something to contribute for this section please email it to -<link url="mail://jht@samba.org">jht@samba.org</link>/ </para> </sect1> diff --git a/docs/docbook/projdoc/Bugs.xml b/docs/docbook/projdoc/Bugs.xml index b2b8d5c67e..0688e23cf3 100644 --- a/docs/docbook/projdoc/Bugs.xml +++ b/docs/docbook/projdoc/Bugs.xml @@ -2,7 +2,7 @@ <chapterinfo> &author.jelmer; - <author><surname>Someone; Tridge or Karl Auer perhaps?</surname></author> + &author.tridge; <!-- This is mostly a guess --> <pubdate> 27 June 1997 </pubdate> </chapterinfo> @@ -40,7 +40,7 @@ that list that may be able to help you. <para> You may also like to look though the recent mailing list archives, which are conveniently accessible on the Samba web pages -at <ulink url="http://samba.org/samba/">http://samba.org/samba/</ulink>. +at <ulink noescape="1" url="http://samba.org/samba/">http://samba.org/samba/</ulink>. </para> </sect1> @@ -80,37 +80,37 @@ detail, but may use too much disk space. </para> <para> -To set the debug level use the <parameter>log level</parameter> in your +To set the debug level use the <smbconfoption><name>log level</name></smbconfoption> in your &smb.conf;. You may also find it useful to set the log level higher for just one machine and keep separate logs for each machine. -To do this use: +To do this add the following lines to your main &smb.conf; file: </para> -<para><programlisting> -log level = 10 -log file = /usr/local/samba/lib/log.%m -include = /usr/local/samba/lib/smb.conf.%m -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>log level</name><value>10</value></smbconfoption> +<smbconfoption><name>log file</name><value>/usr/local/samba/lib/log.%m</value></smbconfoption> +<smbconfoption><name>include</name><value>/usr/local/samba/lib/smb.conf.%m</value></smbconfoption> +</smbconfblock></para> <para> then create a file <filename>/usr/local/samba/lib/smb.conf.<replaceable>machine</replaceable></filename> where <replaceable>machine</replaceable> is the name of the client you wish to debug. In that file put any &smb.conf; commands you want, for example -<parameter>log level</parameter> may be useful. This also allows you to +<smbconfoption><name>log level</name></smbconfoption> may be useful. This also allows you to experiment with different security systems, protocol levels etc on just one machine. </para> <para> -The &smb.conf; entry <parameter>log level</parameter> -is synonymous with the parameter <parameter>debuglevel</parameter> that has +The &smb.conf; entry <smbconfoption><name>log level</name></smbconfoption> +is synonymous with the parameter <smbconfoption><name>debuglevel</name></smbconfoption> that has been used in older versions of Samba and is being retained for backwards compatibility of &smb.conf; files. </para> <para> -As the <parameter>log level</parameter> value is increased you will record +As the <smbconfoption><name>log level</name></smbconfoption> value is increased you will record a significantly increasing level of debugging information. For most debugging operations you may not need a setting higher than <constant>3</constant>. Nearly @@ -142,6 +142,8 @@ You should also detail how to reproduce the problem, if possible. Please make this reasonably detailed. </para> +<indexterm><primary>core files</primary></indexterm> + <para> You may also find that a core file appeared in a <filename>corefiles</filename> subdirectory of the directory where you keep your samba log @@ -149,8 +151,11 @@ files. This file is the most useful tool for tracking down the bug. To use it you do this: </para> +<indexterm><primary>gdb</primary></indexterm> +<indexterm><primary>debug</primary></indexterm> + <screen> - <prompt>$ </prompt><userinput>gdb smbd core</userinput> +&prompt;<userinput>gdb smbd core</userinput> </screen> <para> @@ -191,6 +196,9 @@ where it occurred. <sect1> <title>Patches</title> +<indexterm><primary>diff</primary></indexterm> +<indexterm><primary>patch</primary></indexterm> + <para> The best sort of bug report is one that includes a fix! If you send us patches please use <userinput>diff -u</userinput> format if your version of diff --git a/docs/docbook/projdoc/CUPS-printing.xml b/docs/docbook/projdoc/CUPS-printing.xml index 252da6f4ef..945092d413 100644 --- a/docs/docbook/projdoc/CUPS-printing.xml +++ b/docs/docbook/projdoc/CUPS-printing.xml @@ -5,7 +5,7 @@ <author> <firstname>Kurt</firstname><surname>Pfeifle</surname> <affiliation> - <orgname> Danka Deutschland GmbH </orgname> + <orgname>Danka Deutschland GmbH </orgname> <address><email>kpfeifle@danka.de</email></address> </affiliation> </author> @@ -17,6 +17,8 @@ <contrib>drawings</contrib> </author> + <author>&person.jelmer;<contrib>drawings</contrib></author> + <pubdate> (3 June 2003) </pubdate> </chapterinfo> @@ -30,20 +32,15 @@ <title>Features and Benefits</title> <para> - The Common Unix Print System (<ulink - url="http://www.cups.org/">CUPS</ulink>) has become very popular. All - big Linux distributions now ship it as their default printing - system. But to many it is still a very mystical tool. Normally it - "just works" (TM). People tend to regard it as a sort of "black box", - which they don't want to look into, as long as it works OK. But once + The Common UNIX Print System (<ulink + url="http://www.cups.org/">CUPS</ulink>) has become very popular. All + major Linux distributions now ship it as their default printing + system. To many it is still a very mystical tool. Mostly, it + "just works" (TM). People tend to regard it as a "black box" + which they don't want to look into, as long as it works. But once there is a little problem, they are in trouble to find out where to - start debugging it. Also, even the most recent and otherwise excellent - printed Samba documentation has only limited attention paid to CUPS - printing, leaving out important pieces or even writing plain wrong - things about it. This demands rectification. But before you dive into - this chapter, make sure that you don't forget to refer to the - "Classical Printing" chapter also. It contains a lot of information - that is relevant for CUPS too. + start debugging it. Refer to the "Classical Printing" chapter also, it + contains a lot of information that is relevant for CUPS. </para> <para> @@ -51,12 +48,10 @@ basic functions may be grasped quite easily, they are also new. Because they are different from other, more traditional printing systems, it is best to try and not apply any prior knowledge about - printing upon this new system. Rather try to start understand CUPS - from the beginning. This documentation will lead you here to a - complete understanding of CUPS, if you study all of the material - contained. But lets start with the most basic things first. Maybe this - is all you need for now. Then you can skip most of the other - paragraphs. + printing upon this new system. Rather, try to understand CUPS + from the beginning. This documentation will lead you to a + complete understanding of CUPS. Let's start with the most basic + things first. </para> </sect2> @@ -71,11 +66,10 @@ and IETF (<emphasis>Internet Engineering Task Force</emphasis>) standard for network printing. Many of its functions can be managed remotely (or locally) via a web browser (giving you a - platform-independent access to the CUPS print server). In addition it - has the traditional commandline and several more modern GUI interfaces + platform-independent access to the CUPS print server). Additionally, it + has the traditional command line and several more modern GUI interfaces (GUI interfaces developed by 3rd parties, like KDE's - overwhelming <ulink - url="http://printing.kde.org/">KDEPrint</ulink>). + overwhelming <ulink url="http://printing.kde.org/">KDEPrint</ulink>). </para> <para> @@ -95,31 +89,24 @@ <title>Basic Configuration of CUPS support</title> <para> - Printing with CUPS in the most basic <filename>smb.conf</filename> - setup in Samba 3.0 (as was true for 2.2.x) only needs two - settings: <parameter>printing = cups</parameter> and <parameter>printcap - = cups</parameter>. CUPS itself doesn't need a printcap file - anymore. However, the <filename>cupsd.conf</filename> configuration - file knows two related directives: they control if such a file should - be automatically created and maintained by CUPS for the convenience of - third party applications (example: <parameter>Printcap - /etc/printcap</parameter> and <parameter>PrintcapFormat - BSD</parameter>). These legacy programs often require the existence of - printcap file containing printernames or they will refuse to - print. Make sure CUPS is set to generate and maintain a printcap! For - details see <command>man cupsd.conf</command> and other CUPS-related - documentation, like the wealth of documents on your CUPS server - itself: <ulink - url="http://localhost:631/documentation.html">http://localhost:631/documentation.html</ulink>. + Printing with CUPS in the most basic &smb.conf; setup in Samba 3.0 (as was true for 2.2.x) only needs two + settings: <smbconfoption><name>printing</name><value>cups</value></smbconfoption> and + <smbconfoption><name>printcap</name><value>cups</value></smbconfoption>. CUPS does not need a printcap file. + However, the <filename>cupsd.conf</filename> configuration file knows of two related directives that control + how such a file will be automatically created and maintained by CUPS for the convenience of third party + applications (example: <parameter>Printcap /etc/printcap</parameter> and <parameter>PrintcapFormat BSD</parameter>). + Legacy programs often require the existence of a printcap file containing printer names or they will refuse to + print. Make sure CUPS is set to generate and maintain a printcap file! For details see + <command>man cupsd.conf</command> and other CUPS-related documentation, like the wealth of documents on your CUPS server + itself: <ulink noescape="1" url="http://localhost:631/documentation.html">http://localhost:631/documentation.html</ulink>. </para> <sect2> <title>Linking of smbd with libcups.so</title> <para> - Samba has a very special relationship to CUPS. The reason is: Samba - can be compiled with CUPS library support. Most recent installations - have this support enabled, and per default CUPS linking is compiled + Samba has a very special relationship to CUPS. Samba can be compiled with CUPS library support. + Most recent installations have this support enabled. Per default CUPS linking is compiled into smbd and other Samba binaries. Of course, you can use CUPS even if Samba is not linked against <filename>libcups.so</filename> -- but there are some differences in required or supported configuration @@ -127,69 +114,65 @@ </para> <para> - If SAMBA is compiled against libcups, then <parameter>printcap = - cups</parameter> uses the CUPS API to list printers, submit jobs, - query queues, etc. Otherwise it maps to the System V commands with an - additional <command>-oraw</command> option for printing. On a Linux - system, you can use the <command>ldd</command> utility to find out - details (ldd may not be present on other OS platforms, or its function - may be embodied by a different command): + When Samba is compiled against libcups, <smbconfoption><name>printcap</name><value>cups</value></smbconfoption> + uses the CUPS API to list printers, submit jobs, query queues, etc. Otherwise it maps to the System V + commands with an additional <command>-oraw</command> option for printing. On a Linux + system, you can use the <command>ldd</command> utility to find out details (ldd may not be present on + other OS platforms, or its function may be embodied by a different command): </para> - <para><screen> - transmeta:/home/kurt # ldd `which smbd` - libssl.so.0.9.6 => /usr/lib/libssl.so.0.9.6 (0x4002d000) - libcrypto.so.0.9.6 => /usr/lib/libcrypto.so.0.9.6 (0x4005a000) - libcups.so.2 => /usr/lib/libcups.so.2 (0x40123000) - [....] - </screen></para> +<para><screen> +&rootprompt;<userinput>ldd `which smbd`</userinput> +libssl.so.0.9.6 => /usr/lib/libssl.so.0.9.6 (0x4002d000) +libcrypto.so.0.9.6 => /usr/lib/libcrypto.so.0.9.6 (0x4005a000) +libcups.so.2 => /usr/lib/libcups.so.2 (0x40123000) +[....] +</screen></para> <para> - The line <computeroutput>libcups.so.2 => /usr/lib/libcups.so.2 - (0x40123000)</computeroutput> shows there is CUPS support compiled - into this version of Samba. If this is the case, and printing = cups - is set, then <emphasis>any otherwise manually set print command in - <filename>smb.conf</filename> is ignored</emphasis>. This is an - important point to remember! + The line <computeroutput>libcups.so.2 => /usr/lib/libcups.so.2 (0x40123000)</computeroutput> shows + there is CUPS support compiled into this version of Samba. If this is the case, and printing = cups + is set, then <emphasis>any otherwise manually set print command in &smb.conf; is ignored</emphasis>. + This is an important point to remember! </para> - <tip><para> Should you require -- for any reason -- to set your own - print commands, you can still do this by setting <parameter>printing = - sysv</parameter>. However, you'll loose all the benefits from the - close CUPS/Samba integration. You are on your own then to manually - configure the rest of the printing system commands (most important: - <parameter>print command</parameter>; other commands are - <parameter>lppause command, lpresume command, lpq command, lprm - command, queuepause command </parameter> and <parameter>queue resume - command</parameter>).</para></tip> + <tip><para> Should it be necessary, for any reason, to set your own print commands, you can do this by setting + <smbconfoption><name>printing</name><value>sysv</value></smbconfoption>. However, you will loose all the benefits + of tight CUPS/Samba integration. When you do this you must manually configure the printing system commands + (most important: <smbconfoption><name>print command</name></smbconfoption>; other commands are + <smbconfoption><name>lppause command</name></smbconfoption>, + <smbconfoption><name>lpresume command</name></smbconfoption>, + <smbconfoption><name>lpq command</name></smbconfoption>, + <smbconfoption><name>lprm command</name></smbconfoption>, + <smbconfoption><name>queuepause command</name></smbconfoption> and + <smbconfoption><name>queue resume command</name></smbconfoption>).</para></tip> </sect2> <sect2> - <title>Simple <filename>smb.conf</filename> Settings for CUPS</title> + <title>Simple &smb.conf; Settings for CUPS</title> <para> - To summarize, here is the simplest printing-related setup - for <filename>smb.conf</filename> to enable basic CUPS support: + To summarize, here is the simplest printing-related setup for &smb.conf; to enable basic CUPS support: </para> - <para><screen> - - [global] - load printers = yes - printing = cups - printcap name = cups - - [printers] - comment = All Printers - path = /var/spool/samba - browseable = no - public = yes - guest ok = yes - writable = no - printable = yes - printer admin = root, @ntadmins - - </screen></para> + <para><smbconfexample> + <title>Simplest printing-related smb.conf</title> + <smbconfsection>[global]</smbconfsection> + <smbconfoption><name>load printers</name><value>yes</value></smbconfoption> + <smbconfoption><name>printing</name><value>cups</value></smbconfoption> + <smbconfoption><name>printcap name</name><value>cups</value></smbconfoption> + + <smbconfsection>[printers]</smbconfsection> + <smbconfoption><name>comment</name><value>All Printers</value></smbconfoption> + <smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> + <smbconfoption><name>browseable</name><value>no</value></smbconfoption> + <smbconfoption><name>public</name><value>yes</value></smbconfoption> + <smbconfoption><name>guest ok</name><value>yes</value></smbconfoption> + <smbconfoption><name>writable</name><value>no</value></smbconfoption> + <smbconfoption><name>printable</name><value>yes</value></smbconfoption> + <smbconfoption><name>printer admin</name><value>root, @ntadmins</value></smbconfoption> + + </smbconfexample></para> <para> This is all you need for basic printing setup for CUPS. It will print @@ -210,63 +193,57 @@ </sect2> <sect2> -<title>More complex <filename>smb.conf</filename> Settings for +<title>More complex &smb.conf; Settings for CUPS</title> <para> Here is a slightly more complex printing-related setup -for <filename>smb.conf</filename>. It enables general CUPS printing +for &smb.conf;. It enables general CUPS printing support for all printers, but defines one printer share which is set up differently. </para> -<para><screen> -<![CDATA[ - [global] - printing = cups - printcap name = cups - load printers = yes - - [printers] - comment = All Printers - path = /var/spool/samba - public = yes - guest ok = yes - writable = no - printable = yes - printer admin = root, @ntadmins - - [special_printer] - comment = A special printer with his own settings - path = /var/spool/samba-special - printing = sysv - printcap = lpstat - print command = echo "NEW: `date`: printfile %f" >> /tmp/smbprn.log ;\ - echo " `date`: p-%p s-%s f-%f" >> /tmp/smbprn.log ;\ - echo " `date`: j-%j J-%J z-%z c-%c" >> /tmp/smbprn.log :\ - rm %f - public = no - guest ok = no - writeable = no - printable = yes - printer admin = kurt - hosts deny = 0.0.0.0 - hosts allow = turbo_xp, 10.160.50.23, 10.160.51.60 -]]> -</screen></para> - -<para> -This special share is only there for my testing purposes. It doesn't -even write the print job to a file. It just logs the job parameters -known to Samba into the <filename>/tmp/smbprn.log</filename> file and -deletes the jobfile. Moreover, the <parameter>printer -admin</parameter> of this share is "kurt" (not the "@ntadmins" group); -guest access is not allowed; the share isn't announced in Network -Neighbourhood (so you need to know it is there), and it is only -allowing access from three hosts. To prevent CUPS kicking in and -taking over the print jobs for that share, we need to set -<parameter>printing = sysv</parameter> and <parameter>printcap = -lpstat</parameter>. +<para><smbconfexample> +<title>Overriding global CUPS settings for one printer</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>printing</name><value>cups</value></smbconfoption> +<smbconfoption><name>printcap name</name><value>cups</value></smbconfoption> +<smbconfoption><name>load printers</name><value>yes</value></smbconfoption> + +<smbconfsection>[printers]</smbconfsection> +<smbconfoption><name>comment</name><value>All Printers</value></smbconfoption> +<smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> +<smbconfoption><name>public</name><value>yes</value></smbconfoption> +<smbconfoption><name>guest ok</name><value>yes</value></smbconfoption> +<smbconfoption><name>writable</name><value>no</value></smbconfoption> +<smbconfoption><name>printable</name><value>yes</value></smbconfoption> +<smbconfoption><name>printer admin</name><value>root, @ntadmins</value></smbconfoption> + +<smbconfsection>[special_printer]</smbconfsection> +<smbconfoption><name>comment</name><value>A special printer with his own settings</value></smbconfoption> +<smbconfoption><name>path</name><value>/var/spool/samba-special</value></smbconfoption> +<smbconfoption><name>printing</name><value>sysv</value></smbconfoption> +<smbconfoption><name>printcap</name><value>lpstat</value></smbconfoption> +<smbconfoption><name>print command</name><value>echo "NEW: `date`: printfile %f" >> /tmp/smbprn.log ; \</value></smbconfoption> +<member><parameter>echo " `date`: p-%p s-%s f-%f" >> /tmp/smbprn.log ; \</parameter></member> +<member><parameter>echo " `date`: j-%j J-%J z-%z c-%c" >> /tmp/smbprn.log : rm %f</parameter></member> +<smbconfoption><name>public</name><value>no</value></smbconfoption> +<smbconfoption><name>guest ok</name><value>no</value></smbconfoption> +<smbconfoption><name>writeable</name><value>no</value></smbconfoption> +<smbconfoption><name>printable</name><value>yes</value></smbconfoption> +<smbconfoption><name>printer admin</name><value>kurt</value></smbconfoption> +<smbconfoption><name>hosts deny</name><value>0.0.0.0</value></smbconfoption> +<smbconfoption><name>hosts allow</name><value>turbo_xp, 10.160.50.23, 10.160.51.60</value></smbconfoption> +</smbconfexample></para> + +<para> +This special share is only there for testing purposes. It does not write the print job to a file. It just logs the job parameters +known to Samba into the <filename>/tmp/smbprn.log</filename> file and deletes the jobfile. Moreover, the +<smbconfoption><name>printer admin</name></smbconfoption> of this share is "kurt" (not the "@ntadmins" group); +guest access is not allowed; the share isn not published to the Network Neighbourhood (so you need to know it is there), and it only +allows access from only three hosts. To prevent CUPS kicking in and taking over the print jobs for that share, we need to set +<smbconfoption><name>printing</name><value>sysv</value></smbconfoption> and +<smbconfoption><name>printcap</name><value>lpstat</value></smbconfoption>. </para> </sect2> </sect1> @@ -275,20 +252,23 @@ lpstat</parameter>. <title>Advanced Configuration</title> <para> -Before we dive into all the configuration options, let's clarify a few +Before we delve into all the configuration options, let us clarify a few points. <emphasis>Network printing needs to be organized and setup correctly</emphasis>. Often this is not done correctly. Legacy systems -or small LANs in business environments often lack a clear design and -good housekeeping. +or small business LAN environments often lack design and good housekeeping. </para> + <sect2> <title>Central spooling vs. "Peer-to-Peer" printing</title> +<indexterm><primary>spooling</primary><secondary>central</secondary></indexterm> +<indexterm><primary>spooling</primary><secondary>peer-to-peer</secondary></indexterm> + <para> Many small office or home networks, as well as badly organized larger environments, allow each client a direct access to available network -printers. Generally, this is a bad idea. It often blocks one client's +printers. This is generally a bad idea. It often blocks one client's access to the printer when another client's job is printing. It also might freeze the first client's application while it is waiting to get rid of the job. Also, there are frequent complaints about various jobs @@ -304,19 +284,22 @@ printer(s) in the correct order. <title>CUPS/Samba as a "spooling-only" Print Server; "raw" printing with Vendor Drivers on Windows Clients</title> +<indexterm><primary>spooling-only</primary></indexterm> +<indexterm><primary>"raw" printing</primary></indexterm> + <para> -Most traditionally configured Unix print servers acting on behalf of +Most traditionally configured UNIX print servers acting on behalf of Samba's Windows clients represented a really simple setup. Their only task was to manage the "raw" spooling of all jobs handed to them by Samba. This approach meant that the Windows clients were expected to -prepare the print job file in such a way that it became fit to be fed to -the printing device. Here a native (vendor-supplied) Windows printer +prepare the print job file that it s ready to be sent to the printing +device. Here a native (vendor-supplied) Windows printer driver for the target device needed to be installed on each and every client. </para> <para> -Of course you can setup CUPS, Samba and your Windows clients in the +It is possible to configure CUPS, Samba and your Windows clients in the same, traditional and simple way. When CUPS printers are configured for RAW print-through mode operation it is the responsibility of the Samba client to fully render the print job (file). The file must be @@ -341,9 +324,12 @@ one by one; this yields the old <emphasis>LanMan</emphasis> style printing; it uses a <filename>\\sambaserver\printershare</filename> type of connection.</para></listitem> -<listitem><para>deposit and prepare the drivers (for later download) on + +<listitem><para> +<indexterm><primary>point and print</primary></indexterm> + deposit and prepare the drivers (for later download) on the print server (Samba); this enables the clients to use -"Point'n'Print" to get drivers semi-automatically installed the +"Point and Print" to get drivers semi-automatically installed the first time they access the printer; with this method NT/2K/XP clients use the <emphasis>SPOOLSS/MS-RPC</emphasis> type printing calls.</para></listitem> @@ -358,6 +344,8 @@ The second method is recommended for use over the first. <title>Explicitly enable "raw" printing for <emphasis>application/octet-stream</emphasis>!</title> +<indexterm><primary>application/octet-stream</primary></indexterm> + <para> If you use the first option (drivers are installed on the client side), there is one setting to take care of: CUPS needs to be told @@ -381,9 +369,7 @@ present: </para> <para><screen> - application/octet-stream - </screen></para> <para> @@ -391,10 +377,10 @@ In <filename>/etc/cups/mime.convs</filename>, have this line: </para> -<para><screen> +<indexterm><primary>application/vnd.cups-raw</primary></indexterm> +<para><screen> application/octet-stream application/vnd.cups-raw 0 - - </screen></para> <para> @@ -411,6 +397,8 @@ convert file 0</computeroutput> in your CUPS error_log file. <formalpara><title>Background</title> +<indexterm><primary>application/octet-stream</primary></indexterm> + <para> CUPS being a more security-aware printing system than traditional ones does not by default allow a user to send deliberate (possibly binary) @@ -437,9 +425,11 @@ of this chapter. <sect2> <title>Three familiar Methods for driver upload plus a new one</title> +<indexterm><primary>point and print</primary></indexterm> + <para> If you want to use the MS-RPC type printing, you must upload the -drivers onto the Samba server first (<parameter>[print$]</parameter> +drivers onto the Samba server first (<smbconfsection>[print$]</smbconfsection> share). For a discussion on how to deposit printer drivers on the Samba host (so that the Windows clients can download and use them via "Point'n'Print") please also refer to the previous chapter of this @@ -447,6 +437,8 @@ HOWTO Collection. There you will find a description or reference to three methods of preparing the client drivers on the Samba server: </para> +<indexterm><primary>add printer wizard</primary></indexterm> + <itemizedlist> <listitem><para>the GUI, "Add Printer Wizard" <emphasis>upload-from-a-Windows-client</emphasis> @@ -456,16 +448,21 @@ method;</para></listitem> <emphasis>upload-from-a-UNIX-workstation</emphasis> method;</para></listitem> -<listitem><para>the <emphasis>Imprints</emphasis> Toolset + +<listitem><para> +<indexterm><primary>imprints</primary></indexterm> + the <emphasis>Imprints</emphasis> Toolset method.</para></listitem> </itemizedlist> <para> These 3 methods apply to CUPS all the same. A new and more convenient way to load the Windows drivers into Samba is provided -provided if you use CUPS: +if you use CUPS: </para> +<indexterm><primary>cupsaddsmb</primary></indexterm> + <itemizedlist> <listitem><para>the <emphasis>cupsaddsmb</emphasis> utility.</para></listitem> @@ -483,8 +480,10 @@ UNIX printing architectures. <title>Using CUPS/Samba in an advanced Way -- intelligent printing with PostScript Driver Download</title> +<indexterm><primary>PostScript</primary><seealso>Ghostscript</seealso></indexterm> + <para> -Still reading on? Good. Let's go into more detail then. We now know +Are you still following this? Good. Let's go into more detail then. We now know how to set up a "dump" printserver, that is, a server which is spooling printjobs "raw", leaving the print data untouched. </para> @@ -521,12 +520,15 @@ how CUPS works and how you can enable its features. <para> What follows is the comparison of some fundamental concepts for -Windows and Unix printing; then is the time for a description of the +Windows and UNIX printing; then is the time for a description of the CUPS filtering system, how it works and how you can tweak it. </para> -<sect2> -<title>GDI on Windows -- PostScript on Unix</title> +<sect2 id="gdipost"> +<title>GDI on Windows -- PostScript on UNIX</title> + +<indexterm><primary>GDI</primary></indexterm> +<indexterm><primary>PostScript</primary></indexterm> <para> Network printing is one of the most complicated and error-prone @@ -534,6 +536,9 @@ day-to-day tasks any user or an administrator may encounter. This is true for all OS platforms. And there are reasons for this. </para> +<indexterm><primary>PCL</primary></indexterm> +<indexterm><primary>PDL</primary></indexterm> + <para> You can't expect for most file formats to just throw them towards printers and they get printed. There needs to be a file format @@ -552,6 +557,10 @@ interpreters, etc.). <sect2> <title>Windows Drivers, GDI and EMF</title> +<indexterm><primary>GDI</primary></indexterm> +<indexterm><primary>EMF</primary></indexterm> +<indexterm><primary>WYSIWYG</primary></indexterm> + <para> In Windows OS, the format conversion job is done by the printer drivers. On MS Windows OS platforms all application programmers have @@ -571,29 +580,30 @@ converted to the printer-specific file format. </para> <note><para> +<indexterm><primary>PDF</primary></indexterm> To the GDI foundation in MS Windows, Apple has chosen to put paper and screen output on a common foundation for their -(BSD-Unix-based, did you know??) Mac OS X and Darwin Operating -Systems.Their <emphasis>Core Graphic Engine</emphasis> uses a -<emphasis>PDF</emphasis> derivate for all display work. +(BSD-UNIX-based, did you know??) Mac OS X and Darwin Operating +Systems. Their <emphasis>Core Graphic Engine</emphasis> uses a +<emphasis>PDF</emphasis> derivative for all display work. </para></note> <para> -<figure><title>Windows Printing to a local Printer</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/1small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/1small.png"/></imageobject> -</mediaobject> -</figure> +<image id="small1"><imagedescription>Windows Printing to a local Printer</imagedescription><imagefile>1small</imagefile></image> </para> </sect2> <sect2> -<title>Unix Printfile Conversion and GUI Basics</title> +<title>UNIX Printfile Conversion and GUI Basics</title> + +<indexterm><primary>X Window System</primary></indexterm> +<indexterm><primary>PostScript</primary></indexterm> +<indexterm><primary>PCL</primary></indexterm> +<indexterm><primary>Xprint</primary></indexterm> <para> -In Unix and Linux, there is no comparable layer built into the OS +In UNIX and Linux, there is no comparable layer built into the OS kernel(s) or the X (screen display) server. Every application is responsible for itself to create its print output. Fortunately, most use PostScript. That gives at least some common ground. Unfortunately, @@ -617,6 +627,8 @@ to be used on paper. <formalpara> <title>Background</title> +<indexterm><primary>PostScript</primary></indexterm> + <para> The PostScript programming language is an "invention" by Adobe Inc., but its specifications have been published to the full. Its strength @@ -637,12 +649,16 @@ program or on paper by a printer. </formalpara> </sect2> -<sect2> +<sect2 id="post-and-ghost"> <title>PostScript and Ghostscript</title> +<indexterm><primary>PostScript</primary></indexterm> +<indexterm><primary>GhostScript</primary><seealso>PostScript</seealso></indexterm> +<indexterm><primary>PostScript</primary><secondary>RIP</secondary></indexterm> + <para> -So, Unix is lacking a common ground for printing on paper and -displaying on screen. Despite this unfavorable legacy for Unix, basic +So, UNIX is lacking a common ground for printing on paper and +displaying on screen. Despite this unfavorable legacy for UNIX, basic printing is fairly easy: if you have PostScript printers at your disposal! The reason is: these devices have a built-in PostScript language "interpreter", also called a <emphasis>Raster Image @@ -654,30 +670,30 @@ you see it on paper, in a resolution as done by your printer. This is no different to PostScript printing of a file from a Windows origin. </para> -<note><para>Traditional Unix programs and printing systems -- while +<note><para> +<indexterm><primary>PPD</primary></indexterm> +Traditional UNIX programs and printing systems -- while using PostScript -- are largely not PPD-aware. PPDs are "PostScript Printer Description" files. They enable you to specify and control all options a printer supports: duplexing, stapling, punching... Therefore -Unix users for a long time couldn't choose many of the supported +UNIX users for a long time couldn't choose many of the supported device and job options, unlike Windows or Apple users. But now there -is CUPS.... ;-) +is CUPS.... </para> </note> <para> -<figure><title>Printing to a Postscript Printer</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/2small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/2small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small2"><imagedescription>Printing to a Postscript Printer</imagedescription> + <imagefile>2small</imagefile></image> </para> +<indexterm><primary>PDL</primary></indexterm> + <para> However, there are other types of printers out there. These don't know how to print PostScript. They use their own <emphasis>Page Description Language</emphasis> (PDL, often proprietary). To print to them is much -more demanding. Since your Unix applications mostly produce +more demanding. Since your UNIX applications mostly produce PostScript, and since these devices don't understand PostScript, you need to convert the printfiles to a format suitable for your printer on the host, before you can send it away. @@ -687,10 +703,12 @@ on the host, before you can send it away. <sect2> <title>Ghostscript -- the Software RIP for non-PostScript Printers</title> +<indexterm><primary>GhostScript</primary></indexterm> + <para> Here is where <emphasis>Ghostscript</emphasis> kicks in. Ghostscript is the traditional (and quite powerful) PostScript interpreter used on -Unix platforms. It is a RIP in software, capable to do a +UNIX platforms. It is a RIP in software, capable to do a <emphasis>lot</emphasis> of file format conversions, for a very broad spectrum of hardware devices as well as software file formats. Ghostscript technology and drivers is what enables PostScript printing @@ -698,12 +716,9 @@ to non-PostScript hardware. </para> <para> -<figure><title>Ghostscript as a RIP for non-postscript printers</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/3small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/3small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small3"><imagedescription>Ghostscript as a RIP for non-postscript printers</imagedescription> + <imagefile>3small</imagefile> +</image> </para> <tip><para> @@ -718,7 +733,7 @@ intervals, now by artofcode LLC. They are initially put under the "AFPL" license, but re-released under the GNU GPL as soon as the next AFPL version appears. GNU Ghostscript is probably the version installed on most Samba systems. But it has got some -deficiencies. Therefore ESP Ghostscript was developed as an +deficiencies. <indexterm><primary>Ghostscript</primary><secondary>ESP</secondary><see>ESP GhostScript</see></indexterm>Therefore ESP Ghostscript was developed as an enhancement over GNU Ghostscript, with lots of bug-fixes, additional devices and improvements. It is jointly maintained by developers from CUPS, Gimp-Print, MandrakeSoft, SuSE, RedHat and Debian. It includes @@ -729,6 +744,8 @@ the "cups" device (essential to print to non-PS printers from CUPS). <sect2> <title>PostScript Printer Description (PPD) Specification</title> +<indexterm><primary>PPD</primary></indexterm> + <para> While PostScript in essence is a <emphasis>Page Description Language</emphasis> (PDL) to represent the page layout in a @@ -761,6 +778,7 @@ file created by the driver. </para> <warning><para> +<indexterm><primary>PDF</primary></indexterm> A PostScript file that was created to contain device-specific commands for achieving a certain print job output (e.g. duplexed, stapled and punched) on a specific target machine, may not print as expected, or @@ -775,7 +793,7 @@ for further processing by software (e.g. by a PDF distilling program). <para> CUPS can handle all spec-compliant PPDs as supplied by the manufacturers for their PostScript models. Even if a -Unix/Linux-illiterate vendor might not have mentioned our favorite +UNIX/Linux-illiterate vendor might not have mentioned our favorite OS in his manuals and brochures -- you can safely trust this: <emphasis>if you get hold of the Windows NT version of the PPD, you can use it unchanged in CUPS</emphasis> and thus access the full @@ -784,7 +802,7 @@ power of your printer just like a Windows NT user could! <tip><para> To check the spec compliance of any PPD online, go to <ulink -url="http://www.cups.org/testppd.php">http://www.cups.org/testppd.php</ulink> +noescape="1" url="http://www.cups.org/testppd.php">http://www.cups.org/testppd.php</ulink> and upload your PPD. You will see the results displayed immediately. CUPS in all versions after 1.1.19 has a much more strict internal PPD parsing and checking code enabled; in case of printing @@ -792,6 +810,8 @@ trouble this online resource should be one of your first pitstops. </para></tip> <warning><para> +<indexterm><primary>foomatic</primary></indexterm> +<indexterm><primary>cupsomatic</primary></indexterm> For real PostScript printers <emphasis>don't</emphasis> use the <emphasis>Foomatic</emphasis> or <emphasis>cupsomatic</emphasis> PPDs from Linuxprinting.org. With these devices the original @@ -863,7 +883,7 @@ Make sure your Ghostscript version has the "cups" device compiled in may encounter the dreaded <computeroutput>Unable to convert file 0</computeroutput> in your CUPS error_log file. To have "cups" as a device in your Ghostscript, you either need to <emphasis>patch GNU -Ghostscript</emphasis> and re-compile or use <ulink +Ghostscript</emphasis> and re-compile or use <indexterm><primary>ESP</primary><secondary>Ghostscript</secondary></indexterm><ulink url="http://www.cups.org/ghostscript.php">ESP Ghostscript</ulink>. The superior alternative is ESP Ghostscript: it supports not just CUPS, but 300 other devices too (while GNU Ghostscript supports only about @@ -873,6 +893,8 @@ Linuxprinting.org for all spoolers. </para> <para> +<indexterm><primary>cupsomatic</primary></indexterm> +<indexterm><primary>foomatic</primary></indexterm> CUPS printers may be setup to use <emphasis>external</emphasis> rendering paths. One of the most common ones is provided by the <emphasis>Foomatic/cupsomatic</emphasis> concept, from <ulink @@ -880,6 +902,7 @@ url="http://www.linuxprinting.org/">Linuxprinting.org</ulink>. This uses the classical Ghostscript approach, doing everything in one step. It doesn't use the "cups" device, but one of the many others. However, even for Foomatic/cupsomatic usage, best results and +<indexterm><primary>ESP</primary><secondary>Ghostscript</secondary></indexterm> broadest printer model support is provided by ESP Ghostscript (more about cupsomatic/Foomatic, particularly the new version called now <emphasis>foomatic-rip</emphasis>, follows below). @@ -889,6 +912,7 @@ about cupsomatic/Foomatic, particularly the new version called now <title>MIME types and CUPS Filters</title> <para> + <indexterm><primary>MIME</primary></indexterm> CUPS reads the file <filename>/etc/cups/mime.types</filename> (and all other files carrying a <filename>*.types</filename> suffix in the same directory) upon startup. These files contain the MIME @@ -899,10 +923,10 @@ for <filename>mime.types</filename> and in the comments section of the like this: </para> -<para><screen> - +<para> +<indexterm><primary>application/pdf</primary></indexterm> +<screen> application/pdf pdf string(0,%PDF) - </screen></para> <para> @@ -915,9 +939,7 @@ Another rule is this: </para> <para><screen> - application/postscript ai eps ps string(0,%!) string(0,<04>%!) - </screen></para> <para> @@ -961,6 +983,8 @@ with its filters. <sect2> <title>MIME type Conversion Rules</title> +<indexterm><primary>MIME</primary></indexterm> + <para> CUPS reads the file <filename>/etc/cups/mime.convs</filename> (and all other files named with a <filename>*.convs</filename> @@ -972,9 +996,7 @@ reads like this: </para> <para><screen> - application/pdf application/postscript 33 pdftops - </screen></para> <para> @@ -985,10 +1007,10 @@ cost of this operation is 33 CUPS-$. The next filter is more expensive, costing 66 CUPS-$: </para> -<para><screen> +<indexterm><primary>pdf</primary></indexterm> +<para><screen> application/vnd.hp-HPGL application/postscript 66 hpgltops - </screen></para> <para> @@ -996,21 +1018,21 @@ This is the <emphasis>hpgltops</emphasis>, which processes HP-GL plotter files to PostScript. </para> -<para><screen> +<indexterm><primary>application/octet-stream</primary></indexterm> +<para><screen> application/octet-stream - </screen></para> <para> Here are two more examples: </para> -<para><screen> +<indexterm><primary>text/plain</primary></indexterm> +<para><screen> application/x-shell application/postscript 33 texttops text/plain application/postscript 33 texttops - </screen></para> <para> @@ -1024,6 +1046,8 @@ this differentiation is needed for the syntax highlighting feature of <sect2> <title>Filter Requirements</title> +<indexterm><primary>MIME</primary></indexterm> + <para> There are many more combinations named in mime.convs. However, you are not limited to use the ones pre-defined there. You can plug in any @@ -1053,25 +1077,25 @@ name of the filter being run)</para></listitem> printed</para></listitem> </varlistentry> -<varlistentry><term>Printer</term> +<varlistentry><term>user</term> <listitem><para>The string from the originating-user-name attribute</para></listitem> </varlistentry> -<varlistentry><term>Printer</term> +<varlistentry><term>title</term> <listitem><para>The string from the job-name attribute</para></listitem> </varlistentry> -<varlistentry><term>Printer</term> +<varlistentry><term>copies</term> <listitem><para>The numeric value from the number-copies attribute</para></listitem> </varlistentry> -<varlistentry><term>Printer</term> +<varlistentry><term>options</term> <listitem><para>The job options</para></listitem> </varlistentry> -<varlistentry><term>Printer</term> +<varlistentry><term>filename</term> <listitem><para>(Optionally) The print request file (if missing, filters expected data fed through <filename>stdin</filename>). In most cases it is very easy to write a simple wrapper script around existing @@ -1084,8 +1108,10 @@ filters to make them work with CUPS.</para></listitem> <sect2> <title>Prefilters</title> +<indexterm><primary>PostScript</primary></indexterm> + <para> -As was said, PostScript is the central file format to any Unix based +As was said, PostScript is the central file format to any UNIX based printing system. From PostScript, CUPS generates raster data to feed non-PostScript printers. </para> @@ -1106,12 +1132,9 @@ print options already embedded into the file. </para> <para> -<figure><title>Prefiltering in CUPS to form Postscript</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/4small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/4small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small4" scale="25"><imagedescription>Prefiltering in CUPS to form Postscript</imagedescription> + <imagefile>4small</imagefile> +</image> </para> </sect2> @@ -1128,12 +1151,9 @@ stapling an punching it, etc.) into the PostScript file. </para> <para> -<figure><title>Adding Device-specific Print Options</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/5small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/5small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small5" scale="25"><imagedescription>Adding Device-specific Print Options</imagedescription> + <imagefile>5small</imagefile> + </image> </para> <para> @@ -1172,12 +1192,7 @@ that are able to generate device-specific printer data. </para> <para> -<figure><title>Postscript to intermediate Raster format</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/6small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/6small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small6" scale="25"><imagedescription>Postscript to intermediate Raster format</imagedescription><imagefile>6small</imagefile></image> </para> <para> @@ -1186,7 +1201,7 @@ able to include per-page information, color profiles and more to be used by the following downstream raster drivers. Its MIME type is registered with IANA and its specification is of course completely open. It is designed to make it very easy and inexpensive for -manufacturers to develop Linux and Unix raster drivers for their +manufacturers to develop Linux and UNIX raster drivers for their printer models, should they choose to do so. CUPS always takes care for the first stage of rasterization so these vendors don't need to care about Ghostscript complications (in fact, there is currently more @@ -1194,12 +1209,9 @@ than one vendor financing the development of CUPS raster drivers). </para> <para> -<figure><title>CUPS-raster production using Ghostscript</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/7small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/7small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small7"><imagedescription>CUPS-raster production using Ghostscript</imagedescription> + <imagefile>7small</imagefile> + </image> </para> <para> @@ -1233,12 +1245,9 @@ filtering: </para> <para> -<figure><title>Image format to CUPS-raster format conversion</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/8small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/8small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small8"><imagedescription>Image format to CUPS-raster format conversion</imagedescription> + <imagefile>8small</imagefile> + </image> </para> </sect2> @@ -1249,9 +1258,9 @@ filtering: <para> CUPS ships with quite some different raster drivers processing CUPS raster. On my system I find in /usr/lib/cups/filter/ these: -<parameter>rastertoalps, rastertobj, rastertoepson, rastertoescp, -rastertopcl, rastertoturboprint, rastertoapdk, rastertodymo, -rastertoescp, rastertohp</parameter> and +<parameter>rastertoalps</parameter>, <parameter>rastertobj</parameter>, <parameter>rastertoepson</parameter>, <parameter>rastertoescp</parameter>, +<parameter>rastertopcl</parameter>, <parameter>rastertoturboprint</parameter>, <parameter>rastertoapdk</parameter>, <parameter>rastertodymo</parameter>, +<parameter>rastertoescp</parameter>, <parameter>rastertohp</parameter> and <parameter>rastertoprinter</parameter>. Don't worry if you have less than this; some of these are installed by commercial add-ons to CUPS (like <parameter>rastertoturboprint</parameter>), others (like @@ -1261,12 +1270,9 @@ closely as possible with CUPS. </para> <para> -<figure><title>Raster to Printer Specific formats</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/9small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/9small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small9"><imagedescription>Raster to Printer Specific formats</imagedescription> + <imagefile>9small</imagefile> + </image> </para> </sect2> @@ -1356,7 +1362,7 @@ This backend sends printfiles to printers shared by a Windows host. An example for CUPS device-URIs to use are: <filename>smb://workgroup/server/printersharename</filename> Or -<filename>Smb://server/printersharename</filename> +<filename>smb://server/printersharename</filename> or <filename>smb://username:password@workgroup/server/printersharename</filename> or @@ -1387,20 +1393,21 @@ printername). Not all of the mentioned backends may be present on your system or usable (depending on your hardware configuration). One test for all available CUPS backends is provided by the <emphasis>lpinfo</emphasis> -utility. Used with the <parameter>-v</parameter> parameter, it lists +utility. Used with the <option>-v</option> parameter, it lists all available backends: </para> <para><screen> - - lpinfo -v - +&prompt;<userinput>lpinfo -v</userinput> </screen></para> </sect2> <sect2> <title>cupsomatic/Foomatic -- how do they fit into the Picture?</title> +<indexterm><primary>cupsomatic</primary></indexterm> +<indexterm><primary>foomatic</primary></indexterm> + <para> "cupsomatic" filters may be the most widely used on CUPS installations. You must be clear about the fact that these were not @@ -1419,9 +1426,7 @@ You can recognize these PPDs from the line calling the </para> <para><screen> - *cupsFilter: "application/vnd.cups-postscript 0 cupsomatic" - </screen></para> <para> @@ -1434,6 +1439,8 @@ auto-constructed from the selected PPD and commandline options give to the printjob. </para> +<indexterm><primary>point and print</primary></indexterm> + <para> However, cupsomatic is now deprecated. Its PPDs (especially the first generation of them, still in heavy use out there) are not meeting the @@ -1515,9 +1522,7 @@ associating any PPD with it. This command: </para> <para><screen> - - lpadmin -P rawprinter -v socket://11.12.13.14:9100 -E - +&prompt;<userinput>lpadmin -P rawprinter -v socket://11.12.13.14:9100 -E</userinput> </screen></para> <para> @@ -1550,9 +1555,7 @@ message in your CUPS logs like: </para> <para><screen> - Unable to convert file 0 to printable format for job - </screen></para> <para> @@ -1573,10 +1576,10 @@ application/octet-stream. In <filename>/etc/cups/mime.types</filename> make sure this line is present: </para> -<para><screen> +<indexterm><primary>application/octet-stream</primary></indexterm> +<para><screen> application/octet-stream - </screen></para> <para> @@ -1587,11 +1590,11 @@ line: </para> <para><screen> - application/octet-stream application/vnd.cups-raw 0 - - </screen></para> +<indexterm><primary>MIME</primary></indexterm> + <para> This line tells CUPS to use the <emphasis>Null Filter</emphasis> (denoted as "-", doing... nothing at all) on @@ -1631,6 +1634,8 @@ conversion filter(s) may be applied to which MIME types. <sect2> <title>PostScript Printer Descriptions (PPDs) for non-PS Printers</title> +<indexterm><primary>PPD</primary></indexterm> + <para> Originally PPDs were meant to be used for PostScript printers only. Here, they help to send device-specific commands and settings @@ -1648,10 +1653,10 @@ PPDs for a non-PS printer have a few lines that are unique to CUPS. The most important one looks similar to this: </para> -<para><screen> +<indexterm><primary>application/vnd.cups-raster</primary></indexterm> +<para><screen> *cupsFilter: application/vnd.cups-raster 66 rastertoprinter - </screen></para> <para> @@ -1673,74 +1678,50 @@ different paper trays, or you may get larger margins than your specific model supports): </para> -<variablelist> -<varlistentry><term>deskjet.ppd</term> -<listitem><para>older HP inkjet printers and compatible -</para></listitem> -</varlistentry> +<table frame="all"> + <title>PPD's shipped with CUPS</title> + <tgroup cols="2" align="left"> + <colspec align="left"/> + <colspec align="justify"/> + <thead><row><entry>PPD file</entry><entry>Printer type</entry></row></thead> + <tbody> + <row><entry>deskjet.ppd</entry><entry>older HP inkjet printers and compatible</entry></row> -<varlistentry><term>deskjet2.ppd</term> -<listitem><para>newer HP inkjet printers and compatible -</para></listitem> -</varlistentry> + <row><entry>deskjet2.ppd</entry> <entry>newer HP inkjet printers and compatible </entry> </row> -<varlistentry><term>dymo.ppd</term> -<listitem><para>label printers -</para></listitem> -</varlistentry> + <row><entry>dymo.ppd</entry> <entry>label printers </entry> </row> -<varlistentry><term>epson9.ppd</term> -<listitem><para>Epson 24pin impact printers and compatible -</para></listitem> -</varlistentry> + <row><entry>epson9.ppd</entry> <entry>Epson 24pin impact printers and compatible </entry> </row> -<varlistentry><term>epson24.ppd</term> -<listitem><para>Epson 24pin impact printers and compatible -</para></listitem> -</varlistentry> + <row><entry>epson24.ppd</entry> <entry>Epson 24pin impact printers and compatible </entry> </row> -<varlistentry><term>okidata9.ppd</term> -<listitem><para>Okidata 9pin impact printers and compatible -</para></listitem> -</varlistentry> + <row><entry>okidata9.ppd</entry> <entry>Okidata 9pin impact printers and compatible </entry> </row> -<varlistentry><term>okidat24.ppd</term> -<listitem><para>Okidata 24pin impact printers and compatible -</para></listitem> -</varlistentry> + <row><entry>okidat24.ppd</entry> <entry>Okidata 24pin impact printers and compatible </entry> </row> -<varlistentry><term>stcolor.ppd</term> -<listitem><para>older Epson Stylus Color printers -</para></listitem> -</varlistentry> + <row><entry>stcolor.ppd</entry> <entry>older Epson Stylus Color printers </entry> </row> -<varlistentry><term>stcolor2.ppd</term> -<listitem><para>newer Epson Stylus Color printers -</para></listitem> -</varlistentry> + <row><entry>stcolor2.ppd</entry> <entry>newer Epson Stylus Color printers </entry> </row> -<varlistentry><term>stphoto.ppd</term> -<listitem><para>older Epson Stylus Photo printers -</para></listitem> -</varlistentry> + <row><entry>stphoto.ppd</entry> <entry>older Epson Stylus Photo printers </entry> </row> -<varlistentry><term>stphoto2.ppd</term> -<listitem><para>newer Epson Stylus Photo printers -</para></listitem> -</varlistentry> + <row><entry>stphoto2.ppd</entry> <entry>newer Epson Stylus Photo printers </entry> </row> + + <row><entry>laserjet.ppd</entry> <entry>all PCL printers. Further below is a discussion of several other driver/PPD-packages suitable for use with CUPS. </entry> </row> + + </tbody> + </tgroup> +</table> -<varlistentry><term>laserjet.ppd</term> -<listitem><para>all PCL printers. Further below is a discussion -of several other driver/PPD-packages suitable fur use with CUPS. -</para></listitem> -</varlistentry> -</variablelist> </sect2> <sect2> <title>Difference between <emphasis>cupsomatic/foomatic-rip</emphasis> and <emphasis>native CUPS</emphasis> printing</title> +<indexterm><primary>cupsomatic</primary></indexterm> +<indexterm><primary>foomatic-rip</primary></indexterm> + <para> Native CUPS rasterization works in two steps. </para> @@ -1748,6 +1729,7 @@ Native CUPS rasterization works in two steps. <itemizedlist> <listitem><para> First is the "pstoraster" step. It uses the special "cups" +<indexterm><primary>ESP</primary><secondary>Ghostscript</secondary></indexterm> device from ESP Ghostscript 7.05.x as its tool </para></listitem> @@ -1764,12 +1746,9 @@ advantages) than other methods. </para> <para> -<figure><title>cupsomatic/foomatic processing versus Native CUPS</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/10small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/10small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small10"><imagedescription>cupsomatic/foomatic processing versus Native CUPS</imagedescription> + <imagefile>10small</imagefile> + </image> </para> <para> @@ -1777,7 +1756,7 @@ One other method is the <emphasis>cupsomatic/foomatic-rip</emphasis> way. Note that cupsomatic is <emphasis>not</emphasis> made by the CUPS developers. It is an independent contribution to printing development, made by people from Linuxprinting.org (see also <ulink -url="http://www.cups.org/cups-help.html">http://www.cups.org/cups-help.html</ulink>). + noescape="1" url="http://www.cups.org/cups-help.html">http://www.cups.org/cups-help.html</ulink>). cupsomatic is no longer developed and maintained and is no longer supported. It has now been replaced by <emphasis>foomatic-rip</emphasis>. foomatic-rip is a complete re-write @@ -1788,6 +1767,8 @@ too. </para> <para> + <indexterm><primary>cupsomatic</primary></indexterm> + <indexterm><primary>foomatic</primary></indexterm> Both the cupsomatic (old) and the foomatic-rip (new) methods from Linuxprinting.org use the traditional Ghostscript print file processing, doing everything in a single step. It therefore relies on @@ -1855,12 +1836,10 @@ backend, which transfers the job to the printers.</para></listitem> </itemizedlist> <para> -The resulting filter chain therefore is: + The resulting filter chain therefore is as drawn in <link linkend="pdftosocket">the image below</link>. </para> -<para><screen> -pdftops --> pstops --> socket -</screen></para> +<image><imagefile>pdftosocket</imagefile><imagedescription>PDF to socket chain</imagedescription></image> <para> Assume your want to print the same filter to an USB-connected @@ -1904,12 +1883,10 @@ which transfers the job to the printers.</para></listitem> </itemizedlist> <para> -The resulting filter chain therefore is: + The resulting filter chain therefore is as drawn in <link linkend="pdftoepsonusb">the image below</link>. </para> -<para><screen> -pdftops --> pstops --> pstoraster --> rastertoepson --> usb -</screen></para> +<image><imagefile>pdftoepsonusb</imagefile><imagedescription>PDF to USB chain</imagedescription></image> </sect2> <sect2> @@ -1922,44 +1899,46 @@ supporting more than 1000 non-PostScript models. </para> <itemizedlist> +<indexterm><primary>ESP</primary><secondary>Print Pro</secondary></indexterm> +<indexterm><primary>PrintPro</primary><see>ESP Print Pro</see></indexterm> <listitem><para><ulink url="http://wwwl.easysw.com/printpro/">ESP -PrintPro (http://wwwl.easysw.com/printpro/)</ulink> (commercial, +PrintPro</ulink> (commercial, non-Free) is packaged with more than 3000 PPDs, ready for successful use "out of the box" on Linux, Mac OS X, IBM-AIX, -HP-UX, Sun-Solaris, SGI-IRIX, Compaq Tru64, Digital Unix and some +HP-UX, Sun-Solaris, SGI-IRIX, Compaq Tru64, Digital UNIX and some more commercial Unices (it is written by the CUPS developers themselves and its sales help finance the further development of CUPS, as they feed their creators).</para></listitem> <listitem><para>the <ulink url="http://gimp-print.sourceforge.net/">Gimp-Print-Project -(http://gimp-print.sourceforge.net/)</ulink> (GPL, Free Software) +</ulink> (GPL, Free Software) provides around 140 PPDs (supporting nearly 400 printers, many driven to photo quality output), to be used alongside the Gimp-Print CUPS filters;</para></listitem> <listitem><para><ulink url="http://www.turboprint.com/">TurboPrint -(http://www.turboprint.com/)</ulink> (Shareware, non-Free) supports +</ulink> (Shareware, non-Free) supports roughly the same amount of printers in excellent quality;</para></listitem> <listitem><para><ulink url="http://www-124.ibm.com/developerworks/oss/linux/projects/omni/">OMNI -(http://www-124.ibm.com/developerworks/oss/linux/projects/omni/)</ulink> +</ulink> (LPGL, Free) is a package made by IBM, now containing support for more than 400 printers, stemming from the inheritance of IBM OS/2 Know-How ported over to Linux (CUPS support is in a Beta-stage at present);</para></listitem> <listitem><para><ulink url="http://hpinkjet.sourceforge.net/">HPIJS -(http://hpinkjet.sourceforge.net/)</ulink> (BSD-style licenses, Free) +</ulink> (BSD-style licenses, Free) supports around 150 of HP's own printers and is also providing excellent print quality now (currently available only via the Foomatic path);</para></listitem> <listitem><para><ulink url="http://www.linuxprinting.org/">Foomatic/cupsomatic -(http://www.linuxprinting.org/)</ulink> (LPGL, Free) from +</ulink> (LPGL, Free) from Linuxprinting.org are providing PPDs for practically every Ghostscript filter known to the world (including Omni, Gimp-Print and HPIJS).</para></listitem> @@ -1990,9 +1969,8 @@ the <command>-i</command> option: </para> <para><screen> - - lpadmin -p pclprinter -v socket://11.12.13.14:9100 -i /path/to/interface-script - +&rootprompt;<userinput>lpadmin -p pclprinter -v socket://11.12.13.14:9100 \ + -i /path/to/interface-script</userinput> </screen></para> <para> @@ -2001,7 +1979,7 @@ with CUPS they provide the most easy way to plug in your own custom-written filtering script or program into one specific print queue (some information about the traditional usage of interface scripts is to be found at <ulink -url="http://playground.sun.com/printing/documentation/interface.html">http://playground.sun.com/printing/documentation/interface.html</ulink>). + noescape="1" url="http://playground.sun.com/printing/documentation/interface.html">http://playground.sun.com/printing/documentation/interface.html</ulink>). </para> </sect2> </sect1> @@ -2024,6 +2002,9 @@ Windows clients printing to an NT-based print server have two options. They may </para> +<indexterm><primary>GDI</primary></indexterm> +<indexterm><primary>EMF</primary></indexterm> + <itemizedlist> <listitem><para>execute the driver locally and render the GDI output (EMF) into the printer specific format on their own, @@ -2045,45 +2026,45 @@ Both print paths are shown in the flowcharts below. <para> In the first case the print server must spool the file as "raw", meaning it shouldn't touch the jobfile and try to convert it in any -way. This is what traditional Unix-based print server can do too; and +way. This is what traditional UNIX-based print server can do too; and at a better performance and more reliably than NT print server. This is what most Samba administrators probably are familiar with. One advantage of this setup is that this "spooling-only" print server may -be used even if no driver(s) for Unix are available it is sufficient +be used even if no driver(s) for UNIX are available it is sufficient to have the Windows client drivers available and installed on the clients. </para> <para> -<figure><title>Print Driver execution on the Client</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/11small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/11small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small11"><imagedescription>Print Driver execution on the Client</imagedescription> + <imagefile>11small</imagefile> + </image> </para> </sect2> <sect2> <title>Driver Execution on the Server</title> +<indexterm><primary>PostScript</primary></indexterm> +<indexterm><primary>PCL</primary></indexterm> +<indexterm><primary>ESC/P</primary></indexterm> +<indexterm><primary>EMF</primary></indexterm> +<indexterm><primary>GDI</primary></indexterm> + <para> The other path executes the printer driver on the server. The clients transfers print files in EMF format to the server. The server uses the PostScript, PCL, ESC/P or other driver to convert the EMF file into -the printer-specific language. It is not possible for Unix to do the +the printer-specific language. It is not possible for UNIX to do the same. Currently there is no program or method to convert a Windows -client's GDI output on a Unix server into something a printer could +client's GDI output on a UNIX server into something a printer could understand. </para> <para> -<figure><title>Print Driver execution on the Server</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/12small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/12small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small12"><imagedescription>Print Driver execution on the Server</imagedescription> + <imagefile>12small</imagefile> + </image> </para> <para> @@ -2130,20 +2111,19 @@ printer is a non-PostScript model. It also requires that you have a <para> Firstly, to enable CUPS based printing through Samba the -following options should be set in your <filename>smb.conf</filename> file [globals] +following options should be set in your &smb.conf; file [global] section: </para> <itemizedlist> -<listitem><para><parameter>printing = CUPS</parameter></para></listitem> +<listitem><para><smbconfoption><name>printing</name><value>cups</value></smbconfoption></para></listitem> -<listitem><para><parameter>printcap = CUPS</parameter></para></listitem> +<listitem><para><smbconfoption><name>printcap</name><value>cups</value></smbconfoption></para></listitem> </itemizedlist> <para> When these parameters are specified, all manually set print directives -(like <parameter>print command =...</parameter>, or <parameter>lppause -command =...</parameter>) in <filename>smb.conf</filename> (as well as +(like <smbconfoption><name>print command</name></smbconfoption>, or <smbconfoption><name>lppause command</name></smbconfoption>) in &smb.conf; (as well as in samba itself) will be ignored. Instead, Samba will directly interface with CUPS through it's application program interface (API) - as long as Samba has been compiled with CUPS library (libcups) @@ -2152,16 +2132,13 @@ other print commands are set up, then printing will use the <emphasis>System V</emphasis> AT&T command set, with the -oraw option automatically passing through (if you want your own defined print commands to work with a Samba that has CUPS support compiled in, -simply use <parameter>printing = sysv</parameter>). +simply use <smbconfoption><name>printing</name><value>sysv</value></smbconfoption>). </para> <para> -<figure><title>Printing via CUPS/samba server</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/13small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/13small.png"/></imageobject> -</mediaobject> -</figure> +<image id="small13"><imagedescription>Printing via CUPS/samba server</imagedescription> + <imagefile>13small</imagefile> +</image> </para> </sect2> @@ -2170,10 +2147,10 @@ simply use <parameter>printing = sysv</parameter>). <para> Samba <emphasis>must</emphasis> use its own spool directory (it is set -by a line similar to <parameter>path = /var/spool/samba</parameter>, -in the <parameter>[printers]</parameter> or -<parameter>[printername]</parameter> section of -<filename>smb.conf</filename>). Samba receives the job in its own +by a line similar to <smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption>, +in the <smbconfsection>[printers]</smbconfsection> or +<smbconfsection>[printername]</smbconfsection> section of +&smb.conf;). Samba receives the job in its own spool space and passes it into the spool directory of CUPS (the CUPS spooling directory is set by the <parameter>RequestRoot</parameter> directive, in a line that defaults to <parameter>RequestRoot @@ -2196,6 +2173,10 @@ need to make sure the Samba host gets access to printing on CUPS. <title>Network PostScript RIP: CUPS Filters on Server -- clients use PostScript Driver with CUPS-PPDs</title> +<indexterm><primary>PostScript</primary></indexterm> +<indexterm><primary>PCL</primary></indexterm> +<indexterm><primary>PJL</primary></indexterm> + <para> PPDs can control all print device options. They are usually provided by the manufacturer; if you own a PostScript printer, that is. PPD @@ -2211,7 +2192,7 @@ printer. Printer driver GUI dialogs translate these options CUPS can load, without any conversions, the PPD file from any Windows (NT is recommended) PostScript driver and handle the options. There is a web browser interface to the print options (select <ulink -url="http://localhost:631/printers/">http://localhost:631/printers/</ulink> +noescape="1" url="http://localhost:631/printers/">http://localhost:631/printers/</ulink> and click on one <emphasis>Configure Printer</emphasis> button to see it), or a commandline interface (see <command>man lpoptions</command> or see if you have lphelp on your system). There are also some @@ -2223,6 +2204,8 @@ PostScript RIP on the real PostScript printer. <sect2> <title>PPDs for non-PS Printers on UNIX</title> +<indexterm><primary>PPD</primary></indexterm> + <para> CUPS doesn't limit itself to "real" PostScript printers in its usage of PPDs. The CUPS developers have extended the scope of the PPD @@ -2248,6 +2231,7 @@ proper raster print format. <sect2> <title>PPDs for non-PS Printers on Windows</title> +<indexterm><primary>PPD</primary></indexterm> <para> CUPS-PPDs can also be used on Windows-Clients, on top of a "core" PostScript driver (now recommended is the "CUPS PostScript @@ -2309,7 +2293,7 @@ of Death" on a regular basis? PostScript drivers generally are very well tested. They are not known to cause any problems, even though they run in Kernel Mode too. This might be because there have so far only been 2 different PostScript -drivers the ones from Adobe and the one from Microsoft. Both are +drivers: the ones from Adobe and the one from Microsoft. Both are very well tested and are as stable as you ever can imagine on Windows. The CUPS driver is derived from the Microsoft one. </para> @@ -2332,6 +2316,9 @@ better, if driven by a different driver! ) <sect2> <title>CUPS: a "Magical Stone"?</title> +<indexterm><primary>PPD</primary></indexterm> +<indexterm><primary>PostScript</primary></indexterm> + <para> Using a PostScript driver, enabled with a CUPS-PPD, seems to be a very elegant way to overcome all these shortcomings. There are, depending @@ -2351,6 +2338,7 @@ although the first feedbacks look very promising. <title>PostScript Drivers with no major problems -- even in Kernel Mode</title> +<indexterm><primary>DDK</primary></indexterm> <para> More recent printer drivers on W2K and XP don't run in Kernel mode (unlike Win NT) any more. However, both operating systems can still @@ -2372,7 +2360,7 @@ owner of an "MS DDK for Win NT", you can check the driver yourself. </sect1> <sect1> -<title> Setting up CUPS for driver Download</title> +<title>Setting up CUPS for driver Download</title> <para> As we have said before: all previously known methods to prepare client @@ -2386,10 +2374,12 @@ relationship. <sect2> <title><emphasis>cupsaddsmb</emphasis>: the unknown Utility</title> +<indexterm><primary>cupsaddsmb</primary></indexterm> + <para> The cupsaddsmb utility (shipped with all current CUPS versions) is an alternative method to transfer printer drivers into the Samba -<parameter>[print$]</parameter> share. Remember, this share is where +<smbconfsection>[print$]</smbconfsection> share. Remember, this share is where clients expect drivers deposited and setup for download and installation. It makes the sharing of any (or all) installed CUPS printers very easy. cupsaddsmb can use the Adobe PostScript driver as @@ -2427,68 +2417,66 @@ too if you need to support Windows 95, 98, and ME clients. </sect2> <sect2> -<title>Prepare your <filename>smb.conf</filename> for -cupsaddsmb</title> +<title>Prepare your &smb.conf; for cupsaddsmb</title> <para> Prior to running cupsaddsmb, you need the following settings in -<filename>smb.conf</filename>: -</para> - -<para><screen> - - [global] - load printers = yes - printing = cups - printcap name = cups - - [printers] - comment = All Printers - path = /var/spool/samba - browseable = no - public = yes - guest ok = yes # setting depends on your requirements - writable = no - printable = yes - printer admin = root - - [print$] - comment = Printer Drivers - path = /etc/samba/drivers - browseable = yes - guest ok = no - read only = yes - write list = root - -</screen></para> +&smb.conf;: +</para> + +<para><smbconfexample> + <title>smb.conf for cupsaddsmb usage</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>load printers</name><value>yes</value></smbconfoption> +<smbconfoption><name>printing</name><value>cups</value></smbconfoption> +<smbconfoption><name>printcap name</name><value>cups</value></smbconfoption> + +<smbconfsection>[printers]</smbconfsection> +<smbconfoption><name>comment</name><value>All Printers</value></smbconfoption> +<smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> +<smbconfoption><name>browseable</name><value>no</value></smbconfoption> +<smbconfoption><name>public</name><value>yes</value></smbconfoption> +<smbconfcomment>setting depends on your requirements</smbconfcomment> +<smbconfoption><name>guest ok</name><value>yes</value></smbconfoption> +<smbconfoption><name>writable</name><value>no</value></smbconfoption> +<smbconfoption><name>printable</name><value>yes</value></smbconfoption> +<smbconfoption><name>printer admin</name><value>root</value></smbconfoption> + <smbconfsection>[print$]</smbconfsection> +<smbconfoption><name>comment</name><value>Printer Drivers</value></smbconfoption> +<smbconfoption><name>path</name><value>/etc/samba/drivers</value></smbconfoption> +<smbconfoption><name>browseable</name><value>yes</value></smbconfoption> +<smbconfoption><name>guest ok</name><value>no</value></smbconfoption> +<smbconfoption><name>read only</name><value>yes</value></smbconfoption> +<smbconfoption><name>write list</name><value>root</value></smbconfoption> +</smbconfexample></para> </sect2> <sect2> <title>CUPS Package of "PostScript Driver for WinNT/2k/XP"</title> +<indexterm><primary>PostScript</primary></indexterm> <para> -CUPS users may get the exactly same packages from<ulink -url="http://www.cups.org/software.html"><emphasis>http://www.cups.org/software.html</emphasis></ulink>. +CUPS users may get the exactly same packages from <ulink +noescape="1" url="http://www.cups.org/software.html">http://www.cups.org/software.html</ulink>. It is a separate package from the CUPS base software files, tagged as -<emphasis>CUPS 1.1.x Windows NT/2k/XP Printer Driver for SAMBA +<emphasis>CUPS 1.1.x Windows NT/2k/XP Printer Driver for Samba (tar.gz, 192k)</emphasis>. The filename to download is <filename>cups-samba-1.1.x.tar.gz</filename>. Upon untar-/unzip-ing, it will reveal these files: </para> <para><screen> - -# tar xvzf cups-samba-1.1.19.tar.gz - - cups-samba.install - cups-samba.license - cups-samba.readme - cups-samba.remove - cups-samba.ss - +&rootprompt;<userinput>tar xvzf cups-samba-1.1.19.tar.gz</userinput> +cups-samba.install +cups-samba.license +cups-samba.readme +cups-samba.remove +cups-samba.ss </screen></para> <para> +<indexterm><primary>ESP</primary><secondary>meta packager</secondary></indexterm> +<indexterm><primary>EPM</primary><see>ESP meta packager</see></indexterm> These have been packaged with the ESP meta packager software "EPM". The <filename>*.install</filename> and <filename>*.remove</filename> files are simple shell scripts, which @@ -2500,13 +2488,10 @@ files: </para> <para><screen> - -# tar tv cups-samba.ss - - cupsdrvr.dll - cupsui.dll - cups.hlp - +&rootprompt;<userinput>tar tv cups-samba.ss</userinput> +cupsdrvr.dll +cupsui.dll +cups.hlp </screen></para> <para> @@ -2515,15 +2500,12 @@ handle: </para> <para><screen> - -# ./cups-samba.install - - [....] - Installing software... - Updating file permissions... - Running post-install commands... - Installation is complete. - +&rootprompt;<userinput>./cups-samba.install</userinput> +[....] +Installing software... +Updating file permissions... +Running post-install commands... +Installation is complete. </screen></para> <para> @@ -2542,11 +2524,11 @@ right place. </para></warning> <para><screen> - - cp /usr/share/drivers/cups.hlp /usr/share/cups/drivers/ - +&rootprompt;<userinput>cp /usr/share/drivers/cups.hlp /usr/share/cups/drivers/</userinput> </screen></para> +<indexterm><primary>DDK</primary></indexterm> + <para> This new CUPS PostScript driver is currently binary-only, but free of charge. No complete source code is provided (yet). The reason is this: @@ -2567,14 +2549,15 @@ The CUPS drivers don't support the "older" Windows 95/98/ME, but only the Windows NT/2000/XP client: </para> -<para><screen> +<para>Windows NT, 2000, and XP are supported by:</para> - [Windows NT, 2000, and XP are supported by:] - cups.hlp - cupsdrvr.dll - cupsui.dll - -</screen></para> +<para> + <itemizedlist> + <listitem><para>cups.hlp</para></listitem> + <listitem><para>cupsdrvr.dll</para></listitem> + <listitem><para>cupsui.dll</para></listitem> + </itemizedlist> +</para> <para> Adobe drivers are available for the older Windows 95/98/ME as well as @@ -2582,22 +2565,29 @@ the Windows NT/2000/XP clients. The set of files is different for the different platforms. </para> -<para><screen> +<para>Windows 95, 98, and Me are supported by:</para> - [Windows 95, 98, and Me are supported by:] - ADFONTS.MFM - ADOBEPS4.DRV - ADOBEPS4.HLP - DEFPRTR2.PPD - ICONLIB.DLL - PSMON.DLL +<para> + <itemizedlist> + <listitem><para>ADFONTS.MFM</para></listitem> + <listitem><para>ADOBEPS4.DRV</para></listitem> + <listitem><para>ADOBEPS4.HLP</para></listitem> + <listitem><para>DEFPRTR2.PPD</para></listitem> + <listitem><para>ICONLIB.DLL</para></listitem> + <listitem><para>PSMON.DLL</para></listitem> +</itemizedlist> +</para> - [Windows NT, 2000, and XP are supported by:] - ADOBEPS5.DLL - ADOBEPSU.DLL - ADOBEPSU.HLP +<para>Windows NT, 2000, and XP are supported by:</para> -</screen></para> +<para> +<itemizedlist> + <listitem><para>ADOBEPS5.DLL</para></listitem> + <listitem><para>ADOBEPSU.DLL</para></listitem> + <listitem><para>ADOBEPSU.HLP</para></listitem> +</itemizedlist> + +</para> <note><para> If both, the Adobe driver files and the CUPS driver files for the @@ -2620,7 +2610,7 @@ native installer and run the installation process on one client once. This will install the drivers (and one Generic PostScript printer) locally on the client. When they are installed, share the Generic PostScript printer. After this, the client's -<parameter>[print$]</parameter> share holds the Adobe files, from +<smbconfsection>[print$]</smbconfsection> share holds the Adobe files, from where you can get them with smbclient from the CUPS host. A more detailed description about this is in the next (the CUPS printing) chapter. @@ -2631,19 +2621,22 @@ chapter. <title>ESP Print Pro Package of "PostScript Driver for WinNT/2k/XP"</title> + +<indexterm><primary>ESP</primary><secondary>Print Pro</secondary></indexterm> + <para> Users of the ESP Print Pro software are able to install their "Samba Drivers" package for this purpose with no problem. Retrieve the driver files from the normal download area of the ESP Print Pro software -at<ulink -url="http://www.easysw.com/software.html">http://www.easysw.com/software.html</ulink>. +at <ulink + noescape="1" url="http://www.easysw.com/software.html">http://www.easysw.com/software.html</ulink>. You need to locate the link labelled "SAMBA" amongst the <emphasis>Download Printer Drivers for ESP Print Pro 4.x</emphasis> area and download the package. Once installed, you can prepare any driver by simply highlighting the printer in the Printer Manager GUI and select <emphasis>Export Driver...</emphasis> from the menu. Of course you need to have prepared Samba beforehand too to handle the -driver files; i.e. mainly setup the <parameter>[print$]</parameter> +driver files; i.e. mainly setup the <smbconfsection>[print$]</smbconfsection> share, etc. The ESP Print Pro package includes the CUPS driver files as well as a (licensed) set of Adobe drivers for the Windows 95/98/ME client family. @@ -2653,11 +2646,13 @@ client family. <sect2> <title>Caveats to be considered</title> +<indexterm><primary>cupsaddsmb</primary></indexterm> + <para> Once you have run the install script (and possibly manually moved the <filename>cups.hlp</filename> file to <filename>/usr/share/cups/drivers/</filename>), the driver is -ready to be put into Samba's <parameter>[print$]</parameter> share (which often maps to +ready to be put into Samba's <smbconfsection>[print$]</smbconfsection> share (which often maps to <filename>/etc/samba/drivers/</filename> and contains a subdir tree with <emphasis>WIN40</emphasis> and <emphasis>W32X86</emphasis> branches): You do this by running @@ -2666,6 +2661,7 @@ CUPS since release 1.1.16). </para> <tip><para> +<indexterm><primary>Single Sign On</primary></indexterm> You may need to put root into the smbpasswd file by running <command>smbpasswd</command>; this is especially important if you should run this whole procedure for the first time, and are not @@ -2674,7 +2670,7 @@ working in an environment where everything is configured for </para></tip> <para> -Once the driver files are in the <parameter>[print$]</parameter> share +Once the driver files are in the <smbconfsection>[print$]</smbconfsection> share and are initialized, they are ready to be downloaded and installed by the Win NT/2k/XP clients. </para> @@ -2696,6 +2692,7 @@ automatically prefer "its own" drivers if it finds both. </para></listitem> <listitem><para> +<indexterm><primary>"Printers" folder</primary></indexterm> Should your Win clients have had the old <filename>ADOBE*.*</filename> files for the Adobe PostScript driver installed, the download and installation of the new CUPS PostScript driver for Windows NT/2k/XP @@ -2703,8 +2700,7 @@ will fail at first. You need to wipe the old driver from the clients first. It is not enough to "delete" the printer, as the driver files will still be kept by the clients and re-used if you try to re-install the printer. To really get rid of the Adobe driver files on the -clients, open the "Printers" folder (possibly via <emphasis>Start ---> Settings --> Control Panel --> Printers</emphasis>), +clients, open the "Printers" folder (possibly via <emphasis>Start, Settings, Control Panel, Printers</emphasis>), right-click onto the folder background and select <emphasis>Server Properties</emphasis>. When the new dialog opens, select the <emphasis>Drivers</emphasis> tab. On the list select the driver you @@ -2716,9 +2712,10 @@ Administrator privileges to do this. </para></listitem> <listitem><para> +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> Once you have successfully downloaded the CUPS PostScript driver to a client, you can easily switch all printers to this one by proceeding -as described elsewhere in the "Samba HOWTO Collection": either change +as described in <link linkend="printing">the printing chapter</link>: either change a driver for an existing printer by running the "Printer Properties" dialog, or use <command>rpcclient</command> with the <command>setdriver</command> sub-command. @@ -2728,8 +2725,8 @@ dialog, or use <command>rpcclient</command> with the </sect2> <sect2> -<title>What are the Benefits of using the "CUPS PostScript Driver for -Windows NT/2k/XP" as compared to the Adobe Driver?</title> +<title>Benefits of using "CUPS PostScript Driver for +Windows NT/2k/XP" instead of Adobe Driver</title> <para> You are interested in a comparison between the CUPS and the Adobe @@ -2743,7 +2740,9 @@ items which weigh in favor of the CUPS ones: <listitem><para>no hassle with the question <quote>Where do I get the ADOBE*.* driver files from?</quote></para></listitem> -<listitem><para>the Adobe drivers (on request of the printer PPD +<listitem><para> +<indexterm><primary>PJL</primary></indexterm> + the Adobe drivers (on request of the printer PPD associated with them) often put a PJL header in front of the main PostScript part of the print file. Thus the printfile starts with <parameter><1B >%-12345X</parameter> or @@ -2752,8 +2751,10 @@ of <parameter>%!PS</parameter>). This leads to the CUPS daemon auto-typing the incoming file as a print-ready file, not initiating a pass through the "pstops" filter (to speak more technically, it is not regarded as the generic MIME type +<indexterm><primary>application/postscript</primary></indexterm> <emphasis>application/postscript</emphasis>, but as the more special MIME type +<indexterm><primary>application/cups.vnd-postscript</primary></indexterm> <emphasis>application/cups.vnd-postscript</emphasis>), which therefore also leads to the page accounting in <emphasis>/var/log/cups/page_log</emphasis> not @@ -2801,42 +2802,33 @@ fully fledged CUPS IPP client for Windows NT/2K/XP to be released soon <sect2> <title>Run "cupsaddsmb" (quiet Mode)</title> +<indexterm><primary>cupsaddsmb</primary></indexterm> +<indexterm><primary>point and print</primary></indexterm> + <para> The cupsaddsmb command copies the needed files into your -<parameter>[print$]</parameter> share. Additionally, the PPD +<smbconfsection>[print$]</smbconfsection> share. Additionally, the PPD associated with this printer is copied from <filename>/etc/cups/ppd/</filename> to -<parameter>[print$]</parameter>. There the files wait for convenient +<smbconfsection>[print$]</smbconfsection>. There the files wait for convenient Windows client installations via Point'n'Print. Before we can run the command successfully, we need to be sure that we can authenticate towards Samba. If you have a small network you are probably using user -level security (<parameter>security = user</parameter>). Probably your -root has already a Samba account. Otherwise, create it now, using -<command>smbpasswd</command>: +level security (<smbconfoption><name>security</name><value>user</value></smbconfoption>). </para> -<para><screen> - - # smbpasswd -a root - New SMB password: [type in password 'secret'] - Retype new SMB password: [type in password 'secret'] - -</screen></para> - <para> Here is an example of a successfully run cupsaddsmb command. </para> <para><screen> - - # cupsaddsmb -U root infotec_IS2027 - Password for root required to access localhost via SAMBA: [type in password 'secret'] - +&rootprompt;<userinput>cupsaddsmb -U root infotec_IS2027</userinput> +Password for root required to access localhost via Samba: <userinput>['secret']</userinput> </screen></para> <para> To share <emphasis>all</emphasis> printers and drivers, use the -<parameter>-a</parameter> parameter instead of a printer name. Since +<option>-a</option> parameter instead of a printer name. Since cupsaddsmb "exports" the printer drivers to Samba, it should be obvious that it only works for queues with a CUPS driver associated. </para> @@ -2845,9 +2837,11 @@ obvious that it only works for queues with a CUPS driver associated. <sect2> <title>Run "cupsaddsmb" with verbose Output</title> +<indexterm><primary>cupsaddsmb</primary></indexterm> + <para> Probably you want to see what's going on. Use the -<parameter>-v</parameter> parameter to get a more verbose output. The +<option>-v</option> parameter to get a more verbose output. The output below was edited for better readability: all "\" at the end of a line indicate that I inserted an artificial line break plus some indentation here: @@ -2855,86 +2849,79 @@ indentation here: <warning><para> You will see the root password for the Samba account printed on -screen. If you use remote access, the password will go over the wire -unencrypted! +screen. </para></warning> +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> <para><screen> - - # cupsaddsmb -U root -v infotec_2105 - Password for root required to access localhost via SAMBA: - Running command: smbclient //localhost/print\$ -N -U'root%secret' -c 'mkdir W32X86;put \ - /var/spool/cups/tmp/3e98bf2d333b5 W32X86/infotec_2105.ppd;put \ - /usr/share/cups/drivers/cupsdrvr.dll W32X86/cupsdrvr.dll;put \ - /usr/share/cups/drivers/cupsui.dll W32X86/cupsui.dll;put \ - /usr/share/cups/drivers/cups.hlp W32X86/cups.hlp' - added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0 - Domain=[CUPS-PRINT] OS=[Unix] Server=[Samba 2.2.7a] - NT_STATUS_OBJECT_NAME_COLLISION making remote directory \W32X86 - putting file /var/spool/cups/tmp/3e98bf2d333b5 as \W32X86/infotec_2105.ppd (2328.8 kb/s) \ - (average 2328.8 kb/s) - putting file /usr/share/cups/drivers/cupsdrvr.dll as \W32X86/cupsdrvr.dll (9374.3 kb/s) \ - (average 5206.6 kb/s) - putting file /usr/share/cups/drivers/cupsui.dll as \W32X86/cupsui.dll (8107.2 kb/s) \ - (average 5984.1 kb/s) - putting file /usr/share/cups/drivers/cups.hlp as \W32X86/cups.hlp (3475.0 kb/s) \ - (average 5884.7 kb/s) +&rootprompt;<userinput>cupsaddsmb -U root -v infotec_2105</userinput> +Password for root required to access localhost via &example.server.samba;: +Running command: smbclient //localhost/print\$ -N -U'root%secret' \ + -c 'mkdir W32X86; \ + put /var/spool/cups/tmp/3e98bf2d333b5 W32X86/infotec_2105.ppd; \ + put /usr/share/cups/drivers/cupsdrvr.dll W32X86/cupsdrvr.dll; \ + put /usr/share/cups/drivers/cupsui.dll W32X86/cupsui.dll; \ + put /usr/share/cups/drivers/cups.hlp W32X86/cups.hlp' +added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0 +Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.7a] +NT_STATUS_OBJECT_NAME_COLLISION making remote directory \W32X86 +putting file /var/spool/cups/tmp/3e98bf2d333b5 as \W32X86/infotec_2105.ppd +putting file /usr/share/cups/drivers/cupsdrvr.dll as \W32X86/cupsdrvr.dll +putting file /usr/share/cups/drivers/cupsui.dll as \W32X86/cupsui.dll +putting file /usr/share/cups/drivers/cups.hlp as \W32X86/cups.hlp - Running command: rpcclient localhost -N -U'root%secret' -c 'adddriver "Windows NT x86" \ - "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll:cups.hlp:NULL: \ - RAW:NULL"' - cmd = adddriver "Windows NT x86" "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll: \ - cups.hlp:NULL:RAW:NULL" - Printer Driver infotec_2105 successfully installed. +Running command: rpcclient localhost -N -U'root%secret' + -c 'adddriver "Windows NT x86" \ + "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll:cups.hlp:NULL: \ + RAW:NULL"' +cmd = adddriver "Windows NT x86" \ + "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll:cups.hlp:NULL:RAW:NULL" +Printer Driver infotec_2105 successfully installed. - Running command: smbclient //localhost/print\$ -N -U'root%secret' -c 'mkdir WIN40;put \ - /var/spool/cups/tmp/3e98bf2d333b5 WIN40/infotec_2105.PPD; put \ - /usr/share/cups/drivers/ADFONTS.MFM WIN40/ADFONTS.MFM;put \ - /usr/share/cups/drivers/ADOBEPS4.DRV WIN40/ADOBEPS4.DRV;put \ - /usr/share/cups/drivers/ADOBEPS4.HLP WIN40/ADOBEPS4.HLP;put \ - /usr/share/cups/drivers/DEFPRTR2.PPD WIN40/DEFPRTR2.PPD;put \ - /usr/share/cups/drivers/ICONLIB.DLL - WIN40/ICONLIB.DLL;put /usr/share/cups/drivers/PSMON.DLL WIN40/PSMON.DLL;' +Running command: smbclient //localhost/print\$ -N -U'root%secret' \ +-c 'mkdir WIN40; \ + put /var/spool/cups/tmp/3e98bf2d333b5 WIN40/infotec_2105.PPD; \ + put /usr/share/cups/drivers/ADFONTS.MFM WIN40/ADFONTS.MFM; \ + put /usr/share/cups/drivers/ADOBEPS4.DRV WIN40/ADOBEPS4.DRV; \ + put /usr/share/cups/drivers/ADOBEPS4.HLP WIN40/ADOBEPS4.HLP; \ + put /usr/share/cups/drivers/DEFPRTR2.PPD WIN40/DEFPRTR2.PPD; \ + put /usr/share/cups/drivers/ICONLIB.DLL WIN40/ICONLIB.DLL; \ + put /usr/share/cups/drivers/PSMON.DLL WIN40/PSMON.DLL;' added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0 - Domain=[CUPS-PRINT] OS=[Unix] Server=[Samba 2.2.7a] + Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.7a] NT_STATUS_OBJECT_NAME_COLLISION making remote directory \WIN40 - putting file /var/spool/cups/tmp/3e98bf2d333b5 as \WIN40/infotec_2105.PPD (2328.8 kb/s) \ - (average 2328.8 kb/s) - putting file /usr/share/cups/drivers/ADFONTS.MFM as \WIN40/ADFONTS.MFM (9368.0 kb/s) \ - (average 6469.6 kb/s) - putting file /usr/share/cups/drivers/ADOBEPS4.DRV as \WIN40/ADOBEPS4.DRV (9958.2 kb/s) \ - (average 8404.3 kb/s) - putting file /usr/share/cups/drivers/ADOBEPS4.HLP as \WIN40/ADOBEPS4.HLP (8341.5 kb/s) \ - (average 8398.6 kb/s) - putting file /usr/share/cups/drivers/DEFPRTR2.PPD as \WIN40/DEFPRTR2.PPD (2195.9 kb/s) \ - (average 8254.3 kb/s) - putting file /usr/share/cups/drivers/ICONLIB.DLL as \WIN40/ICONLIB.DLL (8239.9 kb/s) \ - (average 8253.6 kb/s) - putting file /usr/share/cups/drivers/PSMON.DLL as \WIN40/PSMON.DLL (6222.2 kb/s) \ - (average 8188.5 kb/s) + putting file /var/spool/cups/tmp/3e98bf2d333b5 as \WIN40/infotec_2105.PPD + putting file /usr/share/cups/drivers/ADFONTS.MFM as \WIN40/ADFONTS.MFM + putting file /usr/share/cups/drivers/ADOBEPS4.DRV as \WIN40/ADOBEPS4.DRV + putting file /usr/share/cups/drivers/ADOBEPS4.HLP as \WIN40/ADOBEPS4.HLP + putting file /usr/share/cups/drivers/DEFPRTR2.PPD as \WIN40/DEFPRTR2.PPD + putting file /usr/share/cups/drivers/ICONLIB.DLL as \WIN40/ICONLIB.DLL + putting file /usr/share/cups/drivers/PSMON.DLL as \WIN40/PSMON.DLL - Running command: rpcclient localhost -N -U'root%secret' -c 'adddriver "Windows 4.0" \ - "infotec_2105:ADOBEPS4.DRV:infotec_2105.PPD:NULL:ADOBEPS4.HLP: \ - PSMON.DLL:RAW:ADOBEPS4.DRV,infotec_2105.PPD,ADOBEPS4.HLP,PSMON.DLL, \ - ADFONTS.MFM,DEFPRTR2.PPD,ICONLIB.DLL"' + Running command: rpcclient localhost -N -U'root%secret' \ + -c 'adddriver "Windows 4.0" \ + "infotec_2105:ADOBEPS4.DRV:infotec_2105.PPD:NULL:ADOBEPS4.HLP: \ + PSMON.DLL:RAW:ADOBEPS4.DRV,infotec_2105.PPD,ADOBEPS4.HLP,PSMON.DLL, \ + ADFONTS.MFM,DEFPRTR2.PPD,ICONLIB.DLL"' cmd = adddriver "Windows 4.0" "infotec_2105:ADOBEPS4.DRV:infotec_2105.PPD:NULL: \ - ADOBEPS4.HLP:PSMON.DLL:RAW:ADOBEPS4.DRV,infotec_2105.PPD,ADOBEPS4.HLP, \ + ADOBEPS4.HLP:PSMON.DLL:RAW:ADOBEPS4.DRV,infotec_2105.PPD,ADOBEPS4.HLP, \ PSMON.DLL,ADFONTS.MFM,DEFPRTR2.PPD,ICONLIB.DLL" Printer Driver infotec_2105 successfully installed. - Running command: rpcclient localhost -N -U'root%secret' \ - -c 'setdriver infotec_2105 infotec_2105' + Running command: rpcclient localhost -N -U'root%secret' \ + -c 'setdriver infotec_2105 infotec_2105' cmd = setdriver infotec_2105 infotec_2105 Successfully set infotec_2105 to driver infotec_2105. </screen></para> <para> -If you look closely, you'll discover your root password was transfered +If you look closely, you'll discover your root password was transferred unencrypted over the wire, so beware! Also, if you look further her, you'll discover error messages like NT_STATUS_OBJECT_NAME_COLLISION in between. They occur, because the directories WIN40 and W32X86 already -existed in the <parameter>[print$]</parameter> driver download share +existed in the <smbconfsection>[print$]</smbconfsection> driver download share (from a previous driver installation). They are harmless here. </para> </sect2> @@ -2942,14 +2929,17 @@ existed in the <parameter>[print$]</parameter> driver download share <sect2> <title>Understanding cupsaddsmb</title> +<indexterm><primary>cupsaddsmb</primary></indexterm> + <para> What has happened? What did cupsaddsmb do? There are five stages of the procedure </para> <orderedlist> - -<listitem><para>call the CUPS server via IPP and request the + <listitem><para> + <indexterm><primary>IPP</primary></indexterm> + call the CUPS server via IPP and request the driver files and the PPD file for the named printer;</para></listitem> <listitem><para>store the files temporarily in the local @@ -2957,15 +2947,19 @@ TEMPDIR (as defined in <filename>cupsd.conf</filename>);</para></listitem> <listitem><para>connect via smbclient to the Samba server's - <parameter>[print$]</parameter> share and put the files into the + <smbconfsection>[print$]</smbconfsection> share and put the files into the share's WIN40 (for Win95/98/ME) and W32X86/ (for WinNT/2k/XP) sub directories;</para></listitem> -<listitem><para>connect via rpcclient to the Samba server and +<listitem><para> +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> + connect via rpcclient to the Samba server and execute the "adddriver" command with the correct parameters;</para></listitem> -<listitem><para>connect via rpcclient to the Samba server a second +<listitem><para> +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> + connect via rpcclient to the Samba server a second time and execute the "setdriver" command.</para></listitem> </orderedlist> @@ -2979,14 +2973,12 @@ same host): </para> <para><screen> - - # cupsaddsmb -H sambaserver -h cupsserver -v printername - +&rootprompt;<userinput>cupsaddsmb -H sambaserver -h cupsserver -v printername</userinput> </screen></para> </sect2> <sect2> -<title>How to recognize if cupsaddsm completed successfully</title> +<title>How to recognize if cupsaddsmb completed successfully</title> <para> You <emphasis>must</emphasis> always check if the utility completed @@ -3010,7 +3002,7 @@ architecture...)</para></listitem> <para> These messages probably not easily recognized in the general -output. If you run cupsaddsmb with the <parameter>-a</parameter> +output. If you run cupsaddsmb with the <option>-a</option> parameter (which tries to prepare <emphasis>all</emphasis> active CUPS printer drivers for download), you might miss if individual printers drivers had problems to install properly. Here a redirection of the @@ -3028,6 +3020,8 @@ might occur. <sect2> <title>cupsaddsmb with a Samba PDC</title> +<indexterm><primary>cupsaddsmb</primary></indexterm> + <para> You can't get the standard cupsaddsmb command to run on a Samba PDC? You are asked for the password credential all over again and again and @@ -3036,11 +3030,9 @@ variations: </para> <para><screen> - - # cupsaddsmb -U DOMAINNAME\\root -v printername - # cupsaddsmb -H SAMBA-PDC -U DOMAINNAME\\root -v printername - # cupsaddsmb -H SAMBA-PDC -U DOMAINNAME\\root -h cups-server -v printername - +&rootprompt;<userinput>cupsaddsmb -U &example.workgroup;\\root -v printername</userinput> +&rootprompt;<userinput>cupsaddsmb -H &example.pdc.samba; -U &example.workgroup;\\root -v printername</userinput> +&rootprompt;<userinput>cupsaddsmb -H &example.pdc.samba; -U &example.workgroup;\\root -h cups-server -v printername</userinput> </screen></para> <para> @@ -3052,6 +3044,7 @@ variations: <sect2> <title>cupsaddsmb Flowchart</title> +<indexterm><primary>cupsaddsmb</primary></indexterm> <para> Here is a chart about the procedures, commandflows and dataflows of the "cupaddsmb" command. Note again: cupsaddsmb is @@ -3059,18 +3052,15 @@ not intended to, and does not work with, "raw" queues! </para> <para> -<figure><title>cupsaddsmb flowchart</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/1small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/1small.png"/></imageobject> -</mediaobject> -</figure> + <image id="small14"><imagedescription>cupsaddsmb flowchart</imagedescription> + <imagefile>14small</imagefile></image> </para> </sect2> <sect2> <title>Installing the PostScript Driver on a Client</title> +<indexterm><primary>point and print</primary></indexterm> <para> After cupsaddsmb completed, your driver is prepared for the clients to use. Here are the steps you must perform to download and install it @@ -3080,6 +3070,8 @@ server; <itemizedlist> +<indexterm><primary>"Printers" folder</primary></indexterm> + <listitem><para>open the <emphasis>Printers</emphasis> share of Samba in Network Neighbourhood;</para></listitem> @@ -3104,6 +3096,7 @@ dropdown list of available printers. </para> <note><para> +<indexterm><primary>PPD</primary></indexterm> cupsaddsmb will only reliably work with CUPS version 1.1.15 or higher and Samba from 2.2.4. If it doesn't work, or if the automatic printer driver download to the clients doesn't succeed, you can still manually @@ -3113,9 +3106,7 @@ share for a UNC type of connection: </para></note> <para><screen> - - net use lpt1: \\sambaserver\printershare /user:ntadmin - +&dosprompt;<userinput>net use lpt1: \\sambaserver\printershare /user:ntadmin</userinput> </screen></para> <para> @@ -3190,16 +3181,25 @@ printer should be there. We are providing the driver now);</para></listitem> <listitem><para>copy all files to -<parameter>[print$]:</parameter></para></listitem> + <smbconfsection>[print$]</smbconfsection></para></listitem> -<listitem><para>run <command>rpcclient adddriver</command> +<listitem><para> +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> + run <command>rpcclient adddriver</command> (for each client architecture you want to support):</para></listitem> -<listitem><para>run <command>rpcclient +<listitem><para> +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> + run <command>rpcclient setdriver.</command></para></listitem> </orderedlist> <para> +<indexterm><primary>rpcclient</primary><secondary>enumports</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>enumdrivers</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> We are going to do this now. First, read the man page on "rpcclient" to get a first idea. Look at all the printing related sub-commands. <command>enumprinters</command>, @@ -3265,7 +3265,7 @@ obtaining a list of installed printers and drivers. </sect2> <sect2> -<title>Understanding the rpcclient man Page</title> +<title>Understanding the rpcclient man page</title> <para> The <emphasis>exact</emphasis> format isn't made too clear by the man @@ -3275,12 +3275,12 @@ command and indicated the breaks with "\". Usually you would type the command in one line without the linebreaks: </para> -<para><screen> +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> +<para><screen> adddriver "Architecture" \ "LongPrinterName:DriverFile:DataFile:ConfigFile:HelpFile:\ LanguageMonitorFile:DataType:ListOfFiles,Comma-separated" - </screen></para> <para> @@ -3316,6 +3316,8 @@ now. <title>Producing an Example by querying a Windows Box</title> <para> + <indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> + <indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> We could run <command>rpcclient</command> with a <command>getdriver</command> or a <command>getprinter</command> subcommand (in level 3 verbosity) against it. Just sit down at UNIX or @@ -3324,9 +3326,7 @@ following command: </para> <para><screen> - - rpcclient -U'USERNAME%PASSWORD' NT-SERVER-NAME -c 'getdriver printername 3' - +&rootprompt;<userinput>rpcclient -U'USERNAME%PASSWORD' NT-SERVER-NAME -c 'getdriver printername 3'</userinput> </screen></para> <para> @@ -3334,9 +3334,10 @@ From the result it should become clear which is which. Here is an example from my installation: </para> + <indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> <para><screen> - -# rpcclient -U'Danka%xxxx' W2KSERVER -c'getdriver "DANKA InfoStream Virtual Printer" 3' +&rootprompt;<userinput>rpcclient -U'Danka%xxxx' W2KSERVER \ + -c'getdriver "DANKA InfoStream Virtual Printer" 3'</userinput> cmd = getdriver "DANKA InfoStream Virtual Printer" 3 [Windows NT x86] @@ -3379,17 +3380,18 @@ From the manpage (and from the quoted output of <emphasis>cupsaddsmb</emphasis>, above) it becomes clear that you need to have certain conditions in order to make the manual uploading and initializing of the driver files succeed. The two rpcclient +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> subcommands (<command>adddriver</command> and <command>setdriver</command>) need to encounter the following pre-conditions to complete successfully: </para> <itemizedlist> -<listitem><para>you are connected as "printer admin", or root (note, +<listitem><para>you are connected as <smbconfoption><name>printer admin</name></smbconfoption>, or root (note, that this is <emphasis>not</emphasis> the "Printer Operators" group in NT, but the <emphasis>printer admin</emphasis> group, as defined in -the <parameter>[global]</parameter> section of -<filename>smb.conf</filename>);</para></listitem> +the <smbconfsection>[global]</smbconfsection> section of +&smb.conf;);</para></listitem> <listitem><para>copy all required driver files to <filename>\\sambaserver\print$\w32x86</filename> and @@ -3402,13 +3404,16 @@ to escape the "$": <command>smbclient //sambaserver/print\$ -U root</command>);</para></listitem> <listitem><para>the user you're connecting as must be able to write to -the <parameter>[print$]</parameter> share and create +the <smbconfsection>[print$]</smbconfsection> share and create subdirectories;</para></listitem> <listitem><para>the printer you are going to setup for the Windows clients, needs to be installed in CUPS already;</para></listitem> -<listitem><para>the CUPS printer must be known to Samba, otherwise the +<listitem><para> + <indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> + <indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> + the CUPS printer must be known to Samba, otherwise the <command>setdriver</command> subcommand fails with an NT_STATUS_UNSUCCESSFUL error. To check if the printer is known by Samba you may use the <command>enumprinters</command> subcommand to @@ -3421,7 +3426,7 @@ Samba.</para></listitem> </sect2> <sect2> -<title>Manual Commandline Driver Installation in 15 little Steps</title> +<title>Manual Driver Installation in 15 Steps</title> <para> We are going to install a printer driver now by manually executing all @@ -3430,13 +3435,14 @@ first, we go through the procedure step by step, explaining every single action item as it comes up. </para> -<sect3> -<title>First Step: Install the Printer on CUPS</title> - -<para><screen> +<procedure> + <title>Manual Driver Installation installation</title> -# lpadmin -p mysmbtstprn -v socket://10.160.51.131:9100 -E -P /home/kurt/canonIR85.ppd +<step> +<title>Install the Printer on CUPS</title> +<para><screen> +&rootprompt;<userinput>lpadmin -p mysmbtstprn -v socket://10.160.51.131:9100 -E -P canonIR85.ppd</userinput> </screen></para> <para> @@ -3445,21 +3451,19 @@ to the CUPS system. The printer is accessed via a socket (a.k.a. JetDirect or Direct TCP/IP) connection. You need to be root for this step </para> -</sect3> +</step> -<sect3> -<title>Second Step (optional): Check if the Printer is recognized by +<step> +<title>(optional) Check if the Printer is recognized by Samba</title> + <indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> <para><screen> - - # rpcclient -Uroot%xxxx -c 'enumprinters' localhost | grep -C2 mysmbtstprn - - flags:[0x800000] - name:[\\kde-bitshop\mysmbtstprn] - description:[\\kde-bitshop\mysmbtstprn,,mysmbtstprn] - comment:[mysmbtstprn] - +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'enumprinters' localhost | grep -C2 mysmbtstprn</userinput> +flags:[0x800000] +name:[\\kde-bitshop\mysmbtstprn] +description:[\\kde-bitshop\mysmbtstprn,,mysmbtstprn] +comment:[mysmbtstprn] </screen></para> <para> @@ -3471,32 +3475,35 @@ success. Note the "empty" field between the two commas in the already. You need to know root's Samba password (as set by the <command>smbpasswd</command> command) for this step and most of the following steps. Alternatively you can authenticate as one of the -users from the "write list" as defined in <filename>smb.conf</filename> for -<parameter>[print$]</parameter>. +users from the "write list" as defined in &smb.conf; for +<smbconfsection>[print$]</smbconfsection>. </para> -</sect3> +</step> -<sect3> -<title>Third Step (optional): Check if Samba knows a Driver for the +<step> +<title>(optional) Check if Samba knows a Driver for the Printer</title> + <indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> + <indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> <para><screen> - -# rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost | grep driver - drivername:[] - -# rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost | grep -C4 driv - servername:[\\kde-bitshop] - printername:[\\kde-bitshop\mysmbtstprn] - sharename:[mysmbtstprn] - portname:[Samba Printer Port] - drivername:[] - comment:[mysmbtstprn] - location:[] - sepfile:[] - printprocessor:[winprint] +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost \ + | grep driver </userinput> +drivername:[] + +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost \ + | grep -C4 driv</userinput> +servername:[\\kde-bitshop] +printername:[\\kde-bitshop\mysmbtstprn] +sharename:[mysmbtstprn] +portname:[Samba Printer Port] +drivername:[] +comment:[mysmbtstprn] +location:[] +sepfile:[] +printprocessor:[winprint] -# rpcclient -U root%xxxx -c 'getdriver mysmbtstprn' localhost +&rootprompt;<userinput>rpcclient -U root%xxxx -c 'getdriver mysmbtstprn' localhost</userinput> result was WERR_UNKNOWN_PRINTER_DRIVER </screen></para> @@ -3508,21 +3515,19 @@ attempt to connect to the printer at this stage will prompt the message along the lines: "The server has not the required printer driver installed". </para> -</sect3> +</step> -<sect3> -<title>Fourth Step: Put all required Driver Files into Samba's +<step> +<title>Put all required Driver Files into Samba's [print$]</title> <para><screen> - -# smbclient //localhost/print\$ -U 'root%xxxx' \ - -c 'cd W32X86; \ - put /etc/cups/ppd/mysmbtstprn.ppd mysmbtstprn.PPD; \ - put /usr/share/cups/drivers/cupsui.dll cupsui.dll; \ - put /usr/share/cups/drivers/cupsdrvr.dll cupsdrvr.dll; \ - put /usr/share/cups/drivers/cups.hlp cups.hlp' - +&rootprompt;<userinput>smbclient //localhost/print\$ -U 'root%xxxx' \ + -c 'cd W32X86; \ + put /etc/cups/ppd/mysmbtstprn.ppd mysmbtstprn.PPD; \ + put /usr/share/cups/drivers/cupsui.dll cupsui.dll; \ + put /usr/share/cups/drivers/cupsdrvr.dll cupsdrvr.dll; \ + put /usr/share/cups/drivers/cups.hlp cups.hlp'</userinput> </screen></para> <para> @@ -3530,49 +3535,45 @@ driver installed". line. Line-breaks and the line-end indicating "\" has been inserted for readability reasons.) This step is <emphasis>required</emphasis> for the next one to succeed. It makes the driver files physically -present in the <parameter>[print$]</parameter> share. However, clients +present in the <smbconfsection>[print$]</smbconfsection> share. However, clients would still not be able to install them, because Samba does not yet treat them as driver files. A client asking for the driver would still be presented with a "not installed here" message. </para> -</sect3> +</step> -<sect3> -<title>Fifth Step: Verify where the Driver Files are now</title> +<step> +<title>Verify where the Driver Files are now</title> <para><screen> - -# ls -l /etc/samba/drivers/W32X86/ - total 669 - drwxr-sr-x 2 root ntadmin 532 May 25 23:08 2 - drwxr-sr-x 2 root ntadmin 670 May 16 03:15 3 - -rwxr--r-- 1 root ntadmin 14234 May 25 23:21 cups.hlp - -rwxr--r-- 1 root ntadmin 278380 May 25 23:21 cupsdrvr.dll - -rwxr--r-- 1 root ntadmin 215848 May 25 23:21 cupsui.dll - -rwxr--r-- 1 root ntadmin 169458 May 25 23:21 mysmbtstprn.PPD - +&rootprompt;<userinput>ls -l /etc/samba/drivers/W32X86/</userinput> +total 669 +drwxr-sr-x 2 root ntadmin 532 May 25 23:08 2 +drwxr-sr-x 2 root ntadmin 670 May 16 03:15 3 +-rwxr--r-- 1 root ntadmin 14234 May 25 23:21 cups.hlp +-rwxr--r-- 1 root ntadmin 278380 May 25 23:21 cupsdrvr.dll +-rwxr--r-- 1 root ntadmin 215848 May 25 23:21 cupsui.dll +-rwxr--r-- 1 root ntadmin 169458 May 25 23:21 mysmbtstprn.PPD </screen></para> <para> The driver files now are in the W32X86 architecture "root" of -<parameter>[print$]</parameter>. +<smbconfsection>[print$]</smbconfsection>. </para> -</sect3> +</step> -<sect3> -<title>Sixth Step: Tell Samba that these are +<step> +<title>Tell Samba that these are <emphasis>Driver</emphasis> Files (<command>adddriver</command>)</title> + <indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> <para><screen> - -# rpcclient -Uroot%xxxx -c `adddriver "Windows NT x86" "mydrivername: \ - cupsdrvr.dll:mysmbtstprn.PPD: \ - cupsui.dll:cups.hlp:NULL:RAW<citation>:</citation>NULL" \ - localhost - - Printer Driver mydrivername successfully installed. - +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c `adddriver "Windows NT x86" "mydrivername: \ + cupsdrvr.dll:mysmbtstprn.PPD: \ + cupsui.dll:cups.hlp:NULL:RAW:NULL" \ + localhost</userinput> +Printer Driver mydrivername successfully installed. </screen></para> <para> @@ -3586,70 +3587,65 @@ the printername; however, in big installations you may use this driver for a number of printers which have obviously different names. So the name of the driver is not fixed. </para> -</sect3> +</step> -<sect3> -<title>Seventh Step: Verify where the Driver Files are now</title> +<step> +<title>Verify where the Driver Files are now</title> <para><screen> - -# ls -l /etc/samba/drivers/W32X86/ - total 1 - drwxr-sr-x 2 root ntadmin 532 May 25 23:22 2 - drwxr-sr-x 2 root ntadmin 670 May 16 03:15 3 - - -# ls -l /etc/samba/drivers/W32X86/2 - total 5039 - [....] - -rwxr--r-- 1 root ntadmin 14234 May 25 23:21 cups.hlp - -rwxr--r-- 1 root ntadmin 278380 May 13 13:53 cupsdrvr.dll - -rwxr--r-- 1 root ntadmin 215848 May 13 13:53 cupsui.dll - -rwxr--r-- 1 root ntadmin 169458 May 25 23:21 mysmbtstprn.PPD - +&rootprompt;<userinput>ls -l /etc/samba/drivers/W32X86/</userinput> +total 1 +drwxr-sr-x 2 root ntadmin 532 May 25 23:22 2 +drwxr-sr-x 2 root ntadmin 670 May 16 03:15 3 + +&rootprompt;<userinput>ls -l /etc/samba/drivers/W32X86/2</userinput> +total 5039 +[....] +-rwxr--r-- 1 root ntadmin 14234 May 25 23:21 cups.hlp +-rwxr--r-- 1 root ntadmin 278380 May 13 13:53 cupsdrvr.dll +-rwxr--r-- 1 root ntadmin 215848 May 13 13:53 cupsui.dll +-rwxr--r-- 1 root ntadmin 169458 May 25 23:21 mysmbtstprn.PPD </screen></para> <para> Notice how step 6 did also move the driver files to the appropriate subdirectory. Compare with the situation after step 5. </para> -</sect3> +</step> -<sect3> -<title>Eighth Step (optional): Verify if Samba now recognizes the +<step> +<title>(optional) Verify if Samba now recognizes the Driver</title> + <indexterm><primary>rpcclient</primary><secondary>enumdrivers</secondary></indexterm> <para><screen> - -# rpcclient -Uroot%xxxx -c 'enumdrivers 3' localhost | grep -B2 -A5 mydrivername - - Printer Driver Info 3: - Version: [2] - Driver Name: [mydrivername] - Architecture: [Windows NT x86] - Driver Path: [\\kde-bitshop\print$\W32X86\2\cupsdrvr.dll] - Datafile: [\\kde-bitshop\print$\W32X86\2\mysmbtstprn.PPD] - Configfile: [\\kde-bitshop\print$\W32X86\2\cupsui.dll] - Helpfile: [\\kde-bitshop\print$\W32X86\2\cups.hlp] - +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'enumdrivers 3' localhost \ + | grep -B2 -A5 mydrivername</userinput> +Printer Driver Info 3: +Version: [2] +Driver Name: [mydrivername] +Architecture: [Windows NT x86] +Driver Path: [\\kde-bitshop\print$\W32X86\2\cupsdrvr.dll] +Datafile: [\\kde-bitshop\print$\W32X86\2\mysmbtstprn.PPD] +Configfile: [\\kde-bitshop\print$\W32X86\2\cupsui.dll] +Helpfile: [\\kde-bitshop\print$\W32X86\2\cups.hlp] </screen></para> <para> Remember, this command greps for the name you did choose for the driver in step Six. This command must succeed before you can proceed. </para> -</sect3> +</step> -<sect3> -<title>Ninth Step: Tell Samba which Printer should use these Driver +<step> +<title>Tell Samba which Printer should use these Driver Files (<command>setdriver</command>)</title> -<para><screen> - -# rpcclient -Uroot%xxxx -c 'setdriver mysmbtstprn mydrivername' localhost - - Successfully set mysmbtstprn to driver mydrivername +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> +<para><screen> +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'setdriver mysmbtstprn mydrivername' localhost</userinput> +Successfully set mysmbtstprn to driver mydrivername </screen></para> <para> @@ -3660,63 +3656,69 @@ setdriver command to succeed. The only pre-conditions are: <command>enumdrivers</command> must find the driver and <command>enumprinters</command> must find the printer. </para> -</sect3> +</step> -<sect3> -<title>Tenth Step (optional): Verify if Samba has this Association +<step> +<title>(optional) Verify if Samba has this Association recognized</title> +<indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> +<indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> <para><screen> - -# rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost | grep driver - drivername:[mydrivername] +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost \ + | grep driver</userinput> +drivername:[mydrivername] -# rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost | grep -C4 driv - servername:[\\kde-bitshop] - printername:[\\kde-bitshop\mysmbtstprn] - sharename:[mysmbtstprn] - portname:[Done] - drivername:[mydrivername] - comment:[mysmbtstprn] - location:[] - sepfile:[] - printprocessor:[winprint] +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost \ + | grep -C4 driv</userinput> +servername:[\\kde-bitshop] +printername:[\\kde-bitshop\mysmbtstprn] +sharename:[mysmbtstprn] +portname:[Done] +drivername:[mydrivername] +comment:[mysmbtstprn] +location:[] +sepfile:[] +printprocessor:[winprint] -# rpcclient -U root%xxxx -c 'getdriver mysmbtstprn' localhost - [Windows NT x86] - Printer Driver Info 3: - Version: [2] - Driver Name: [mydrivername] - Architecture: [Windows NT x86] - Driver Path: [\\kde-bitshop\print$\W32X86\2\cupsdrvr.dll] - Datafile: [\\kde-bitshop\print$\W32X86\2\mysmbtstprn.PPD] - Configfile: [\\kde-bitshop\print$\W32X86\2\cupsui.dll] - Helpfile: [\\kde-bitshop\print$\W32X86\2\cups.hlp] - Monitorname: [] - Defaultdatatype: [RAW] - Monitorname: [] - Defaultdatatype: [RAW] +&rootprompt;<userinput>rpcclient -U root%xxxx -c 'getdriver mysmbtstprn' localhost</userinput> +[Windows NT x86] +Printer Driver Info 3: + Version: [2] + Driver Name: [mydrivername] + Architecture: [Windows NT x86] + Driver Path: [\\kde-bitshop\print$\W32X86\2\cupsdrvr.dll] + Datafile: [\\kde-bitshop\print$\W32X86\2\mysmbtstprn.PPD] + Configfile: [\\kde-bitshop\print$\W32X86\2\cupsui.dll] + Helpfile: [\\kde-bitshop\print$\W32X86\2\cups.hlp] + Monitorname: [] + Defaultdatatype: [RAW] + Monitorname: [] + Defaultdatatype: [RAW] -# rpcclient -Uroot%xxxx -c 'enumprinters' localhost | grep mysmbtstprn - name:[\\kde-bitshop\mysmbtstprn] - description:[\\kde-bitshop\mysmbtstprn,mydrivername,mysmbtstprn] - comment:[mysmbtstprn] +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'enumprinters' localhost | grep mysmbtstprn</userinput> + name:[\\kde-bitshop\mysmbtstprn] + description:[\\kde-bitshop\mysmbtstprn,mydrivername,mysmbtstprn] + comment:[mysmbtstprn] </screen></para> <para> +<indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> Compare these results with the ones from steps 2 and 3. Note that every single of these commands show the driver is installed. Even the <command>enumprinters</command> command now lists the driver on the "description" line. </para> -</sect3> +</step> -<sect3> -<title>Eleventh Step (optional): Tickle the Driver into a correct +<step> +<title>(optional) Tickle the Driver into a correct Device Mode</title> <para> +<indexterm><primary>"Printers" folder</primary></indexterm> You certainly know how to install the driver on the client. In case you are not particularly familiar with Windows, here is a short recipe: browse the Network Neighbourhood, go to the Samba server, look @@ -3731,56 +3733,53 @@ folder, named something like "printersharename on Sambahostname". <para> It is important that you execute this step as a Samba printer admin -(as defined in <filename>smb.conf</filename>). Here is another method +(as defined in &smb.conf;). Here is another method to do this on Windows XP. It uses a commandline, which you may type into the "DOS box" (type root's smbpassword when prompted): </para> <para><screen> - - C:\> runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry /in /n \\sambacupsserver\mysmbtstprn" - +&dosprompt;<userinput>runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry /in /n\ + \\sambacupsserver\mysmbtstprn"</userinput> </screen></para> <para> -Change any printer setting once (like <emphasis>"portrait" ---> "landscape"</emphasis>), click "Apply"; change the setting +Change any printer setting once (like changing <emphasis>"portrait" to + "landscape"</emphasis>), click <guibutton>Apply</guibutton>; change the setting back. </para> -</sect3> +</step> -<sect3> -<title>Twelfth Step: Install the Printer on a Client +<step> +<title>Install the Printer on a Client ("Point'n'Print")</title> -<para><screen> - - C:\> rundll32 printui.dll,PrintUIEntry /in /n "\\sambacupsserver\mysmbtstprn" +<indexterm significance="preferred"><primary>point and print</primary></indexterm> +<para><screen> +&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /in /n "\\sambacupsserver\mysmbtstprn"</userinput> </screen></para> <para> If it doesn't work it could be a permission problem with the -<parameter>[print$]</parameter> share. +<smbconfsection>[print$]</smbconfsection> share. </para> -</sect3> +</step> -<sect3> +<step> <title>Thirteenth Step (optional): Print a Test Page</title> <para><screen> - - C:\> rundll32 printui.dll,PrintUIEntry /p /n "\\sambacupsserver\mysmbtstprn" - +&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /p /n "\\sambacupsserver\mysmbtstprn"</userinput> </screen></para> <para> Then hit [TAB] 5 times, [ENTER] twice, [TAB] once and [ENTER] again and march to the printer. </para> -</sect3> +</step> -<sect3> +<step> <title>Fourteenth Step (recommended): Study the Test Page</title> <para> @@ -3789,18 +3788,17 @@ installations and you don't need to read a word. Just put it in a frame and bolt it to the wall with the heading "MY FIRST RPCCLIENT-INSTALLED PRINTER" - why not just throw it away! </para> -</sect3> +</step> -<sect3> +<step> <title>Fifteenth Step (obligatory): Enjoy. Jump. Celebrate your Success</title> <para><screen> - -# echo "Cheeeeerioooooo! Success..." >> /var/log/samba/log.smbd - +&rootprompt;<userinput>echo "Cheeeeerioooooo! Success..." >> /var/log/samba/log.smbd</userinput> </screen></para> -</sect3> +</step> +</procedure> </sect2> <sect2> @@ -3829,7 +3827,8 @@ a disappointing message like this one beneath? </screen></para> <para> -It is not good enough that <emphasis>you</emphasis> +<indexterm><primary>lpstat</primary></indexterm> +It is not good enough that you can see the queue <emphasis>in CUPS</emphasis>, using the <command>lpstat -p ir85wm</command> command. A bug in most recent versions of Samba prevents the proper update of @@ -3840,26 +3839,24 @@ execute the setdriver command successfully, check if Samba "sees" the printer: </para> +<indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> <para><screen> - -# rpcclient transmeta -N -U'root%secret' -c 'enumprinters 0'| grep ir85wm +&rootprompt;<userinput>rpcclient transmeta -N -U'root%secret' -c 'enumprinters 0'| grep ir85wm</userinput> printername:[ir85wm] - </screen></para> <para> An alternative command could be this: </para> +<indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> <para><screen> - -# rpcclient transmeta -N -U'root%secret' -c 'getprinter ir85wm' +&rootprompt;<userinput>rpcclient transmeta -N -U'root%secret' -c 'getprinter ir85wm' </userinput> cmd = getprinter ir85wm flags:[0x800000] name:[\\transmeta\ir85wm] description:[\\transmeta\ir85wm,ir85wm,DPD] comment:[CUPS PostScript-Treiber for WinNT/2K/XP] - </screen></para> <para> @@ -3873,6 +3870,19 @@ to install drivers on remote Windows NT print servers too! <title>The printing <filename>*.tdb</filename> Files</title> <para> +<indexterm><primary>TDB</primary></indexterm> +<indexterm><primary>connections.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>printing.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>share_info.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>ntdrivers.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>unexpected.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>brlock.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>locking.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>ntforms.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>messages.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>ntprinters.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>sessionid.tdb</primary><seealso>TDB</seealso></indexterm> +<indexterm><primary>secrets.tdb</primary><seealso>TDB</seealso></indexterm> Some mystery is associated with the series of files with a tdb-suffix appearing in every Samba installation. They are <filename>connections.tdb</filename>, @@ -3892,12 +3902,13 @@ tdb-suffix appearing in every Samba installation. They are <sect2> <title>Trivial DataBase Files</title> +<indexterm><primary>TDB</primary></indexterm> <para> A Windows NT (Print) Server keeps track of all information needed to serve its duty toward its clients by storing entries in the Windows "Registry". Client queries are answered by reading from the registry, Administrator or user configuration settings are saved by writing into -the Registry. Samba and Unix obviously don't have such a kind of +the Registry. Samba and UNIX obviously don't have such a kind of Registry. Samba instead keeps track of all client related information in a series of <filename>*.tdb</filename> files. (TDB = Trivial Data Base). These are often located in <filename>/var/lib/samba/</filename> @@ -3946,6 +3957,9 @@ backup of the <filename>*.tdb</filename> files in time. <sect2> <title>Using <emphasis>tdbbackup</emphasis></title> +<indexterm><primary>TDB</primary><secondary>backing up</secondary><see>tdbbackup</see></indexterm> +<indexterm><primary>tdbbackup</primary></indexterm> + <para> Samba ships with a little utility which helps the root user of your system to back up your <filename>*.tdb</filename> files. If you run it @@ -3953,8 +3967,7 @@ with no argument, it prints a little usage message: </para> <para><screen> - -# tdbbackup +&rootprompt;<userinput>tdbbackup</userinput> Usage: tdbbackup [options] <fname...> Version:3.0a @@ -3969,16 +3982,16 @@ Here is how I backed up my printing.tdb file: </para> <para><screen> - -# ls - . browse.dat locking.tdb ntdrivers.tdb printing.tdb share_info.tdb - .. connections.tdb messages.tdb ntforms.tdb printing.tdbkp unexpected.tdb - brlock.tdb gmon.out namelist.debug ntprinters.tdb sessionid.tdb +&rootprompt;<userinput>ls</userinput> +. browse.dat locking.tdb ntdrivers.tdb printing.tdb +.. share_info.tdb connections.tdb messages.tdb ntforms.tdb +printing.tdbkp unexpected.tdb brlock.tdb gmon.out namelist.debug +ntprinters.tdb sessionid.tdb - kde-bitshop:/var/lock/samba # tdbbackup -s .bak printing.tdb +&rootprompt;<userinput>tdbbackup -s .bak printing.tdb</userinput> printing.tdb : 135 records - kde-bitshop:/var/lock/samba # ls -l printing.tdb* +&rootprompt;<userinput>ls -l printing.tdb*</userinput> -rw------- 1 root root 40960 May 2 03:44 printing.tdb -rw------- 1 root root 40960 May 2 03:44 printing.tdb.bak @@ -3989,23 +4002,25 @@ Here is how I backed up my printing.tdb file: <sect1> <title>CUPS Print Drivers from Linuxprinting.org</title> +<indexterm><primary>Linuxprinting.org</primary></indexterm> + <para> CUPS ships with good support for HP LaserJet type printers. You can install the generic driver as follows: </para> -<para><screen> - -lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E -m laserjet.ppd +<indexterm><primary>lpadmin</primary></indexterm> +<para><screen> +&rootprompt;<userinput>lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E -m laserjet.ppd</userinput> </screen></para> <para> -The <parameter>-m</parameter> switch will retrieve the +The <option>-m</option> switch will retrieve the <filename>laserjet.ppd</filename> from the standard repository for not-yet-installed-PPDs, which CUPS typically stores in <filename>/usr/share/cups/model</filename>. Alternatively, you may use -<parameter>-P /path/to/your.ppd</parameter>. +<option>-P /path/to/your.ppd</option>. </para> <para> @@ -4014,7 +4029,7 @@ for every LaserJet-compatible model. It constitutes a sort of "least denominator" of all the models. If for some reason it is ruled out to you to pay for the commercially available ESP Print Pro drivers, your first move should be to consult the database on <ulink -url="http://www.linuxprinting.org/printer_list.cgi">http://www.linuxprinting.org/printer_list.cgi</ulink>. +noescape="1" url="http://www.linuxprinting.org/printer_list.cgi">http://www.linuxprinting.org/printer_list.cgi</ulink>. Linuxprinting.org has excellent recommendations about which driver is best used for each printer. Its database is kept current by the tireless work of Till Kamppeter from MandrakeSoft, who is also the @@ -4022,11 +4037,12 @@ principal author of the foomatic-rip utility. </para> <note><para> +<indexterm><primary>foomatic-rip</primary></indexterm> The former "cupsomatic" concept is now be replaced by the new, much more powerful "foomatic-rip". foomatic-rip is the successor of cupsomatic. cupsomatic is no longer maintained. Here is the new URL to the Foomatic-3.0 database:<ulink -url="http://www.linuxprinting.org/driver_list.cgi">http://www.linuxprinting.org/driver_list.cgi</ulink>. +noescape="1" url="http://www.linuxprinting.org/driver_list.cgi">http://www.linuxprinting.org/driver_list.cgi</ulink>. If you upgrade to foomatic-rip, don't forget to also upgrade to the new-style PPDs for your foomatic-driven printers. foomatic-rip will not work with PPDs generated for the old cupsomatic. The new-style @@ -4038,6 +4054,9 @@ provide the driver files for the Windows clients also! <sect2> <title>foomatic-rip and Foomatic explained</title> +<indexterm significance="preferred"><primary>foomatic</primary></indexterm> +<indexterm significance="preferred"><primary>foomatic-rip</primary></indexterm> + <para> Nowadays most Linux distros rely on the utilities of Linuxprinting.org to create their printing related software (which, BTW, works on all @@ -4104,6 +4123,8 @@ of the data. <sect3> <title>Foomatic's strange Name</title> +<indexterm><primary>foomatic</primary></indexterm> + <para> "Why the funny name?", you ask. When it really took off, around spring 2000, CUPS was far less popular than today, and most systems used LPD, @@ -4143,6 +4164,10 @@ Ghostscript filters.</para></listitem> <sect3> <title>cupsomatic, pdqomatic, lpdomatic, directomatic</title> +<indexterm><primary>cupsomatic</primary></indexterm> +<indexterm><primary>CUPS-PPD</primary></indexterm> +<indexterm><primary>PPD</primary><secondary>CUPS</secondary><see>CUPS-PPD</see></indexterm> + <para> CUPS worked through a quickly-hacked up filter script named <ulink url="http://www.linuxprinting.org/download.cgi?filename=cupsomatic&show=0">cupsomatic</ulink>. @@ -4191,9 +4216,11 @@ configuration files.. </sect3> <sect3> -<title>7.13.1.5.The <emphasis>Grand Unification</emphasis> +<title>The <emphasis>Grand Unification</emphasis> achieved...</title> +<indexterm><primary>foomatic-rip</primary></indexterm> + <para> This all has changed in Foomatic versions 2.9 (Beta) and released as "stable" 3.0. This has now achieved the convergence of all *omatic @@ -4261,7 +4288,7 @@ the work is currently done in three projects. These are: url="http://www-124.ibm.com/developerworks/oss/linux/projects/omni/">Omni</ulink> -- a Free Software project by IBM which tries to convert their printer driver knowledge from good-ol' OS/2 times into a modern, modular, -universal driver architecture for Linux/Unix (still Beta). This +universal driver architecture for Linux/UNIX (still Beta). This currently supports 437 models.</para></listitem> <listitem><para><ulink url="http://hpinkjet.sf.net/">HPIJS</ulink> -- @@ -4282,7 +4309,7 @@ platforms). This currently supports 522 models.</para></listitem> <sect3> <title>Forums, Downloads, Tutorials, Howtos -- also for Mac OS X and -commercial Unix</title> +commercial UNIX</title> <para> Linuxprinting.org today is the one-stop "shop" to download printer @@ -4361,11 +4388,11 @@ Linuxprinting.org ensures you to get the latest driver/PPD files): </para> <itemizedlist> <listitem><para>Surf to <ulink -url="http://www.linuxprinting.org/printer_list.cgi">http://www.linuxprinting.org/printer_list.cgi</ulink> +noescape="1" url="http://www.linuxprinting.org/printer_list.cgi">http://www.linuxprinting.org/printer_list.cgi</ulink> </para></listitem> <listitem><para>Check the complete list of printers in the database: -<ulink +<ulink noescape="1" url="http://www.linuxprinting.org/printer_list.cgi?make=Anyone">http://www.linuxprinting.org/printer_list.cgi?make=Anyone</ulink> </para></listitem> @@ -4378,7 +4405,7 @@ with this model (for all printers, there will always be first).</para></listitem> <listitem><para>In our case ("HP LaserJet 4 Plus"), we'll arrive here: -<ulink + <ulink noescape="1" url="http://www.linuxprinting.org/show_printer.cgi?recnum=HP-LaserJet_4_Plus">http://www.linuxprinting.org/show_printer.cgi?recnum=HP-LaserJet_4_Plus</ulink> </para></listitem> @@ -4389,7 +4416,7 @@ visit them all, if you are not familiar with the Linuxprinting.org database.</para></listitem> <listitem><para>There is a link to the database page for the "ljet4": -<ulink + <ulink noescape="1" url="http://www.linuxprinting.org/show_driver.cgi?driver=ljet4">http://www.linuxprinting.org/show_driver.cgi?driver=ljet4</ulink> On the driver's page, you'll find important and detailed information about how to use that driver within the various available @@ -4399,23 +4426,23 @@ spoolers.</para></listitem> driver author or the driver.</para></listitem> <listitem><para>Important links are the ones which provide hints with -setup instructions for CUPS (<ulink +setup instructions for CUPS (<ulink noescape="1" url="http://www.linuxprinting.org/cups-doc.html">http://www.linuxprinting.org/cups-doc.html</ulink>), -PDQ (<ulink +PDQ (<ulink noescape="1" url="http://www.linuxprinting.org/pdq-doc.html">http://www.linuxprinting.org/pdq-doc.html</ulink>), -LPD, LPRng and GNUlpr (<ulink +LPD, LPRng and GNUlpr (<ulink noescape="1" url="http://www.linuxprinting.org/lpd-doc.html">http://www.linuxprinting.org/lpd-doc.html</ulink>) -as well as PPR (<ulink +as well as PPR (<ulink noescape="1" url="http://www.linuxprinting.org/ppr-doc.html">http://www.linuxprinting.org/ppr-doc.html)</ulink> -or "spooler-less" printing (<ulink +or "spooler-less" printing (<ulink noescape="1" url="http://www.linuxprinting.org/direct-doc.html">http://www.linuxprinting.org/direct-doc.html</ulink> ).</para></listitem> <listitem><para>You can view the PPD in your browser through this -link: <ulink +link: <ulink noescape="1" url="http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=1">http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=1</ulink> </para></listitem> <listitem><para>You can also (most importantly) -generate and download the PPD: <ulink +generate and download the PPD: <ulink noescape="1" url="http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=0">http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=0</ulink> </para></listitem> @@ -4425,7 +4452,7 @@ for the user. Later you'll only need to choose resolution, paper size etc. from the web-based menu, or from the print dialog GUI, or from the commandline.</para></listitem> -<listitem><para>Should you have ended up on the driver's page (<ulink +<listitem><para>Should you have ended up on the driver's page (<ulink noescape="1" url="http://www.linuxprinting.org/show_driver.cgi?driver=ljet4">http://www.linuxprinting.org/show_driver.cgi?driver=ljet4</ulink>), you can choose to use the "PPD-O-Matic" online PPD generator program.</para></listitem> @@ -4461,19 +4488,17 @@ e.g.: </para> <para><screen> - -lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E -P path/to/my-printer.ppd - +&rootprompt;<userinput>lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E -P path/to/my-printer.ppd</userinput> </screen></para></listitem> <listitem><para>Note again this: for all the new-style "Foomatic-PPDs" from Linuxprinting.org, you also need a special "CUPS filter" named -"foomatic-rip".Get the latest version of "foomatic-rip" from: <ulink +"foomatic-rip".Get the latest version of "foomatic-rip" from: <ulink noescape="1" url="http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=0">http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=0</ulink> </para></listitem> <listitem><para>The foomatic-rip Perlscript itself also makes some -interesting reading (<ulink +interesting reading (<ulink noescape="1" url="http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=1">http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=1</ulink>), because it is very well documented by Till's inline comments (even non-Perl hackers will learn quite a bit about printing by reading @@ -4538,6 +4563,8 @@ foomatic-rip).</para></listitem> <sect1> <title>Page Accounting with CUPS</title> + +<indexterm><primary>CUPS</primary><secondary>Page Accounting</secondary></indexterm> <para> Often there are questions regarding "print quotas" wherein Samba users (that is, Windows clients) should not be able to print beyond a @@ -4558,15 +4585,17 @@ period you want. <sect2> <title>Setting up Quotas</title> +<indexterm><primary>CUPS</primary><secondary>quotas</secondary></indexterm> <para> This is an example command how root would set a print quota in CUPS, assuming an existing printer named "quotaprinter": </para> -<para><screen> - - lpadmin -p quotaprinter -o job-quota-period=604800 -o job-k-limit=1024 -o job-page-limit=100 +<indexterm><primary>lpadmin</primary></indexterm> +<para><screen> +&rootprompt;<userinput>lpadmin -p quotaprinter -o job-quota-period=604800 \ + -o job-k-limit=1024 -o job-page-limit=100</userinput> </screen></para> <para> @@ -4596,7 +4625,7 @@ printer is a non-PostScript model, you need to let CUPS do the job to convert the file to a print-ready format for the target printer. This will be working for currently about 1,000 different printer models, see <ulink -url="http://www.linuxprinting.org/printer_list.cgi">http://www.linuxprinting.org/printer_list.cgi</ulink>). + url="http://www.linuxprinting.org/printer_list.cgi">the driver list at linuxprinting.org/</ulink>. </para> </sect2> @@ -4621,6 +4650,7 @@ http://www.cups.org/ as the "cups-samba-1.1.16.tar.gz" package). It does </para> <itemizedlist> +<indexterm><primary>PJL</primary></indexterm> <listitem><para>to not write an PJL-header</para></listitem> @@ -4644,6 +4674,7 @@ current from CUPS 1.1.16). <sect2> <title>The page_log File Syntax</title> +<indexterm><primary>page_log</primary></indexterm> <para> These are the items CUPS logs in the "page_log" for every single <emphasis>page</emphasis> of a job: @@ -4675,13 +4706,11 @@ format and included items: </para> <para><screen> - - infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 1 3 #marketing 10.160.50.13 - infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 2 3 #marketing 10.160.50.13 - infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 3 3 #marketing 10.160.50.13 - infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 4 3 #marketing 10.160.50.13 - DigiMaster9110 boss 402 [22/Apr/2003:10:33:22 +0100] 1 440 finance-dep 10.160.51.33 - +infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 1 3 #marketing 10.160.50.13 +infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 2 3 #marketing 10.160.50.13 +infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 3 3 #marketing 10.160.50.13 +infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 4 3 #marketing 10.160.50.13 +DigiMaster9110 boss 402 [22/Apr/2003:10:33:22 +0100] 1 440 finance-dep 10.160.51.33 </screen></para> <para> @@ -4712,7 +4741,7 @@ of 1000 and the job is aborted by the printer, the "page count" will still show the figure of 1000 for that job</para></listitem> <listitem><para>all quotas are the same for all users (no flexibility -to give the boss a higher quota than the clerk) no support for +to give the boss a higher quota than the clerk), no support for groups</para></listitem> <listitem><para>no means to read out the current balance or the @@ -4788,11 +4817,9 @@ away and re-directs it to go through Ghostscript. CUPS accepts this, because the associated CUPS-O-Matic-/Foomatic-PPD specifies: </para> -<para><screen> - - *cupsFilter: "application/vnd.cups-postscript 0 cupsomatic" - -</screen></para> +<para><programlisting> + *cupsFilter: "application/vnd.cups-postscript 0 cupsomatic" +</programlisting></para> <para> This line persuades CUPS to hand the file to cupsomatic, once it has @@ -4809,12 +4836,10 @@ mechanism. Another workaround in some situations would be to have in <filename>/etc/cups/mime.types</filename> entries as follows: </para> -<para><screen> - - application/postscript application/vnd.cups-raw 0 - - application/vnd.cups-postscript application/vnd.cups-raw 0 - - -</screen></para> +<para><programlisting> + application/postscript application/vnd.cups-raw 0 - + application/vnd.cups-postscript application/vnd.cups-raw 0 - +</programlisting></para> <para> This would prevent all Postscript files from being filtered (rather, @@ -4824,11 +4849,9 @@ want to print PS code on non-PS printers (provided they support ASCII text printing) an entry as follows could be useful: </para> -<para><screen> - - */* application/vnd.cups-raw 0 - - -</screen></para> +<para><programlisting> + */* application/vnd.cups-raw 0 - +</programlisting></para> <para> and would effectively send <emphasis>all</emphasis> files to the @@ -4839,11 +4862,9 @@ backend without further processing. Lastly, you could have the following entry: </para> -<para><screen> - - application/vnd.cups-postscript application/vnd.cups-raw 0 my_PJL_stripping_filter - -</screen></para> +<para><programlisting> +application/vnd.cups-postscript application/vnd.cups-raw 0 my_PJL_stripping_filter +</programlisting></para> <para> You will need to write a <emphasis>my_PJL_stripping_filter</emphasis> @@ -4873,10 +4894,9 @@ requested by marketing for the mailing, etc.). <para> Samba print files pass through two "spool" directories. One is the -incoming directory managed by Samba, (set in the <emphasis>path = -/var/spool/samba</emphasis> directive in the -<emphasis>[printers]</emphasis> section of -<filename>smb.conf</filename>). The other is the spool directory of +incoming directory managed by Samba, (set in the <smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> directive in the +<smbconfsection>[printers]</smbconfsection> section of +&smb.conf;). The other is the spool directory of your UNIX print subsystem. For CUPS it is normally <filename>/var/spool/cups/</filename>, as set by the cupsd.conf directive <filename>RequestRoot /var/spool/cups</filename>. @@ -4938,17 +4958,20 @@ things: <listitem><para>a Samba-smbd which is compiled against "libcups" (Check on Linux by running "ldd `which smbd`")</para></listitem> -<listitem><para>a Samba-<filename>smb.conf</filename> setting of -"printing = cups"</para></listitem> +<listitem><para>a Samba-&smb.conf; setting of + <smbconfoption><name>printing</name><value>cups</value></smbconfoption></para></listitem> -<listitem><para>another Samba-<filename>smb.conf</filename> setting of -"printcap = cups"</para></listitem> +<listitem><para>another Samba-&smb.conf; setting of + <smbconfoption><name>printcap</name><value>cups</value></smbconfoption></para></listitem> </itemizedlist> <note><para> In this case all other manually set printing-related commands (like -"print command", "lpq command", "lprm command", "lppause command" or -"lpresume command") are ignored and they should normally have no +<smbconfoption><name>print command</name></smbconfoption>, +<smbconfoption><name>lpq command</name></smbconfoption>, +<smbconfoption><name>lprm command</name></smbconfoption>, +<smbconfoption><name>lppause command</name></smbconfoption> or +<smbconfoption><name>lpresume command</name></smbconfoption>) are ignored and they should normally have no influence what-so-ever on your printing. </para></note> </sect2> @@ -4957,24 +4980,15 @@ influence what-so-ever on your printing. <title>Manual Configuration</title> <para> -If you want to do things manually, replace the "printing = -cups" by "printing = bsd". Then your manually set commands may work -(haven't tested this), and a "print command = lp -d %P %s; rm %s" +If you want to do things manually, replace the <smbconfoption><name>printing</name><value>cups</value></smbconfoption> +by <smbconfoption><name>printing</name><value>bsd</value></smbconfoption>. Then your manually set commands may work +(haven't tested this), and a <smbconfoption><name>print command</name><value>lp -d %P %s; rm %s"</value></smbconfoption> may do what you need. </para> </sect2> </sect1> <sect1> -<title>When <emphasis>not</emphasis> to use Samba to print to -CUPS</title> - -<para> -[TO BE DONE] -</para> -</sect1> - -<sect1> <title>In Case of Trouble.....</title> <para> @@ -4984,10 +4998,8 @@ relevant to your problem): </para> <para><screen> - - grep -v ^# /etc/cups/cupsd.conf | grep -v ^$ - grep -v ^# /etc/samba/smb.conf | grep -v ^$ | grep -v "^;" - +&prompt;<userinput>grep -v ^# /etc/cups/cupsd.conf | grep -v ^$</userinput> +&prompt;<userinput>grep -v ^# /etc/samba/smb.conf | grep -v ^$ | grep -v "^;"</userinput> </screen></para> <para> @@ -4999,35 +5011,9 @@ for experts (and you are expecting experts to read them, right? ;-) </para> -<sect2> -<title>Where to find Documentation</title> - -<para> -[TO BE DONE] -</para> -</sect2> - -<sect2> -<title>How to ask for Help</title> - -<para> -[TO BE DONE] -</para> -</sect2> - -<sect2> -<title>Where to find Help</title> - -<para> -[TO BE DONE] -</para> -</sect2> </sect1> <sect1> -<title>Appendix</title> - -<sect2> <title>Printing <emphasis>from</emphasis> CUPS to Windows attached Printers</title> @@ -5035,7 +5021,7 @@ Printers</title> From time to time the question arises, how you can print <emphasis>to</emphasis> a Windows attached printer <emphasis>from</emphasis> Samba. Normally the local connection -"Windows host <--> printer" would be done by USB or parallel +from Windows host to printer would be done by USB or parallel cable, but this doesn't matter to Samba. From here only an SMB connection needs to be opened to the Windows host. Of course, this printer must be "shared" first. As you have learned by now, CUPS uses @@ -5049,27 +5035,25 @@ which file must exist and be executable: </para> <para><screen> - - # ls -l /usr/lib/cups/backend/ - total 253 - drwxr-xr-x 3 root root 720 Apr 30 19:04 . - drwxr-xr-x 6 root root 125 Dec 19 17:13 .. - -rwxr-xr-x 1 root root 10692 Feb 16 21:29 canon - -rwxr-xr-x 1 root root 10692 Feb 16 21:29 epson - lrwxrwxrwx 1 root root 3 Apr 17 22:50 http -> ipp - -rwxr-xr-x 1 root root 17316 Apr 17 22:50 ipp - -rwxr-xr-x 1 root root 15420 Apr 20 17:01 lpd - -rwxr-xr-x 1 root root 8656 Apr 20 17:01 parallel - -rwxr-xr-x 1 root root 2162 Mar 31 23:15 pdfdistiller - lrwxrwxrwx 1 root root 25 Apr 30 19:04 ptal -> /usr/local/sbin/ptal-cups - -rwxr-xr-x 1 root root 6284 Apr 20 17:01 scsi - lrwxrwxrwx 1 root root 17 Apr 2 03:11 smb -> /usr/bin/smbspool - -rwxr-xr-x 1 root root 7912 Apr 20 17:01 socket - -rwxr-xr-x 1 root root 9012 Apr 20 17:01 usb - -# ls -l `which smbspool` - -rwxr-xr-x 1 root root 563245 Dec 28 14:49 /usr/bin/smbspool - +&rootprompt;<userinput>ls -l /usr/lib/cups/backend/</userinput> +total 253 +drwxr-xr-x 3 root root 720 Apr 30 19:04 . +drwxr-xr-x 6 root root 125 Dec 19 17:13 .. +-rwxr-xr-x 1 root root 10692 Feb 16 21:29 canon +-rwxr-xr-x 1 root root 10692 Feb 16 21:29 epson +lrwxrwxrwx 1 root root 3 Apr 17 22:50 http -> ipp +-rwxr-xr-x 1 root root 17316 Apr 17 22:50 ipp +-rwxr-xr-x 1 root root 15420 Apr 20 17:01 lpd +-rwxr-xr-x 1 root root 8656 Apr 20 17:01 parallel +-rwxr-xr-x 1 root root 2162 Mar 31 23:15 pdfdistiller +lrwxrwxrwx 1 root root 25 Apr 30 19:04 ptal -> /usr/sbin/ptal-cups +-rwxr-xr-x 1 root root 6284 Apr 20 17:01 scsi +lrwxrwxrwx 1 root root 17 Apr 2 03:11 smb -> /usr/bin/smbspool +-rwxr-xr-x 1 root root 7912 Apr 20 17:01 socket +-rwxr-xr-x 1 root root 9012 Apr 20 17:01 usb + +&rootprompt;<userinput>ls -l `which smbspool`</userinput> +-rwxr-xr-x 1 root root 563245 Dec 28 14:49 /usr/bin/smbspool </screen></para> <para> @@ -5077,9 +5061,7 @@ If this symlink doesn't exist, create it: </para> <para><screen> - -# ln -s `which smbspool` /usr/lib/cups/backend/smb - +&rootprompt;<userinput>ln -s `which smbspool` /usr/lib/cups/backend/smb</userinput> </screen></para> <para> @@ -5102,9 +5084,8 @@ To install a printer with the smb backend on CUPS, use this command: </para> <para><screen> - -# lpadmin -p winprinter -v smb://WINDOWSNETBIOSNAME/printersharename -P /path/to/PPD - +&rootprompt;<userinput>lpadmin -p winprinter -v smb://WINDOWSNETBIOSNAME/printersharename \ + -P /path/to/PPD</userinput> </screen></para> <para> @@ -5117,13 +5098,11 @@ for: you can include the required parameters as part of the <filename>smb://</filename> device-URI. Like this: </para> -<para><screen> - - smb://WORKGROUP/WINDOWSNETBIOSNAME/printersharename - smb://username:password@WORKGROUP/WINDOWSNETBIOSNAME/printersharename - smb://username:password@WINDOWSNETBIOSNAME/printersharename - -</screen></para> +<itemizedlist> + <listitem><para>smb://WORKGROUP/WINDOWSNETBIOSNAME/printersharename </para></listitem> + <listitem><para>smb://username:password@WORKGROUP/WINDOWSNETBIOSNAME/printersharename</para></listitem> + <listitem><para>smb://username:password@WINDOWSNETBIOSNAME/printersharename</para></listitem> +</itemizedlist> <para> Note that the device-URI will be visible in the process list of the @@ -5137,121 +5116,26 @@ working netbios name resolution up and running. Note that this is a feature of CUPS and you don't necessarily need to have smbd running (but who wants that? :-). </para> -</sect2> +</sect1> -<sect2> +<sect1> <title>More CUPS filtering Chains</title> <para> The following diagrams reveal how CUPS handles print jobs. </para> -<screen> -######################################################################### -# -# CUPS in and of itself has this (general) filter chain (CAPITAL -# letters are FILE-FORMATS or MIME types, other are filters (this is -# true for pre-1.1.15 of pre-4.3 versions of CUPS and ESP PrintPro): -# -# SOMETHNG-FILEFORMAT -# | -# V -# somethingtops -# | -# V -# APPLICATION/POSTSCRIPT -# | -# V -# pstops -# | -# V -# APPLICATION/VND.CUPS-POSTSCRIPT -# | -# V -# pstoraster # as shipped with CUPS, independent from any Ghostscipt -# | # installation on the system -# | (= "postscipt interpreter") -# V -# APPLICATION/VND.CUPS-RASTER -# | -# V -# rastertosomething (e.g. Gimp-Print filters may be plugged in here) -# | (= "raster driver") -# V -# SOMETHING-DEVICE-SPECIFIC -# | -# V -# backend -# -# -# ESP PrintPro has some enhanced "rastertosomething" filters as compared to -# CUPS, and also a somewhat improved "pstoraster" filter. -# -# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to -# CUPS and ESP PrintPro plug-in where rastertosomething is noted. -# -######################################################################### -</screen> +<image><imagefile>cups1</imagefile><imagedescription>Filtering chain 1</imagedescription></image> -<screen> -######################################################################### -# -# This is how "cupsomatic" comes into play: -# ========================================= -# -# SOMETHNG-FILEFORMAT -# | -# V -# somethingtops -# | -# V -# APPLICATION/POSTSCRIPT -# | -# V -# pstops -# | -# V -# APPLICATION/VND.CUPS-POSTSCRIPT ----------------+ -# | V -# V cupsomatic -# pstoraster (constructs complicated -# | (= "postscipt interpreter") Ghostscript commandline -# | to let the file be -# V processed by a -# APPLICATION/VND.CUPS-RASTER "-sDEVICE=s.th." -# | call...) -# V | -# rastertosomething V -# | (= "raster driver") +-------------------------+ -# | | Ghostscript at work.... | -# V | | -# SOMETHING-DEVICE-SPECIFIC *-------------------------+ -# | | -# V | -# backend <------------------------------------+ -# | -# V -# THE PRINTER -# -# -# Note, that cupsomatic "kidnaps" the printfile after the -# "APPLICATION/VND.CUPS-POSTSCRPT" stage and deviates it gh -# the CUPS-external, systemwide Ghostscript installation, bypassing the -# "pstoraster" filter (therefore also bypassing the CUPS-raster-drivers -# "rastertosomething", and hands the rasterized file directly to the CUPS -# backend... -# -# cupsomatic is not made by the CUPS developers. It is an independent -# contribution to printing development, made by people from -# Linuxprinting.org. (see also http://www.cups.org/cups-help.html) -# -# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to -# CUPS and ESP PrintPro plug-in where rastertosomething is noted. -# -######################################################################### -</screen> +<image><imagefile>cups2</imagefile><imagedescription>Filtering chain with cupsomatic</imagedescription></image> + +<note><para> +Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to +CUPS and ESP PrintPro plug-in where rastertosomething is noted. +</para></note> + +<!--FIXME: Put this into diagrams... ? -<screen> ######################################################################### # # And this is how it works for ESP PrintPro from 4.3: @@ -5311,7 +5195,7 @@ The following diagrams reveal how CUPS handles print jobs. # pstops # | # V -# APPLICATION/VND.CUPS-POSTSCRIPT ----------------+ +# APPLICATION/VND.CUPS-POSTSCRIPT ================+ # | V # V cupsomatic # gsrip (constructs complicated @@ -5322,13 +5206,13 @@ The following diagrams reveal how CUPS handles print jobs. # | call...) # V | # rastertosomething V -# | (= "raster driver") +-------------------------+ +# | (= "raster driver") +=========================+ # | | Ghostscript at work.... | # V | | -# SOMETHING-DEVICE-SPECIFIC *-------------------------+ +# SOMETHING-DEVICE-SPECIFIC *=========================+ # | | # V | -# backend <------------------------------------+ +# backend <=================================+ # | # V # THE PRINTER @@ -5357,8 +5241,8 @@ The following diagrams reveal how CUPS handles print jobs. # pstops # | # V -# APPLICATION/VND.CUPS-POSTSCRIPT-----+ -# +------------------v------------------------------+ +# APPLICATION/VND.CUPS-POSTSCRIPT=====+ +# +==================v==============================+ # | Ghostscript | # | at work... | # | (with | @@ -5366,9 +5250,9 @@ The following diagrams reveal how CUPS handles print jobs. # | | # | (= "postscipt interpreter") | # | | -# +------------------v------------------------------+ +# +==================v==============================+ # | -# APPLICATION/VND.CUPS-RASTER >-------+ +# APPLICATION/VND.CUPS-RASTER >====+ # | # V # rastertosomething @@ -5416,8 +5300,8 @@ The following diagrams reveal how CUPS handles print jobs. # pstops # | # V -# APPLICATION/VND.CUPS-POSTSCRIPT-----+ -# +------------------v------------------------------+ +# APPLICATION/VND.CUPS-POSTSCRIPT=====+ +# +==================v==============================+ # | Ghostscript . Ghostscript at work.... | # | at work... . (with "-sDEVICE= | # | (with . s.th." | @@ -5427,15 +5311,15 @@ The following diagrams reveal how CUPS handles print jobs. # | . | # | (= "postscript interpreter") | # | . | -# +------------------v--------------v---------------+ +# +==================v==============v===============+ # | | -# APPLICATION/VND.CUPS-RASTER >-------+ | +# APPLICATION/VND.CUPS-RASTER >=======+ | # | | # V | # rastertosomething | # | (= "raster driver") | # V | -# SOMETHING-DEVICE-SPECIFIC >------------------------+ +# SOMETHING-DEVICE-SPECIFIC >========================+ # | # V # backend @@ -5445,76 +5329,72 @@ The following diagrams reveal how CUPS handles print jobs. # CUPS and ESP PrintPro plug-in where rastertosomething is noted. # ########################################################################## -</screen> -</sect2> +</screen>--> +</sect1> -<sect2> -<title>Trouble Shooting Guidelines to fix typical Samba printing -Problems</title> +<sect1> + <title>Common Errors</title> -<para> -This is a short description of how to debug printing problems -with Samba. This describes how to debug problems with printing from -a SMB client to a Samba server, not the other way around. -</para> + <sect2> + <title>Win9x client can't install driver</title> -<variablelist> -<varlistentry><term>Win9x client can't install driver</term> -<listitem><para>For Win9x clients require the printer names to be 8 + <para>For Win9x clients require the printer names to be 8 chars (or "8 plus 3 chars suffix") max; otherwise the driver files won't get transferred when you want to download them from -Samba.</para></listitem></varlistentry> - -<varlistentry><term>testparm</term> -<listitem><para>Run <command>testparm</command>: It will tell you if -<filename>smb.conf</filename> parameters are in the wrong -section. Many people have had the "printer admin" parameter in the -<parameter>[printers]</parameter> section and experienced -problems. "testparm" will tell you if it sees -this.</para></listitem></varlistentry> - -<varlistentry><term>"cupsaddsmb" keeps asking for a root password in a -neverending loop</term> -<listitem><para>Have you <parameter>security = user</parameter>? Have +Samba.</para> + + </sect2> + + <sect2> + <title>"cupsaddsmb" keeps asking for root password in + neverending loop</title> + + <para>Have you <smbconfoption><name>security</name><value>user</value></smbconfoption>? Have you used <command>smbpasswd</command> to give root a Samba account? You can do 2 things: open another terminal and execute <command>smbpasswd -a root</command> to create the account, and continue with entering the password into the first terminal. Or break out of the loop by hitting ENTER twice (without trying to type a -password).</para></listitem></varlistentry> +password).</para> -<varlistentry><term>"cupsaddsmb" gives "No PPD file for printer..." -message (but I swear there is one!)</term> + </sect2> -<listitem> -<itemizedlist> -<listitem><para>Have you enabled printer sharing on CUPS? This means: + <sect2> + <title>"cupsaddsmb" gives "No PPD file for printer..." + message while PPD file is present</title> + + <para>Have you enabled printer sharing on CUPS? This means: do you have a <parameter><Location /printers>....</Location></parameter> section in CUPS server's <filename>cupsd.conf</filename> which doesn't deny access to the host you run "cupsaddsmb" from? It <emphasis>could</emphasis> be an issue if you use cupsaddsmb remotely, or if you use it with a -<parameter>-h</parameter> parameter: <command>cupsaddsmb -H -sambaserver -h cupsserver -v printername</command>. -</para></listitem> -<listitem><para>Is your +<option>-h</option> parameter: <userinput>cupsaddsmb -H + sambaserver -h cupsserver -v printername</userinput>. +</para> +<para>Is your "TempDir" directive in <emphasis>cupsd.conf</emphasis> set to a valid value and is it writeable? -</para></listitem></itemizedlist> -</listitem></varlistentry> +</para> -<varlistentry><term>I can't connect client to Samba printer.</term> -<listitem><para>Use <command>smbstatus</command> to check which user + </sect2> + + <sect2> + <title>Client can't connect to Samba printer</title> + <para>Use <command>smbstatus</command> to check which user you are from Samba's point of view. Do you have the privileges to -write into the <parameter>[print$]</parameter> -share?</para></listitem></varlistentry> - -<varlistentry><term>I can't reconnect to Samba under a new account -from Win2K/XP</term> -<listitem><para>Once you are connected as the "wrong" user (for -example as "nobody", which often occurs if you have <parameter>map to -guest = bad user</parameter>), Windows Explorer will not accept an +write into the <smbconfsection>[print$]</smbconfsection> +share?</para> + + </sect2> + + <sect2> + <title>Can't reconnect to Samba under new account + from Win2K/XP</title> + <para>Once you are connected as the "wrong" user (for +example as "nobody", which often occurs if you have +<smbconfoption><name>map to guest</name><value>bad user</value></smbconfoption>), Windows Explorer will not accept an attempt to connect again as a different user. There won't be any byte transfered on the wire to Samba, but still you'll see a stupid error message which makes you think that Samba has denied access. Use @@ -5527,89 +5407,90 @@ indicating a renewed connection attempt? Shut all Explorer Windows. This makes Windows forget what it has cached in its memory as established connections. Then re-connect as the right user. Best method is to use a DOS terminal window and <emphasis>first</emphasis> -do <command>net use z: \\SAMBAHOST\print$ /user:root</command>. Check +do <userinput>net use z: \\&example.server.samba;\print$ /user:root</userinput>. Check with <command>smbstatus</command> that you are connected under a different account. Now open the "Printers" folder (on the Samba server in the <emphasis>Network Neighbourhood</emphasis>), right-click the printer in question and select -<emphasis>Connect...</emphasis></para></listitem></varlistentry> +<emphasis>Connect...</emphasis></para></sect2> -<varlistentry><term>Avoid being connected to the Samba server as the -"wrong" user</term> -<listitem><para>You see per <command>smbstatus</command> that you are +<sect2> + <title>Avoid being connected to the Samba server as the + "wrong" user</title> + + <para>You see per <command>smbstatus</command> that you are connected as user "nobody"; while you wanted to be "root" or -"printeradmin"? This is probably due to <parameter>map to guest = bad -user</parameter>, which silently connects you under the guest account, +"printeradmin"? This is probably due to +<smbconfoption><name>map to guest</name><value>bad user</value></smbconfoption>, which silently connects you under the guest account, when you gave (maybe by accident) an incorrect username. Remove -<parameter>map to guest</parameter>, if you want to prevent -this.</para></listitem></varlistentry> +<smbconfoption><name>map to guest</name></smbconfoption>, if you want to prevent +this.</para></sect2> + +<sect2><title>Upgrading to CUPS drivers from Adobe drivers on + NT/2K/XP clients gives problems</title> -<varlistentry><term>Upgrading to CUPS drivers from Adobe drivers on -NT/2K/XP clients gives problems</term> -<listitem><para>First delete all "old" Adobe-using printers. Then + <para>First delete all "old" Adobe-using printers. Then delete all "old" Adobe drivers. (On Win2K/XP, right-click in background of "Printers" folder, select "Server Properties...", select -tab "Drivers" and delete here).</para></listitem></varlistentry> - -<varlistentry><term>I can't use "cupsaddsmb"on a Samba server which is -a PDC</term> -<listitem><para>Do you use the "naked" root user name? Try to do it -this way: <emphasis>cupsaddsmb -U DOMAINNAME\\root -v -printername</emphasis> (note the two backslashes: the first one is -required to "escape" the second one).</para></listitem></varlistentry> - -<varlistentry><term>I deleted a printer on Win2K; but I still see -its driver</term> -<listitem><para>Deleting a printer on the client won't delete the +tab "Drivers" and delete here).</para></sect2> + +<sect2><title>Can't use "cupsaddsmb" on Samba server which is + a PDC</title> +<para>Do you use the "naked" root user name? Try to do it +this way: <userinput>cupsaddsmb -U <replaceable>DOMAINNAME</replaceable>\\root -v +<replaceable>printername</replaceable></userinput>> (note the two backslashes: the first one is +required to "escape" the second one).</para></sect2> + +<sect2><title>Deleted Win2K printer driver is still shown</title> +<para>Deleting a printer on the client won't delete the driver too (to verify, right-click on the white background of the "Printers" folder, select "Server Properties" and click on the "Drivers" tab). These same old drivers will be re-used when you try to install a printer with the same name. If you want to update to a new driver, delete the old ones first. Deletion is only possible if no -other printer uses the same driver.</para></listitem></varlistentry> +other printer uses the same driver.</para></sect2> -<varlistentry><term>Win2K/XP "Local Security -Policies"</term> -<listitem><para><emphasis>Local Security Policies</emphasis> may not +<sect2><title>Win2K/XP "Local Security + Policies"</title> +<para><emphasis>Local Security Policies</emphasis> may not allow the installation of unsigned drivers. "Local Security Policies" may not allow the installation of printer drivers at -all.</para></listitem></varlistentry> +all.</para></sect2> -<varlistentry><term>WinXP clients: "Administrator can not install -printers for all local users"</term> -<listitem><para>Windows XP handles SMB printers on a "per-user" basis. +<sect2><title>WinXP clients: "Administrator can not install + printers for all local users"</title> +<para>Windows XP handles SMB printers on a "per-user" basis. This means every user needs to install the printer himself. To have a printer available for everybody, you might want to use the built-in IPP client capabilities of WinXP. Add a printer with the print path of <emphasis>http://cupsserver:631/printers/printername</emphasis>. Still looking into this one: maybe a "logon script" could automatically install printers for all -users.</para></listitem></varlistentry> +users.</para></sect2> -<varlistentry><term>"Print Change Notify" functions on -NT-clients</term> -<listitem><para>For "print change notify" functions on NT++ clients, +<sect2><title>"Print Change Notify" functions on + NT-clients</title> +<para>For "print change notify" functions on NT++ clients, these need to run the "Server" service first (re-named to <emphasis>File & Print Sharing for MS Networks</emphasis> in -XP).</para></listitem></varlistentry> +XP).</para></sect2> -<varlistentry><term>WinXP-SP1</term> -<listitem><para>WinXP-SP1 introduced a <emphasis>Point and Print +<sect2><title>WinXP-SP1</title> +<para>WinXP-SP1 introduced a <emphasis>Point and Print Restriction Policy</emphasis> (this restriction doesn't apply to "Administrator" or "Power User" groups of users). In Group Policy -Object Editor: go to <emphasis>User Configuration --> -Administrative Templates --> Control Panel --> +Object Editor: go to <emphasis>User Configuration, + Administrative Templates, Control Panel, Printers</emphasis>. The policy is automatically set to <emphasis>Enabled</emphasis> and the <emphasis>Users can only Point and Print to machines in their Forest</emphasis> . You probably need to change it to <emphasis>Disabled</emphasis> or <emphasis>Users can only Point and Print to these servers</emphasis> in order to make -driver downloads from Samba possible.</para></listitem></varlistentry> +driver downloads from Samba possible.</para></sect2> -<varlistentry><term>I can't set and save default print options for all -users on Win2K/XP</term> +<sect2><title>Print options for all users can't be set on Win2K/XP</title> -<listitem><para>How are you doing it? I bet the wrong way (it is not +<para>How are you doing it? I bet the wrong way (it is not very easy to find out, though). There are 3 different ways to bring you to a dialog that <emphasis>seems</emphasis> to set everything. All three dialogs <emphasis>look</emphasis> the same. Only one of them @@ -5687,16 +5568,16 @@ Do you see any difference? I don't either... However, only the last one, which you arrived at with steps "C.1.-6." will save any settings permanently and be the defaults for new users. If you want all clients to get the same defaults, you need to conduct these steps <emphasis>as -Administrator</emphasis> (<parameter>printer admin</parameter> in -<filename>smb.conf</filename>) <emphasis>before</emphasis> a client +Administrator</emphasis> (<smbconfoption><name>printer admin</name></smbconfoption> in +&smb.conf;) <emphasis>before</emphasis> a client downloads the driver (the clients can later set their own <emphasis>per-user defaults</emphasis> by following the procedures <emphasis>A.</emphasis> or <emphasis>B.</emphasis> -above).</para></listitem></varlistentry> +above).</para></sect2> -<varlistentry><term>What are the most common blunders in driver -settings on Windows clients?</term> -<listitem><para>Don't use <emphasis>Optimize for +<sect2><title>Most common blunders in driver + settings on Windows clients</title> + <para>Don't use <emphasis>Optimize for Speed</emphasis>: use <emphasis>Optimize for Portability</emphasis> instead (Adobe PS Driver) Don't use <emphasis>Page Independence: No</emphasis>: always @@ -5708,11 +5589,11 @@ printer</emphasis> (Adobe PS Driver). For <emphasis>TrueType Download Options</emphasis> choose <emphasis>Outline</emphasis>. Use PostScript Level 2, if you are having trouble with a non-PS printer, and if -there is a choice.</para></listitem></varlistentry> +there is a choice.</para></sect2> -<varlistentry><term>I can't make <command>cupsaddsmb</command> work -with newly installed printer</term> -<listitem><para>Symptom: the last command of +<sect2><title><command>cupsaddsmb</command> does not work + with newly installed printer</title> +<para>Symptom: the last command of <command>cupsaddsmb</command> doesn't complete successfully: <command>cmd = setdriver printername printername</command> result was NT_STATUS_UNSUCCESSFUL then possibly the printer was not yet @@ -5721,29 +5602,29 @@ Neighbourhood</emphasis>? Did it show up in <command>rpcclient hostname -c 'enumprinters'</command>? Restart smbd (or send a <command>kill -HUP</command> to all processes listed by <command>smbstatus</command> and try -again.</para></listitem></varlistentry> +again.</para></sect2> -<varlistentry><term>My permissions on +<sect2><title>Permissions on <filename>/var/spool/samba/</filename> get reset after each -reboot</term> -<listitem><para>Have you by accident set the CUPS spool directory to +reboot</title> +<para>Have you by accident set the CUPS spool directory to the same location? (<parameter>RequestRoot /var/spool/samba/</parameter> in <filename>cupsd.conf</filename> or the other way round: <filename>/var/spool/cups/</filename> is set as -<parameter>path</parameter> in the <parameter>[printers]</parameter> +<smbconfoption><name>path</name></smbconfoption>> in the <smbconfsection>[printers]</smbconfsection> section). These <emphasis>must</emphasis> be different. Set <parameter>RequestRoot /var/spool/cups/</parameter> in -<filename>cupsd.conf</filename> and <parameter>path = -/var/spool/samba</parameter> in the <parameter>[printers]</parameter> -section of <filename>smb.conf</filename>. Otherwise cupsd will +<filename>cupsd.conf</filename> and <smbconfoption><name>path</name><value> +/var/spool/samba</value></smbconfoption> in the <smbconfsection>[printers]</smbconfsection> +section of &smb.conf;. Otherwise cupsd will sanitize permissions to its spool directory with each restart, and -printing will not work reliably.</para></listitem></varlistentry> +printing will not work reliably.</para></sect2> -<varlistentry><term>My printers work fine: just the printer named "lp" +<sect2><title>Printer named "lp" intermittently swallows jobs and spits out completely different -ones</term> -<listitem><para>It is a very bad idea to name any printer "lp". This -is the traditional Unix name for the default printer. CUPS may be set +ones</title> +<para>It is a very bad idea to name any printer "lp". This +is the traditional UNIX name for the default printer. CUPS may be set up to do an automatic creation of "Implicit Classes". This means, to group all printers with the same name to a pool of devices, and loadbalancing the jobs across them in a round-robin fashion. Chances @@ -5752,56 +5633,25 @@ receive his jobs and send your own to his device unwittingly. To have tight control over the printer names, set <parameter>BrowseShortNames No</parameter>. It will present any printer as "printername@cupshost" then, giving you a better control over what may happen in a large -networked environment.</para></listitem></varlistentry> - -<varlistentry><term>How do I "watch" my Samba server?</term> -<listitem><para>You can use <command>tail -f -/var/log/samba/log.smbd</command> (you may need a different path) to -see a live scrolling of all log messages. <command>smbcontrol smbd -debuglevel</command> tells you which verbosity goes into the -logs. <command>smbcontrol smbd debug 3</command> sets the verbosity to -a quite high level (you can choose from 0 to 10 or 100). This works -"on the fly", without the need to restart the smbd daemon. Don't use -more than 3 initially; or you'll drown in an ocean of -messages.</para></listitem></varlistentry> - -<varlistentry><term>I can't use Samba from my WinXP Home box, while -access from WinXP Prof works flawlessly</term> -<listitem><para>You have our condolences! WinXP home has been -completely neutered by Microsoft as compared to WinXP Prof: you can -not log into a WinNT domain. It cannot join a Win NT domain as a -member server. While it is possible to access domain resources, users -don't have "single sign-on". They need to supply username and password -each time they connect to a resource. Logon scripts and roaming -profiles are not supported. It can serve file and print shares; but -only in "share-mode security" level. It can not use "user-mode -security" (what Windows 95/98/ME still can -do).</para></listitem></varlistentry> - -<varlistentry><term>Where do I find the Adobe PostScript driver files -I need for "cupsaddsmb"?</term> -<listitem><para>Use <command>smbclient</command> to connect to any +networked environment.</para></sect2> + +<sect2><title>Location of Adobe PostScript driver files necessary for "cupsaddsmb"</title> +<para>Use <command>smbclient</command> to connect to any Windows box with a shared PostScript printer: <command>smbclient //windowsbox/print\$ -U guest</command>. You can navigate to the <filename>W32X86/2</filename> subdir to <command>mget ADOBE*</command> and other files or to <filename>WIN40/0</filename> to do the same. -- Another option is to download the <filename>*.exe</filename> packaged -files from the Adobe website.</para></listitem></varlistentry> -</variablelist> -</sect2> +files from the Adobe website.</para></sect2> -<sect2> +</sect1> + +<sect1> <title>An Overview of the CUPS Printing Processes</title> -<para> -<figure><title>CUPS Printing Overview</title> -<mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/a_small"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/a_small.png"/></imageobject> -</mediaobject> -</figure> -</para> -</sect2> +<image><imagedescription>CUPS Printing Overview</imagedescription> + <imagefile>a_small</imagefile> +</image> </sect1> </chapter> diff --git a/docs/docbook/projdoc/Compiling.xml b/docs/docbook/projdoc/Compiling.xml index 279be2fdb4..ccb2f46f3f 100644 --- a/docs/docbook/projdoc/Compiling.xml +++ b/docs/docbook/projdoc/Compiling.xml @@ -1,13 +1,13 @@ <chapter id="compiling"> <chapterinfo> &author.jelmer; - <author><surname>Someone; Jerry perhaps?</surname></author> + &author.tridge; <pubdate> 22 May 2001 </pubdate> <pubdate> 18 March 2003 </pubdate> </chapterinfo> -<title>How to compile SAMBA</title> +<title>How to compile Samba</title> <para> You can obtain the samba source from the @@ -18,6 +18,8 @@ you can download samba from CVS or using rsync. <sect1> <title>Access Samba source code via CVS</title> +<indexterm><primary>CVS</primary></indexterm> + <sect2> <title>Introduction</title> @@ -31,7 +33,7 @@ detailed in this chapter. <para> This chapter is a modified version of the instructions found at -<ulink url="http://samba.org/samba/cvs.html">http://samba.org/samba/cvs.html</ulink> +<ulink noescape="1" url="http://samba.org/samba/cvs.html">http://samba.org/samba/cvs.html</ulink> </para> </sect2> @@ -49,6 +51,8 @@ of accessing the CVS server on this host. <sect3> <title>Access via CVSweb</title> +<indexterm><primary>CVS</primary><secondary>web</secondary></indexterm> + <para> You can access the source code via your favourite WWW browser. This allows you to access the contents of @@ -59,7 +63,7 @@ listing between any two versions on the repository. <para> Use the URL : <ulink -url="http://samba.org/cgi-bin/cvsweb">http://samba.org/cgi-bin/cvsweb</ulink> +noescape="1" url="http://samba.org/cgi-bin/cvsweb">http://samba.org/cgi-bin/cvsweb</ulink> </para> </sect3> @@ -78,7 +82,7 @@ just a casual browser. <para> To download the latest cvs source code, point your browser at the URL : -<ulink url="http://www.cyclic.com/">http://www.cyclic.com/</ulink>. +<ulink noescape="1" url="http://www.cyclic.com/">http://www.cyclic.com/</ulink>. and click on the 'How to get cvs' link. CVS is free software under the GNU GPL (as is Samba). Note that there are several graphical CVS clients which provide a graphical interface to the sometimes mundane CVS commands. @@ -167,11 +171,14 @@ on this system just substitute the correct package name <sect1> <title>Accessing the samba sources via rsync and ftp</title> + <indexterm><primary>rsync</primary></indexterm> + <indexterm><primary>ftp</primary></indexterm> + <para> pserver.samba.org also exports unpacked copies of most parts of the CVS - tree at <ulink url="ftp://pserver.samba.org/pub/unpacked">ftp://pserver.samba.org/pub/unpacked</ulink> and also via anonymous rsync at - <ulink url="rsync://pserver.samba.org/ftp/unpacked/">rsync://pserver.samba.org/ftp/unpacked/</ulink>. I recommend using rsync rather than ftp. - See <ulink url="http://rsync.samba.org/">the rsync homepage</ulink> for more info on rsync. + tree at <ulink noescape="1" url="ftp://pserver.samba.org/pub/unpacked">ftp://pserver.samba.org/pub/unpacked</ulink> and also via anonymous rsync at + <ulink noescape="1" url="rsync://pserver.samba.org/ftp/unpacked/">rsync://pserver.samba.org/ftp/unpacked/</ulink>. I recommend using rsync rather than ftp. + See <ulink noescape="1" url="http://rsync.samba.org/">the rsync homepage</ulink> for more info on rsync. </para> <para> @@ -197,17 +204,19 @@ With that said, go ahead and download the following files: </para> <para><screen> -<prompt>$ </prompt><userinput> wget http://us1.samba.org/samba/ftp/samba-2.2.8a.tar.asc</userinput> -<prompt>$ </prompt><userinput> wget http://us1.samba.org/samba/ftp/samba-pubkey.asc</userinput> +&prompt;<userinput>wget http://us1.samba.org/samba/ftp/samba-2.2.8a.tar.asc</userinput> +&prompt;<userinput>wget http://us1.samba.org/samba/ftp/samba-pubkey.asc</userinput> </screen></para> + <para> +<indexterm><primary>GPG</primary></indexterm> The first file is the PGP signature for the Samba source file; the other is the Samba public PGP key itself. Import the public PGP key with: </para> <screen> - <prompt>$ </prompt><userinput>gpg --import samba-pubkey.asc</userinput> +&prompt;<userinput>gpg --import samba-pubkey.asc</userinput> </screen> <para> @@ -215,8 +224,8 @@ And verify the Samba source code integrity with: </para> <screen> - <prompt>$ </prompt><userinput>gzip -d samba-2.2.8a.tar.gz</userinput> - <prompt>$ </prompt><userinput>gpg --verify samba-2.2.8a.tar.asc</userinput> +&prompt;<userinput>gzip -d samba-2.2.8a.tar.gz</userinput> +&prompt;<userinput>gpg --verify samba-2.2.8a.tar.asc</userinput> </screen> <para> @@ -226,51 +235,58 @@ then all is well. The warnings about trust relationships can be ignored. An example of what you would not want to see would be: </para> +<para> <computeroutput> gpg: BAD signature from "Samba Distribution Verification Key" -</computeroutput> + </computeroutput> + </para> </sect1> <sect1> <title>Building the Binaries</title> - <para>To do this, first run the program <userinput>./configure +<indexterm><primary>configure</primary></indexterm> + + <para> + To do this, first run the program <userinput>./configure </userinput> in the source directory. This should automatically configure Samba for your operating system. If you have unusual needs then you may wish to run</para> - <para>&rootprompt;<userinput>./configure --help - </userinput></para> +<para><screen>&rootprompt;<userinput>./configure --help +</userinput></screen></para> <para>first to see what special options you can enable. Then executing</para> + +<indexterm><primary>make</primary></indexterm> - <para>&rootprompt;<userinput>make</userinput></para> +<para><screen>&rootprompt;<userinput>make</userinput></screen></para> <para>will create the binaries. Once it's successfully compiled you can use </para> - <para>&rootprompt;<userinput>make install</userinput></para> +<para><screen>&rootprompt;<userinput>make install</userinput></screen></para> <para>to install the binaries and manual pages. You can separately install the binaries and/or man pages using</para> - <para>&rootprompt;<userinput>make installbin - </userinput></para> +<para><screen>&rootprompt;<userinput>make installbin +</userinput></screen></para> <para>and</para> - <para>&rootprompt;<userinput>make installman - </userinput></para> + <para><screen>&rootprompt;<userinput>make installman + </userinput></screen></para> <para>Note that if you are upgrading for a previous version of Samba you might like to know that the old versions of the binaries will be renamed with a ".old" extension. You can go back to the previous version with</para> - <para>&rootprompt;<userinput>make revert - </userinput></para> +<para><screen>&rootprompt;<userinput>make revert +</userinput></screen></para> <para>if you find this version a disaster!</para> @@ -311,10 +327,10 @@ example of what you would not want to see would be: <para>On Debian you need to install the following packages:</para> <para> - <simplelist> - <member>libkrb5-dev</member> - <member>krb5-user</member> - </simplelist> + <itemizedlist> + <listitem><para>libkrb5-dev</para></listitem> + <listitem><para>krb5-user</para></listitem> + </itemizedlist> </para> </sect3> @@ -323,11 +339,11 @@ example of what you would not want to see would be: <para>On RedHat this means you should have at least: </para> <para> - <simplelist> - <member>krb5-workstation (for kinit)</member> - <member>krb5-libs (for linking with)</member> - <member>krb5-devel (because you are compiling from source)</member> - </simplelist> + <itemizedlist> + <listitem><para>krb5-workstation (for kinit)</para></listitem> + <listitem><para>krb5-libs (for linking with)</para></listitem> + <listitem><para>krb5-devel (because you are compiling from source)</para></listitem> + </itemizedlist> </para> <para>in addition to the standard development environment.</para> @@ -344,11 +360,14 @@ example of what you would not want to see would be: <sect1> <title>Starting the &smbd; and &nmbd;</title> + <indexterm><primary>inetd</primary></indexterm> + <para>You must choose to start &smbd; and &nmbd; either as daemons or from <application>inetd</application>. Don't try to do both! Either you can put them in <filename> inetd.conf</filename> and have them started on demand - by <application>inetd</application>, or you can start them as + by <application>inetd</application> or <application>xinetd</application>, + or you can start them as daemons either from the command line or in <filename> /etc/rc.local</filename>. See the man pages for details on the command line options. Take particular care to read @@ -363,6 +382,8 @@ example of what you would not want to see would be: <sect2> <title>Starting from inetd.conf</title> + <indexterm><primary>inetd</primary></indexterm> + <note> <para>The following will be different if you use NIS, NIS+ or LDAP to distribute services maps.</para> @@ -388,7 +409,11 @@ example of what you would not want to see would be: <para>The exact syntax of <filename>/etc/inetd.conf</filename> varies between unixes. Look at the other entries in inetd.conf - for a guide.</para> + for a guide. </para> + + <indexterm><primary>xinetd</primary></indexterm> + <para>Some distributions use xinetd instead of inetd. Consult the + xinetd manual for configuration information.</para> <note><para>Some unixes already have entries like netbios_ns (note the underscore) in <filename>/etc/services</filename>. @@ -396,8 +421,9 @@ example of what you would not want to see would be: <filename>/etc/inetd.conf</filename> to make them consistent. </para></note> + <indexterm><primary>ifconfig</primary></indexterm> <note><para>On many systems you may need to use the - <parameter>interfaces</parameter> option in &smb.conf; to specify the IP + <smbconfoption><name>interfaces</name></smbconfoption> option in &smb.conf; to specify the IP address and netmask of your interfaces. Run <application>ifconfig</application> as root if you don't know what the broadcast is for your @@ -412,13 +438,19 @@ example of what you would not want to see would be: from <command>inetd</command>.</para></warning> <para>Restart <application>inetd</application>, perhaps just send - it a HUP. If you have installed an earlier version of &nmbd; then - you may need to kill &nmbd; as well.</para> + it a HUP. </para> + + <screen> + &rootprompt;<userinput>killall -HUP inetd</userinput> + </screen> + </sect2> <sect2> <title>Alternative: starting it as a daemon</title> + <indexterm><primary>daemon</primary></indexterm> + <para>To start the server as a daemon you should create a script something like this one, perhaps calling it <filename>startsmb</filename>.</para> @@ -445,21 +477,4 @@ example of what you would not want to see would be: </sect2> </sect1> -<sect1> -<title>Common Errors</title> - -<para><quote> -I'm using gcc 3 and I've compiled Samba-3 from the CVS and the -binaries are very large files (40 Mb and 20 Mb). I've the same result with -<option>--enable-shared</option> ? -</quote> -</para> - -<para> -The dwarf format used by GCC 3 for storing debugging symbols is very inefficient. -Strip the binaries, don't compile with -g or compile with -gstabs. -</para> - -</sect1> - </chapter> diff --git a/docs/docbook/projdoc/DOMAIN_MEMBER.xml b/docs/docbook/projdoc/DOMAIN_MEMBER.xml index 0af934faab..8e0aa92861 100644 --- a/docs/docbook/projdoc/DOMAIN_MEMBER.xml +++ b/docs/docbook/projdoc/DOMAIN_MEMBER.xml @@ -4,8 +4,6 @@ &author.jht; &author.jeremy; &author.jerry; - -<!-- Authors of the ADS-HOWTO --> &author.tridge; &author.jelmer; </chapterinfo> @@ -24,7 +22,7 @@ This chapter covers background information pertaining to domain membership, Samba configuration for it, and MS Windows client procedures for joining a domain. Why is this necessary? Because both are areas in which there exists within the current MS Windows networking world and particularly in the -Unix/Linux networking and administration world, a considerable level of +UNIX/Linux networking and administration world, a considerable level of mis-information, incorrect understanding, and a lack of knowledge. Hopefully this chapter will fill the voids. </para> @@ -33,8 +31,7 @@ this chapter will fill the voids. <title>Features and Benefits</title> <para> -MS Windows workstations and servers that want to participate in domain -security need to +MS Windows workstations and servers that want to participate in domain security need to be made Domain members. Participating in Domain security is often called <emphasis>Single Sign On</emphasis> or <acronym>SSO</acronym> for short. This chapter describes the process that must be followed to make a workstation @@ -91,9 +88,11 @@ Domain membership has many advantages: </sect1> -<sect1> +<sect1 id="machine-trust-accounts"> <title>MS Windows Workstation/Server Machine Trust Accounts</title> +<indexterm><primary>machine trust accounts</primary></indexterm> + <para> A machine trust account is an account that is used to authenticate a client machine @@ -126,14 +125,14 @@ as follows: <itemizedlist> <listitem><para> A Domain Security Account (stored in the - <parameter>passdb backend</parameter> that has been configured in the + <smbconfoption><name>passdb backend</name></smbconfoption> that has been configured in the &smb.conf; file. The precise nature of the account information that is stored depends on the type of backend database that has been chosen. </para> <para> The older format of this data is the <filename>smbpasswd</filename> database - which contains the unix login ID, the Unix user identifier (UID), and the + which contains the UNIX login ID, the UNIX user identifier (UID), and the LanMan and NT encrypted passwords. There is also some other information in this file that we do not need to concern ourselves with here. </para> @@ -146,25 +145,28 @@ as follows: </para></listitem> <listitem><para> - A corresponding Unix account, typically stored in + A corresponding UNIX account, typically stored in <filename>/etc/passwd</filename>. Work is in progress to allow a - simplified mode of operation that does not require Unix user accounts, but + simplified mode of operation that does not require UNIX user accounts, but this may not be a feature of the early releases of Samba-3. </para></listitem> </itemizedlist> </para> +<indexterm><primary>machine trust accounts</primary><secondary>creating</secondary></indexterm> + <para> There are three ways to create machine trust accounts: </para> <itemizedlist> <listitem><para> - Manual creation from the Unix/Linux command line. Here, both the Samba and - corresponding Unix account are created by hand. + Manual creation from the UNIX/Linux command line. Here, both the Samba and + corresponding UNIX account are created by hand. </para></listitem> <listitem><para> + <indexterm><primary>Server Manager</primary></indexterm> Using the MS Windows NT4 Server Manager (either from an NT4 Domain member server, or using the Nexus toolkit available from the Microsoft web site. This tool can be run from any MS Windows machine so long as the user is @@ -174,7 +176,7 @@ There are three ways to create machine trust accounts: <listitem><para> "On-the-fly" creation. The Samba machine trust account is automatically created by Samba at the time the client is joined to the domain. - (For security, this is the recommended method.) The corresponding Unix + (For security, this is the recommended method.) The corresponding UNIX account may be created automatically or manually. </para></listitem> </itemizedlist> @@ -184,25 +186,35 @@ There are three ways to create machine trust accounts: <para> The first step in manually creating a machine trust account is to manually -create the corresponding Unix account in <filename>/etc/passwd</filename>. +create the corresponding UNIX account in <filename>/etc/passwd</filename>. This can be done using <command>vipw</command> or another 'add user' command -that is normally used to create new Unix accounts. The following is an example for a Linux based Samba server: -</para> +that is normally used to create new UNIX accounts. The following is an example for a Linux based Samba server: +<indexterm><primary>useradd</primary></indexterm> +<indexterm><primary>vipw</primary></indexterm> + -<para> -&rootprompt;<userinput>/usr/sbin/useradd -g 100 -d /dev/null -c <replaceable>"machine nickname"</replaceable> -s /bin/false <replaceable>machine_name</replaceable>$ </userinput> </para> <para> +<screen> +&rootprompt;<userinput>/usr/sbin/useradd -g 100 -d /dev/null -c <replaceable>"machine nickname"</replaceable> \ + -s /bin/false <replaceable>machine_name</replaceable>$ </userinput> + &rootprompt;<userinput>passwd -l <replaceable>machine_name</replaceable>$</userinput> +</screen> </para> + <para> +<indexterm><primary>chpass</primary></indexterm> On *BSD systems, this can be done using the <command>chpass</command> utility: </para> <para> -&rootprompt;<userinput>chpass -a "<replaceable>machine_name</replaceable>$:*:101:100::0:0:Workstation <replaceable>machine_name</replaceable>:/dev/null:/sbin/nologin"</userinput> +<screen> +&rootprompt;<userinput>chpass -a \ + "<replaceable>machine_name</replaceable>$:*:101:100::0:0:Workstation <replaceable>machine_name</replaceable>:/dev/null:/sbin/nologin"</userinput> +</screen> </para> <para> @@ -213,7 +225,7 @@ home directory. For example a machine named 'doppy' would have an </para> <programlisting> -doppy$:x:505:501:<replaceable>machine_nickname</replaceable>:/dev/null:/bin/false +doppy$:x:505:100:<replaceable>machine_nickname</replaceable>:/dev/null:/bin/false </programlisting> <para> @@ -226,10 +238,10 @@ this as a machine trust account. </para> <para> -Now that the corresponding Unix account has been created, the next step is to create +Now that the corresponding UNIX account has been created, the next step is to create the Samba account for the client containing the well-known initial -machine trust account password. This can be done using the <ulink -url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink> command +machine trust account password. This can be done using the +<command>smbpasswd</command> command as shown here: </para> @@ -242,7 +254,7 @@ as shown here: <para> where <replaceable>machine_name</replaceable> is the machine's NetBIOS name. The RID of the new machine account is generated from the UID of -the corresponding Unix account. +the corresponding UNIX account. </para> <warning> @@ -251,6 +263,7 @@ the corresponding Unix account. <para> Manually creating a machine trust account using this method is the equivalent of creating a machine trust account on a Windows NT PDC using + <indexterm><primary>Server Manager</primary></indexterm> the <application>Server Manager</application>. From the time at which the account is created to the time which the client joins the domain and changes the password, your domain is vulnerable to an intruder joining @@ -266,18 +279,23 @@ the corresponding Unix account. <para> If the machine from which you are trying to manage the domain is an -<application>MS Windows NT4 workstation</application> +<application>MS Windows NT4 workstation or MS Windows 200x / XP Professional</application> then the tool of choice is the package called <command>SRVTOOLS.EXE</command>. -When executed in the target directory this will unpack -<command>SrvMge.exe</command> and <command>UsrMgr.exe</command> (both are -Domain Management tools for MS Windows NT4 workstation. +When executed in the target directory this will unpack <command>SrvMge.exe</command> +and <command>UsrMgr.exe</command> (both are domain management tools for MS Windows NT4 workstation). +</para> + +<para> +If your workstation is a <application>Microsoft Windows 9x/Me</application> family product + you should download the <command>Nexus.exe</command> package from the Microsoft web site. +When executed from the target directory this will unpack the same tools but for use on +this platform. </para> <para> -If your workstation is any other MS Windows product you should download the -<command>Nexus.exe</command> package from the Microsoft web site. When executed -from the target directory this will unpack the same tools but for use on -<application>MS Windows 9x/Me/200x/XP</application>. +Further information about these tools may be obtained from the following locations: +<ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;173673"></ulink> +<ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;172540"></ulink> </para> <para> @@ -327,10 +345,10 @@ simply to allow the Samba server to create them as needed when the client is joined to the domain. </para> -<para>Since each Samba machine trust account requires a corresponding Unix account, a method -for automatically creating the Unix account is usually supplied; this requires configuration of the -<ulink url="smb.conf.5.html#ADDMACHINESCRIPT">add machine script</ulink> option in -<filename>smb.conf</filename>. This method is not required, however; corresponding Unix +<para>Since each Samba machine trust account requires a corresponding UNIX account, a method +for automatically creating the UNIX account is usually supplied; this requires configuration of the +add machine script option in +&smb.conf;. This method is not required, however; corresponding UNIX accounts may also be created manually. </para> @@ -339,11 +357,11 @@ accounts may also be created manually. Below is an example for a RedHat Linux system. </para> -<para><programlisting> -[global] - # <...remainder of parameters...> - add machine script = /usr/sbin/useradd -d /dev/null -g 100 -s /bin/false -M %u -</programlisting></para> +<para><smbconfblock> +<smbconfsection>[global]</smbconfsection> +<smbconfcomment><...remainder of parameters...></smbconfcomment> +<smbconfoption><name>add machine script</name><value>/usr/sbin/useradd -d /dev/null -g 100 -s /bin/false -M %u </value></smbconfoption> +</smbconfblock></para> </sect2> @@ -352,7 +370,7 @@ Below is an example for a RedHat Linux system. <sect2><title>Making an MS Windows Workstation or Server a Domain Member</title> <para> -The procedure for making an MS Windows workstation of server a member of the domain varies +The procedure for making an MS Windows workstation or server a member of the domain varies with the version of Windows: </para> @@ -377,7 +395,7 @@ with the version of Windows: The name of the account that is used to create domain member machine accounts can be anything the network administrator may choose. If it is other than <emphasis>root</emphasis> then this is easily mapped to root using the file pointed to be the &smb.conf; parameter - <parameter>username map = /etc/samba/smbusers</parameter>. + <smbconfoption><name>username map</name><value>/etc/samba/smbusers</value></smbconfoption>. </para> <para> @@ -413,7 +431,7 @@ with the version of Windows: <title>Samba</title> <para>Joining a Samba client to a domain is documented in - the <link linkend="domain-member-server">Domain Member Server</link> section of this chapter chapter. + <link linkend="domain-member-server">the domain member chapter</link>. </para> </sect3> @@ -442,7 +460,7 @@ Server, etc. </para> <para> -Please refer to the <link linkend="samba-pdc">Domain Control chapter</link> +Please refer to <link linkend="samba-pdc">the chapter on setting up a PDC</link> for more information regarding how to create a domain machine account for a domain member server as well as for information regarding how to enable the Samba domain member machine to join the domain and @@ -457,7 +475,7 @@ to be fully trusted by it. <tgroup align="left" cols="2"> <tbody> <row><entry>NetBIOS name:</entry><entry>SERV1</entry></row> - <row><entry>Win2K/NT domain name:</entry><entry>DOM</entry></row> + <row><entry>Win2K/NT domain name:</entry><entry>&example.workgroup;</entry></row> <row><entry>Domain's PDC NetBIOS name:</entry><entry>DOMPDC</entry></row> <row><entry>Domain's BDC NetBIOS names:</entry><entry>DOMBDC1 and DOMBDC2</entry></row> </tbody> @@ -471,27 +489,26 @@ now use domain security. </para> <para> -Change (or add) your <ulink url="smb.conf.5.html#SECURITY"> -<parameter>security</parameter></ulink> line in the [global] section + Change (or add) your + <smbconfoption><name>security</name></smbconfoption> line in the [global] section of your &smb.conf; to read: </para> <para> -<programlisting> -security = domain -</programlisting> +<smbconfblock> +<smbconfoption><name>security</name><value>domain</value></smbconfoption> +</smbconfblock> </para> <para> -Next change the <ulink url="smb.conf.5.html#WORKGROUP"><parameter> -workgroup</parameter></ulink> line in the <parameter>[global]</parameter> +Next change the <smbconfoption><name>workgroup</name></smbconfoption> line in the <smbconfsection>[global]</smbconfsection> section to read: </para> <para> -<programlisting> -workgroup = DOM -</programlisting> +<smbconfblock> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +</smbconfblock> </para> <para> @@ -499,21 +516,20 @@ as this is the name of the domain we are joining. </para> <para> -You must also have the parameter <ulink url="smb.conf.5.html#ENCRYPTPASSWORDS"> -<parameter>encrypt passwords</parameter></ulink> set to <constant>yes +You must also have the parameter +<smbconfoption><name>encrypt passwords</name></smbconfoption> set to <constant>yes </constant> in order for your users to authenticate to the NT PDC. </para> <para> -Finally, add (or modify) a <ulink url="smb.conf.5.html#PASSWORDSERVER"> -<parameter>password server</parameter></ulink> line in the [global] +Finally, add (or modify) a <smbconfoption><name>password server</name></smbconfoption> line in the [global] section to read: </para> <para> -<programlisting> -password server = DOMPDC DOMBDC1 DOMBDC2 -</programlisting> +<smbconfblock> +<smbconfoption><name>password server</name><value>DOMPDC DOMBDC1 DOMBDC2</value></smbconfoption> +</smbconfblock> </para> <para> @@ -531,9 +547,9 @@ set this line to be: </para> <para> -<programlisting> -password server = * -</programlisting> +<smbconfblock> +<smbconfoption><name>password server</name><value>*</value></smbconfoption> +</smbconfblock> </para> <para> @@ -548,7 +564,7 @@ In order to actually join the domain, you must run this command: <para> <screen> -<prompt>root# </prompt><userinput>net join -S DOMPDC -U<replaceable>Administrator%password</replaceable></userinput> +&rootprompt;<userinput>net rpc join -S DOMPDC -U<replaceable>Administrator%password</replaceable></userinput> </screen> </para> @@ -573,8 +589,8 @@ or <computeroutput>Joined 'SERV1' to realm 'MYREALM'</computeroutput> </para> <para> -in your terminal window. See the <ulink url="net.8.html"> -net(8)</ulink> man page for more details. +in your terminal window. See the +<command>net</command> man page for more details. </para> <para> @@ -602,7 +618,12 @@ as a shadow password file. <para> Finally, restart your Samba daemons and get ready for -clients to begin using domain security! +clients to begin using domain security! The way you can restart your +samba daemons depends on your distribution, but in most cases running +<screen> + &rootprompt;/etc/init.d/samba restart +</screen> +does the job. </para> </sect2> @@ -612,20 +633,19 @@ clients to begin using domain security! <para> Currently, domain security in Samba doesn't free you from -having to create local Unix users to represent the users attaching +having to create local UNIX users to represent the users attaching to your server. This means that if domain user <constant>DOM\fred </constant> attaches to your domain security Samba server, there needs -to be a local Unix user fred to represent that user in the Unix +to be a local UNIX user fred to represent that user in the UNIX filesystem. This is very similar to the older Samba security mode -<ulink url="smb.conf.5.html#SECURITYEQUALSSERVER">security = server</ulink>, +security = server, where Samba would pass through the authentication request to a Windows NT server in the same way as a Windows 95 or Windows 98 server would. </para> <para> -Please refer to the <link linkend="winbind">Winbind</link> chapter -for information on a system to automatically -assign UNIX uids and gids to Windows NT Domain users and groups. + Please refer to <link linkend="winbind">the chapter on winbind</link> for information on a system +to automatically assign UNIX uids and gids to Windows NT Domain users and groups. </para> <para> @@ -639,11 +659,11 @@ domain PDC to an account domain PDC). </para> <para> -In addition, with <parameter>security = server</parameter> every Samba +In addition, with <smbconfoption><name>security</name><value>server</value></smbconfoption> every Samba daemon on a server has to keep a connection open to the authenticating server for as long as that daemon lasts. This can drain the connection resources on a Microsoft NT server and cause it to run -out of available connections. With <parameter>security = domain</parameter>, +out of available connections. With <smbconfoption><name>security</name><value>domain</value></smbconfoption>, however, the Samba daemons connect to the PDC/BDC only for as long as is necessary to authenticate the user, and then drop the connection, thus conserving PDC connection resources. @@ -672,35 +692,40 @@ the NIS/NT Samba</ulink>. <sect1 id="ads-member"> <title>Samba ADS Domain Membership</title> +<indexterm significance="preferred"><primary>Active Directory</primary></indexterm> +<indexterm significance="preferred"><primary>ADS</primary><see>Active Directory</see></indexterm> + +<indexterm><primary>KDC</primary></indexterm> +<indexterm><primary>Kerberos</primary></indexterm> <para> This is a rough guide to setting up Samba 3.0 with Kerberos authentication against a Windows2000 KDC. A familiarity with Kerberos is assumed. </para> <sect2> -<title>Setup your <filename>smb.conf</filename></title> +<title>Setup your &smb.conf;</title> <para> You must use at least the following 3 options in &smb.conf;: </para> -<para><programlisting> - realm = your.kerberos.REALM - security = ADS - encrypt passwords = yes -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>realm</name><value>your.kerberos.REALM</value></smbconfoption> +<smbconfoption><name>security</name><value>ADS</value></smbconfoption> +<smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption> +</smbconfblock></para> <para> In case samba can't figure out your ads server using your realm name, use the -<parameter>ads server</parameter> option in <filename>smb.conf</filename>: -<programlisting> - ads server = your.kerberos.server -</programlisting> +<smbconfoption><name>ads server</name></smbconfoption> option in &smb.conf;: +<smbconfblock> +<smbconfoption><name>ads server</name><value>your.kerberos.server</value></smbconfoption> +</smbconfblock> </para> <note><para> You do <emphasis>not</emphasis> need a smbpasswd file, and older clients will be authenticated as -if <parameter>security = domain</parameter>, although it won't do any harm and +if <smbconfoption><name>security</name><value>domain</value></smbconfoption>, although it won't do any harm and allows you to have local users not in the domain. It is expected that the above required options will change soon when active directory integration will get better. @@ -716,15 +741,17 @@ The minimal configuration for <filename>krb5.conf</filename> is: </para> <para><programlisting> - [libdefaults] - default_realm = YOUR.KERBEROS.REALM +[libdefaults] + default_realm = YOUR.KERBEROS.REALM [realms] - YOUR.KERBEROS.REALM = { - kdc = your.kerberos.server + YOUR.KERBEROS.REALM = { + kdc = your.kerberos.server } </programlisting></para> +<indexterm><primary>kinit</primary></indexterm> + <para> Test your config by doing a <userinput>kinit <replaceable>USERNAME</replaceable>@<replaceable>REALM</replaceable></userinput> and @@ -733,7 +760,8 @@ making sure that your password is accepted by the Win2000 KDC. <note><para> The realm must be uppercase or you will get <errorname>Cannot find KDC for -requested realm while getting initial credentials</errorname> error. +requested realm while getting initial credentials</errorname> error (Kerberos +is case-sensitive!). </para></note> <note><para> @@ -773,9 +801,9 @@ is only needed if you want Kerberos support for &smbd; and &winbindd;. <para> As a user that has write permission on the Samba private directory (usually root) run: -<programlisting> - &rootprompt;<userinput>net join -U Administrator%password</userinput> -</programlisting> +<screen> +&rootprompt; <userinput>net ads join -U Administrator%password</userinput> +</screen> </para> <sect3> @@ -788,7 +816,7 @@ As a user that has write permission on the Samba private directory (make clean all install) after the Kerberos libs and headers are installed. </para></listitem></varlistentry> - <varlistentry><term><errorname>net join prompts for user name</errorname></term> + <varlistentry><term><errorname>net ads join prompts for user name</errorname></term> <listitem><para>You need to login to the domain using <userinput>kinit <replaceable>USERNAME</replaceable>@<replaceable>REALM</replaceable></userinput>. <replaceable>USERNAME</replaceable> must be a user who has rights to add a machine @@ -821,10 +849,12 @@ server? Does it have an encoding type of DES-CBC-MD5 ? <sect2 id="ads-test-smbclient"> <title>Testing with &smbclient;</title> +<indexterm><primary>smbclient</primary></indexterm> + <para> On your Samba server try to login to a Win2000 server or your Samba server using &smbclient; and Kerberos. Use &smbclient; as usual, but -specify the <parameter>-k</parameter> option to choose Kerberos authentication. +specify the <option>-k</option> option to choose Kerberos authentication. </para> </sect2> @@ -839,7 +869,7 @@ install, to create the right encoding types <para> W2k doesn't seem to create the _kerberos._udp and _ldap._tcp in -their defaults DNS setup. Maybe fixed in service packs? +their defaults DNS setup. Maybe this will be fixed later in service packs. </para> </sect2> @@ -855,17 +885,17 @@ It is particularly interesting how often subscribers on the samba mailing list h after repeated failed attempts to add a machine account that it is necessary to "re-install" MS Windows on t he machine. In truth, it is seldom necessary to reinstall because of this type of problem. The real solution is often very simple, and with understanding of how MS Windows -networking functions. easily overcome. +networking functions easy to overcome. </para> <sect2> <title>Can Not Add Machine Back to Domain</title> <para> -<emphasis>Problem:</emphasis> A Windows workstation was reinstalled. The original domain machine +<quote> A Windows workstation was reinstalled. The original domain machine account was deleted and added immediately. The workstation will not join the domain if I use the same machine name. Attempts to add the machine fail with a message that the machine already -exists on the network - I know it doesn't. Why is this failing? +exists on the network - I know it doesn't. Why is this failing?</quote> </para> <para> @@ -880,15 +910,15 @@ the old account and then to add the machine with a new name. <title>Adding Machine to Domain Fails</title> <para> -Adding a Windows 200x or XP Professional machine to the Samba PDC Domain fails with a + <quote>Adding a Windows 200x or XP Professional machine to the Samba PDC Domain fails with a message that, <errorname>The machine could not be added at this time, there is a network problem. -Please try again later.</errorname> Why? + Please try again later.</errorname> Why?</quote> </para> <para> -You should check that there is an <parameter>add machine script</parameter> in your &smb.conf; +You should check that there is an <smbconfoption><name>add machine script</name></smbconfoption> in your &smb.conf; file. If there is not, please add one that is appropriate for your OS platform. If a script -has been defined you will need to debug it's operation. Increase the <parameter>log level</parameter> +has been defined you will need to debug it's operation. Increase the <smbconfoption><name>log level</name></smbconfoption> in the &smb.conf; file to level 10, then try to rejoin the domain. Check the logs to see which operation is failing. </para> @@ -904,16 +934,16 @@ Possible causes include: <para> <emphasis>Corrective Action:</emphasis> Fix it. Make sure that when run manually - that the script will add both the Unix system account _and_ the Samba SAM account. + that the script will add both the UNIX system account _and_ the Samba SAM account. </para></listitem> <listitem><para> - The machine could not be added to the Unix system accounts file <filename>/etc/passwd</filename> + The machine could not be added to the UNIX system accounts file <filename>/etc/passwd</filename> </para> <para> - <emphasis>Corrective Action:</emphasis> Check that the machine name is a legal Unix - system account name. ie: If the Unix utility <command>useradd</command> is called + <emphasis>Corrective Action:</emphasis> Check that the machine name is a legal UNIX + system account name. ie: If the UNIX utility <command>useradd</command> is called then make sure that the machine name you are trying to add can be added using this tool. <command>Useradd</command> on some systems will not allow any upper case characters nor will it allow spaces in the name. diff --git a/docs/docbook/projdoc/Diagnosis.xml b/docs/docbook/projdoc/Diagnosis.xml index 7e3656c0f3..76984f3076 100644 --- a/docs/docbook/projdoc/Diagnosis.xml +++ b/docs/docbook/projdoc/Diagnosis.xml @@ -52,14 +52,13 @@ You can add a <replaceable>tmp</replaceable> share like this by adding the following to &smb.conf;: </para> -<para><programlisting> - -[tmp] - comment = temporary files - path = /tmp - read only = yes - -</programlisting> +<para><smbconfexample> + <title>smb.conf with [tmp] share</title> +<smbconfsection>[tmp]</smbconfsection> +<smbconfoption><name>comment</name><value>temporary files </value></smbconfoption> +<smbconfoption><name>path</name><value>/tmp</value></smbconfoption> +<smbconfoption><name>read only</name><value>yes</value></smbconfoption> +</smbconfexample> </para> <note><para> @@ -80,6 +79,8 @@ that the settings for your &smb.conf; file results in <command>dns proxy = no</c best way to check this is with <userinput>testparm smb.conf</userinput>. </para> +<indexterm><primary>log files</primary><secondary>monitoring</secondary></indexterm> + <para> It is helpful to monitor the log files during testing by using the <command>tail -F <replaceable>log_file_name</replaceable></command> in a separate @@ -102,6 +103,8 @@ don't forget to restart &smbd; and &nmbd;. <procedure> <title>Diagnosing your samba server</title> +<indexterm><primary>testparm</primary></indexterm> + <step performance="required"> <para> In the directory in which you store your &smb.conf; file, run the command @@ -175,6 +178,8 @@ state using <userinput>netstat -a</userinput>. </para> <note><para> +<indexterm><primary>inetd</primary></indexterm> +<indexterm><primary>xinetd</primary><see>inetd</see></indexterm> Some Unix / Linux systems use <command>xinetd</command> in place of <command>inetd</command>. Check your system documentation for the location of the control file/s for your particular system implementation of @@ -197,11 +202,11 @@ a session request. The most common of these involve one or more of the following &smb.conf; file entries: </para> -<para><programlisting> - hosts deny = ALL - hosts allow = xxx.xxx.xxx.xxx/yy - bind interfaces only = Yes -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>hosts deny</name><value>ALL</value></smbconfoption> +<smbconfoption><name>hosts allow</name><value>xxx.xxx.xxx.xxx/yy</value></smbconfoption> +<smbconfoption><name>bind interfaces only</name><value>Yes</value></smbconfoption> +</smbconfblock></para> <para> In the above, no allowance has been made for any session requests that @@ -209,22 +214,23 @@ will automatically translate to the loopback adapter address 127.0.0.1. To solve this problem change these lines to: </para> -<para><programlisting> - hosts deny = ALL - hosts allow = xxx.xxx.xxx.xxx/yy 127. -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>hosts deny</name><value>ALL</value></smbconfoption> +<smbconfoption><name>hosts allow</name><value>xxx.xxx.xxx.xxx/yy 127.</value></smbconfoption> +</smbconfblock></para> <para> -Do <emphasis>not</emphasis> use the <command>bind interfaces only</command> parameter where you +Do <emphasis>not</emphasis> use the <smbconfoption><name>bind interfaces only</name></smbconfoption> parameter where you may wish to use the samba password change facility, or where &smbclient; may need to access a local service for name resolution or for local resource -connections. (Note: the <command>bind interfaces only</command> parameter deficiency +connections. (Note: the <smbconfoption><name>bind interfaces only</name></smbconfoption> parameter deficiency where it will not allow connections to the loopback address will be fixed soon). </para> <para> +<indexterm><primary>inetd</primary></indexterm> Another common cause of these two errors is having something already running on port <constant>139</constant>, such as Samba (ie: &smbd; is running from <application>inetd</application> already) or @@ -299,13 +305,13 @@ messages from several hosts. If this doesn't give a similar result to the previous test then nmblookup isn't correctly getting your broadcast address through its automatic mechanism. In this case you should experiment with the -<command>interfaces</command> option in &smb.conf; to manually configure your IP +<smbconfoption><name>interfaces</name></smbconfoption> option in &smb.conf; to manually configure your IP address, broadcast and netmask. </para> <para> If your PC and server aren't on the same subnet then you will need to -use the <parameter>-B</parameter> option to set the broadcast address to that of the PCs +use the <option>-B</option> option to set the broadcast address to that of the PCs subnet. </para> @@ -318,11 +324,13 @@ not correct. (Refer to TEST 3 notes above). <step performance="required"> +<indexterm><primary>smbclient</primary></indexterm> + <para> Run the command <userinput>smbclient //BIGSERVER/TMP</userinput>. You should then be prompted for a password. You should use the password of the account you are logged into the unix box with. If you want to test with -another account then add the <parameter>-U <replaceable>accountname</replaceable></parameter> option to the end of +another account then add the <option>-U <replaceable>accountname</replaceable></option> option to the end of the command line. eg: <userinput>smbclient //bigserver/tmp -Ujohndoe</userinput> </para> @@ -353,26 +361,25 @@ If it says <errorname>bad password</errorname> then the likely causes are: <listitem> <para> - your <command>valid users</command> configuration is incorrect + your <smbconfoption><name>valid users</name></smbconfoption> configuration is incorrect </para> </listitem> <listitem> <para> - you have a mixed case password and you haven't enabled the <command>password - level</command> option at a high enough level + you have a mixed case password and you haven't enabled the <smbconfoption><name>password level</name></smbconfoption> option at a high enough level </para> </listitem> <listitem> <para> - the <command>path =</command> line in &smb.conf; is incorrect. Check it with &testparm; + the <smbconfoption><name>path</name></smbconfoption> line in &smb.conf; is incorrect. Check it with &testparm; </para> </listitem> <listitem> <para> - you enabled password encryption but didn't map unix to samba users + you enabled password encryption but didn't map unix to samba users. Run <screen><userinput>smbpasswd -a <replaceable>username</replaceable></userinput></screen>. </para> </listitem> </orderedlist> @@ -458,8 +465,7 @@ and other config lines in &smb.conf; are correct. <para> It's also possible that the server can't work out what user name to -connect you as. To see if this is the problem add the line <parameter>user = -<replaceable>username</replaceable></parameter> to the <parameter>[tmp]</parameter> section of +connect you as. To see if this is the problem add the line <smbconfoption><name>user</name><value>username</value></smbconfoption> to the <smbconfsection>[tmp]</smbconfsection> section of &smb.conf; where <replaceable>username</replaceable> is the username corresponding to the password you typed. If you find this fixes things you may need the username mapping option. @@ -467,7 +473,7 @@ fixes things you may need the username mapping option. <para> It might also be the case that your client only sends encrypted passwords -and you have <parameter>encrypt passwords = no</parameter> in &smb.conf; +and you have <smbconfoption><name>encrypt passwords</name><value>no</value></smbconfoption> in &smb.conf; Turn it back on to fix. </para> @@ -486,7 +492,7 @@ master browser for that workgroup. If you don't then the election process has failed. Wait a minute to see if it is just being slow then try again. If it still fails after that then look at the browsing options you have set in &smb.conf;. Make -sure you have <parameter>preferred master = yes</parameter> to ensure that +sure you have <smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> to ensure that an election is held at startup. </para> @@ -495,16 +501,16 @@ an election is held at startup. <step performance="required"> <para> ->From file manager try to browse the server. Your samba server should +From file manager try to browse the server. Your samba server should appear in the browse list of your local workgroup (or the one you -specified in smb.conf). You should be able to double click on the name +specified in &smb.conf;). You should be able to double click on the name of the server and get a list of shares. If you get a "invalid password" error when you do then you are probably running WinNT and it is refusing to browse a server that has no encrypted password capability and is in user level security mode. In this case either set -<parameter>security = server</parameter> AND -<parameter>password server = Windows_NT_Machine</parameter> in your -&smb.conf; file, or make sure <parameter>encrypted passwords</parameter> is +<smbconfoption><name>security</name><value>server</value></smbconfoption> AND +<smbconfoption><name>password server</name><value>Windows_NT_Machine</value></smbconfoption> in your +&smb.conf; file, or make sure <smbconfoption><name>encrypt passwords</name></smbconfoption> is set to "yes". </para> @@ -512,13 +518,4 @@ set to "yes". </procedure> </sect1> -<sect1> -<title>Still having troubles?</title> - -<para>Read the chapter on -<link linkend="problems">Analysing and Solving Problems</link>. -</para> - -</sect1> - </chapter> diff --git a/docs/docbook/projdoc/Further-Resources.xml b/docs/docbook/projdoc/Further-Resources.xml index 4294ffa38a..d8905cc659 100644 --- a/docs/docbook/projdoc/Further-Resources.xml +++ b/docs/docbook/projdoc/Further-Resources.xml @@ -1,7 +1,6 @@ <chapter id="Further-Resources"> <chapterinfo> &author.jelmer; - &author.dlechnyr; <pubdate>May 1, 2003</pubdate> </chapterinfo> @@ -141,6 +140,13 @@ </ulink> </para></listitem> + <listitem><para> + <ulink url="http://www2.sphaero.org/docs/#W2K"> + <emphasis>W2K Samba deploy HOWTO</emphasis> + by Arnaud Loonstra + </ulink> + </para></listitem> + </itemizedlist> </sect1> @@ -170,9 +176,4 @@ </itemizedlist> </sect1> -<sect1> - <title>Books</title> - -</sect1> - </chapter> diff --git a/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml b/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml index a13a43675b..076b870609 100644 --- a/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml +++ b/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml @@ -7,17 +7,20 @@ &author.jerry; &author.jht; </chapterinfo> -<title>Mapping MS Windows and Unix Groups</title> +<title>Mapping MS Windows and UNIX Groups</title> + +<indexterm significance="preferred"><primary>groups</primary><secondary>mapping</secondary></indexterm> <para> Starting with Samba-3, new group mapping functionality is available to create associations - between Windows group SIDs and UNIX groups. The <parameter>groupmap</parameter> subcommand + between Windows group SIDs and UNIX groups. The <command>groupmap</command> subcommand included with the &net; tool can be used to manage these associations. </para> <warning> <para> The first immediate reason to use the group mapping on a Samba PDC, is that + <indexterm><primary>domain admin group</primary></indexterm> the <parameter>domain admin group</parameter> has been removed and should no longer be specified in &smb.conf;. This parameter was used to give the listed users membership in the <constant>Domain Admins</constant> Windows group which gave local admin rights on their workstations @@ -30,33 +33,54 @@ <para> Samba allows the administrator to create MS Windows NT4 / 200x group accounts and to - arbitrarily associate them with Unix/Linux group accounts. + arbitrarily associate them with UNIX/Linux group accounts. </para> +<indexterm><primary>UID</primary></indexterm> +<indexterm><primary>GID</primary></indexterm> <para> - Group accounts can be managed using the MS Windows NT4 or MS Windows 200x MMC tools - so long as appropriate interface scripts have been provided to &smb.conf;. + Group accounts can be managed using the MS Windows NT4 or MS Windows 200x / XP Professional MMC tools. + Appropriate interface scripts should be provided in &smb.conf; if it is desired that UNIX / Linux system + accounts should be automatically created when these tools are used. In the absence of these scripts, and + so long as winbind is running, Samba accounts group accounts that are created using these tools will be + allocated UNIX UIDs/GIDs from the parameters set by the <smbconfoption><name>idmap uid</name></smbconfoption>/<smbconfoption><name>idmap gid</name></smbconfoption> settings + in the &smb.conf; file. </para> + + <figure id="idmap-group-diag"><title>IDMAP groups</title> + <mediaobject> + <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap-groups" scale="50" scalefit="1"/></imageobject> + <imageobject><imagedata fileref="projdoc/imagefiles/idmap-groups.png" scale="50" scalefit="1"/></imageobject> + </mediaobject> + </figure> + + <indexterm><primary>groupadd</primary></indexterm> + <indexterm><primary>groupdel</primary></indexterm> + <para> Administrators should be aware that where &smb.conf; group interface scripts make - direct calls to the Unix/Linux system tools (eg: the shadow utilities, <command>groupadd</command>, - <command>groupdel</command>, <command>groupmod</command>) then the resulting Unix/Linux group names will be subject + direct calls to the UNIX/Linux system tools (eg: the shadow utilities, <command>groupadd</command>, + <command>groupdel</command>, <command>groupmod</command>) then the resulting UNIX/Linux group names will be subject to any limits imposed by these tools. If the tool does NOT allow upper case characters or space characters, then the creation of an MS Windows NT4 / 200x style group of - <parameter>Engineering Managers</parameter> will attempt to create an identically named - Unix/Linux group, an attempt that will of course fail! + <ntgroup>Engineering Managers</ntgroup> will attempt to create an identically named + UNIX/Linux group, an attempt that will of course fail! </para> + + <indexterm><primary>GID</primary></indexterm> + <indexterm><primary>SID</primary></indexterm> + <para> There are several possible work-arounds for the operating system tools limitation. One - method is to use a script that generates a name for the Unix/Linux system group that - fits the operating system limits, and that then just passes the Unix/Linux group id (GID) + method is to use a script that generates a name for the UNIX/Linux system group that + fits the operating system limits, and that then just passes the UNIX/Linux group id (GID) back to the calling Samba interface. This will provide a dynamic work-around solution. </para> <para> - Another work-around is to manually create a Unix/Linux group, then manually create the + Another work-around is to manually create a UNIX/Linux group, then manually create the MS Windows NT4 / 200x group on the Samba server and then use the <command>net groupmap</command> tool to connect the two to each other. </para> @@ -74,6 +98,7 @@ local machine. </para> + <indexterm><primary>Administrator</primary></indexterm> <para> The 'Administrator' user is a member of the 'Administrators' group, and thus inherits 'Administrators' group privileges. If a 'joe' user is created to be a member of the @@ -111,11 +136,12 @@ </para> <para> - <screen> - &rootprompt;<userinput>net groupmap add ntgroup="Domain Admins" unixgroup=domadm</userinput> - </screen> +<screen> +&rootprompt;<userinput>net groupmap add ntgroup="Domain Admins" unixgroup=domadm</userinput> +</screen> </para> + <indexterm><primary>"Domain Admins" group</primary></indexterm> <para> The quotes around "Domain Admins" are necessary due to the space in the group name. Also make sure to leave no whitespace surrounding the equal character (=). @@ -126,6 +152,7 @@ Now joe, john and mary are domain administrators! </para> + <indexterm><primary>groups</primary><secondary>domain</secondary></indexterm> <para> It is possible to map any arbitrary UNIX group to any Windows NT4 / 200x group as well as making any UNIX group a Windows domain group. For example, if you wanted to include a @@ -134,15 +161,15 @@ </para> <para> - <screen> - &rootprompt;<userinput>net groupmap add rid=1000 ntgroup="Accounting" unixgroup=acct</userinput> - </screen> +<screen> +&rootprompt;<userinput>net groupmap add rid=1000 ntgroup="Accounting" unixgroup=acct</userinput> +</screen> </para> <para> Be aware that the RID parameter is a unsigned 32 bit integer that should normally start at 1000. However, this rid must not overlap with any RID assigned - to a user. Verifying this is done differently depending on on the passdb backend + to a user. Verifying this is done differently depending on the passdb backend you are using. Future versions of the tools may perform the verification automatically, but for now the burden is on you. </para> @@ -156,13 +183,13 @@ </para> <para> - <screen> - &rootprompt; <userinput>net groupmap list</userinput> - System Administrators (S-1-5-21-2547222302-1596225915-2414751004-1002) -> sysadmin - Domain Admins (S-1-5-21-2547222302-1596225915-2414751004-512) -> domadmin - Domain Users (S-1-5-21-2547222302-1596225915-2414751004-513) -> domuser - Domain Guests (S-1-5-21-2547222302-1596225915-2414751004-514) -> domguest - </screen> +<screen> +&rootprompt; <userinput>net groupmap list</userinput> +System Administrators (S-1-5-21-2547222302-1596225915-2414751004-1002) -> sysadmin +Domain Admins (S-1-5-21-2547222302-1596225915-2414751004-512) -> domadmin +Domain Users (S-1-5-21-2547222302-1596225915-2414751004-513) -> domuser +Domain Guests (S-1-5-21-2547222302-1596225915-2414751004-514) -> domguest +</screen> </para> <para> @@ -185,7 +212,7 @@ <title>Sample &smb.conf; add group script</title> <para> - A script to great complying group names for use by the Samba group interfaces: + A script to create complying group names for use by the Samba group interfaces: </para> <para> @@ -213,9 +240,9 @@ exit 0 <para> The &smb.conf; entry for the above script would look like: - <programlisting> - add group script = /path_to_tool/smbgrpadd.sh %g - </programlisting> + <smbconfblock> +<smbconfoption><name>add group script</name><value>/path_to_tool/smbgrpadd.sh %g</value></smbconfoption> + </smbconfblock> </para> </sect2> @@ -224,8 +251,8 @@ exit 0 <title>Script to configure Group Mapping</title> <para> - In our example we have created a Unix/Linux group called <parameter>ntadmin</parameter>. - Our script will create the additional groups <parameter>Engineers, Marketoids, Gnomes</parameter>: + In our example we have created a UNIX/Linux group called <ntgroup>ntadmin</ntgroup>. + Our script will create the additional groups <ntgroup>Orks</ntgroup>, <ntgroup>Elves</ntgroup>, <ntgroup>Gnomes</ntgroup>: </para> <para> @@ -245,13 +272,13 @@ net groupmap modify ntgroup="Print Operators" unixgroup=lp net groupmap modify ntgroup="Replicators" unixgroup=daemon net groupmap modify ntgroup="Power Users" unixgroup=sys -#groupadd Engineers -#groupadd Marketoids -#groupadd Gnomes +groupadd Orks +groupadd Elves +groupadd Gnomes -#net groupmap add ntgroup="Engineers" unixgroup=Engineers type=d -#net groupmap add ntgroup="Marketoids" unixgroup=Marketoids type=d -#net groupmap add ntgroup="Gnomes" unixgroup=Gnomes type=d +net groupmap add ntgroup="Orks" unixgroup=Orks type=d +net groupmap add ntgroup="Elves" unixgroup=Elves type=d +net groupmap add ntgroup="Gnomes" unixgroup=Gnomes type=d </programlisting> </para> @@ -279,7 +306,7 @@ manually before putting them into active service. <para> This is a common problem when the <command>groupadd</command> is called directly - by the Samba interface script for the <parameter>add group script</parameter> in + by the Samba interface script for the <smbconfoption><name>add group script</name></smbconfoption> in the &smb.conf; file. </para> @@ -290,9 +317,9 @@ manually before putting them into active service. <para> There are three possible work-arounds. Firstly, use only group names that comply - with the limitations of the Unix/Linux <command>groupadd</command> system tool. + with the limitations of the UNIX/Linux <command>groupadd</command> system tool. The second involves use of the script mentioned earlier in this chapter, and the - third option is to manually create a Unix/Linux group account that can substitute + third option is to manually create a UNIX/Linux group account that can substitute for the MS Windows group name, then use the procedure listed above to map that group to the MS Windows group. </para> @@ -302,12 +329,40 @@ manually before putting them into active service. <sect2> <title>Adding MS Windows Groups to MS Windows Groups Fails</title> + <indexterm><primary>groups</primary><secondary>nested</secondary></indexterm> + <para> Samba-3 does NOT support nested groups from the MS Windows control environment. </para> </sect2> + <sect2> + <title>Adding <emphasis>Domain Users</emphasis> to the <emphasis>Power Users</emphasis> group</title> + + <para><quote> + What must I do to add Domain Users to the Power Users group? + </quote></para> + + <para> + The Power Users group is a group that is local to each Windows + 200x / XP Professional workstation. You can not add the Domain Users group to the Power Users + group automatically, this must be done on each workstation by logging in as the local workstation + <emphasis>administrator</emphasis> and then using click on Start / Control Panel / Users and Passwords + now click on the 'Advanced' tab, then on the 'Advanced' Button. + </para> + +<indexterm><primary>"Domain Users" group</primary></indexterm> + <para> + Now click on 'Groups', then double click on 'Power Users'. This will launch the panel to add users + or groups to the local machine 'Power Uses' group. Click on the 'Add' button, select the domain + from which the 'Domain Users' group is to be added, double click on the 'Domain Users' group, then + click on the 'Ok' button. Note: If a logon box is presented during this process please remember to + enter the connect as DOMAIN\UserName. ie: For the domain MIDEARTH and the user 'root' enter + MIDEARTH\root. + </para> + </sect2> + </sect1> </chapter> diff --git a/docs/docbook/projdoc/Integrating-with-Windows.xml b/docs/docbook/projdoc/Integrating-with-Windows.xml index 8d07b8a3fd..6beebfb892 100644 --- a/docs/docbook/projdoc/Integrating-with-Windows.xml +++ b/docs/docbook/projdoc/Integrating-with-Windows.xml @@ -7,6 +7,7 @@ <title>Integrating MS Windows networks with Samba</title> +<indexterm><primary>NetBIOS</primary></indexterm> <para> This section deals with NetBIOS over TCP/IP name to IP address resolution. If your MS Windows clients are NOT configured to use NetBIOS over TCP/IP then this @@ -29,7 +30,7 @@ NetBIOS over TCP/IP then this section may help you to resolve networking problem <para> Many MS Windows network administrators have never been exposed to basic TCP/IP -networking as it is implemented in a Unix/Linux operating system. Likewise, many Unix and +networking as it is implemented in a UNIX/Linux operating system. Likewise, many UNIX and Linux administrators have not been exposed to the intricacies of MS Windows TCP/IP based networking (and may have no desire to be either). </para> @@ -63,7 +64,9 @@ Name Service or WINS), TCP port 139 AND TCP port 445 (for actual file and print <para> When NetBIOS over TCP/IP is disabled the use of DNS is essential. Most installations that disable NetBIOS over TCP/IP today use MS Active Directory Service (ADS). ADS requires +<indexterm><primary>DNS</primary><secondary>Dynamic</secondary></indexterm> Dynamic DNS with Service Resource Records (SRV RR) and with Incremental Zone Transfers (IXFR). +<indexterm><primary>DHCP</primary></indexterm> Use of DHCP with ADS is recommended as a further means of maintaining central control over client workstation network configuration. </para> @@ -71,7 +74,7 @@ over client workstation network configuration. </sect1> <sect1> -<title>Name Resolution in a pure Unix/Linux world</title> +<title>Name Resolution in a pure UNIX/Linux world</title> <para> The key configuration files covered in this section are: @@ -91,10 +94,10 @@ The key configuration files covered in this section are: Contains a static list of IP addresses and names. eg: </para> -<para><screen> - 127.0.0.1 localhost localhost.localdomain - 192.168.1.1 bigbox.caldera.com bigbox alias4box -</screen></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 @@ -111,6 +114,7 @@ Access Control address, or MAC address. IP addresses are currently numbers that are separated by a dot (or period). eg: 168.192.1.1. </para> +<indexterm><primary>MAC Addresses</primary></indexterm> <para> MAC Addresses use 48 bits (or 6 bytes) and are typically represented as two digit hexadecimal numbers separated by colons. eg: @@ -152,9 +156,10 @@ contain the MAC address and the primary IP address for each interface. </para> +<indexterm><primary>/etc/hosts</primary></indexterm> <para> The <filename>/etc/hosts</filename> file is foundational to all -Unix/Linux TCP/IP installations and as a minimum will contain +UNIX/Linux TCP/IP installations and as a minimum 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 @@ -195,6 +200,7 @@ This file tells the name resolution libraries: <title><filename>/etc/host.conf</filename></title> +<indexterm><primary>/etc/host.conf</primary></indexterm> <para> <filename>/etc/host.conf</filename> is the primary means by which the setting in /etc/resolv.conf may be affected. It is a @@ -202,10 +208,10 @@ critical configuration file. This file controls the order by which name resolution may proceed. The typical structure is: </para> -<para><screen> - order hosts,bind - multi on -</screen></para> +<para><programlisting> +order hosts,bind +multi on +</programlisting></para> <para> then both addresses should be returned. Please refer to the @@ -220,34 +226,36 @@ man page for host.conf for further details. <sect2> <title><filename>/etc/nsswitch.conf</filename></title> +<indexterm><primary>/etc/nsswitch.conf</primary></indexterm> + <para> This file controls the actual name resolution targets. The file typically has resolver object specifications as follows: </para> -<para><screen> - # /etc/nsswitch.conf - # - # Name Service Switch configuration file. - # +<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 +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+ hesiod db compat ldap wins - networks: nis files dns +hosts: files nis dns +# Alternative entries for host name resolution are: +# hosts: files dns nis nis+ hesiod db compat ldap wins +networks: nis files dns - ethers: nis files - protocols: nis files - rpc: nis files - services: nis files -</screen></para> +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 @@ -260,6 +268,8 @@ sent, TCP/IP networks are silent. All TCP/IP communications assumes a principal of speaking only when necessary. </para> +<indexterm><primary>libnss_wins.so</primary></indexterm> + <para> Starting with version 2.2.0 samba has Linux support for extensions to the name service switch infrastructure so that linux clients will @@ -301,21 +311,36 @@ the client/server. The following are typical NetBIOS name/service type registrations: </para> -<para><screen> - 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 -</screen></para> - -<para> +<table frame="all"> +<title>Unique NetBIOS names</title> +<tgroup cols="2"> +<colspec align="left"/> +<colspec align="justify"/> +<tbody> +<row><entry>MACHINENAME<00></entry><entry>Server Service is running on MACHINENAME</entry></row> +<row><entry>MACHINENAME<03></entry><entry>Generic Machine Name (NetBIOS name)</entry></row> +<row><entry>MACHINENAME<20></entry><entry>LanMan Server service is running on MACHINENAME</entry></row> +<row><entry>WORKGROUP<1b></entry><entry>Domain Master Browser</entry></row> +</tbody> +</tgroup> +</table> + +<table frame="all"> +<title>Group Names</title> +<tgroup cols="2"> +<colspec align="left"/> +<colspec align="justify"/> +<tbody> +<row><entry>WORKGROUP<03></entry><entry>Generic Name registered by all members of WORKGROUP</entry></row> +<row><entry>WORKGROUP<1c></entry><entry>Domain Controllers / Netlogon Servers</entry></row> +<row><entry>WORKGROUP<1d></entry><entry>Local Master Browsers</entry></row> +<row><entry>WORKGROUP<1e></entry><entry>Internet Name Resolvers</entry></row> +</tbody> +</tgroup> +</table> + +<para> +<indexterm><primary>NetBIOS</primary></indexterm> 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 @@ -323,6 +348,7 @@ determine in the /etc/hosts or in the DNS database what names are associated with each IP address. </para> +<indexterm><primary>NetBIOS</primary></indexterm> <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 @@ -390,6 +416,8 @@ lookup will succeed, but the machine can not respond. This can be frustrating for users - but it is a characteristic of the protocol. </para> +<indexterm><primary>nbtstat</primary></indexterm> +<indexterm><primary>nmblookup</primary></indexterm> <para> The MS Windows utility that allows examination of the NetBIOS name cache is called "nbtstat". The Samba equivalent of this @@ -401,6 +429,7 @@ is called <command>nmblookup</command>. <sect2> <title>The LMHOSTS file</title> +<indexterm><primary>LMHOSTS</primary></indexterm> <para> This file is usually located in MS Windows NT 4.0 or 2000 in <filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains @@ -413,84 +442,85 @@ to IP address mapping. It typically looks like: </para> -<para><screen> - # 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 computername - # 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:<domain> - # #INCLUDE <filename> - # #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:<domain>" tag will associate the - # entry with the domain specified by <domain>. 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 <domain> is always preloaded although it will not - # be shown when the name cache is viewed. - # - # Specifying "#INCLUDE <filename>" will force the RFC NetBIOS (NBT) - # software to seek the specified <filename> and parse it as if it were - # local. <filename> 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 addition 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. -</screen></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 computername +# 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:<domain> +# #INCLUDE <filename> +# #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:<domain>" tag will associate the +# entry with the domain specified by <domain>. 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 <domain> is always preloaded although it will not +# be shown when the name cache is viewed. +# +# Specifying "#INCLUDE <filename>" will force the RFC NetBIOS (NBT) +# software to seek the specified <filename> and parse it as if it were +# local. <filename> 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 addition 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> @@ -503,7 +533,7 @@ This file is usually located in MS Windows NT 4.0 or 2000 in 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. +every way the equivalent of the UNIX/Linux <filename>/etc/hosts</filename> file. </para> </sect2> @@ -511,6 +541,8 @@ every way the equivalent of the Unix/Linux <filename>/etc/hosts</filename> file. <sect2> <title>DNS Lookup</title> +<indexterm><primary>DNS</primary></indexterm> + <para> This capability is configured in the TCP/IP setup area in the network configuration facility. If enabled, an elaborate name resolution sequence @@ -529,6 +561,8 @@ lookup is used. <sect2> <title>WINS Lookup</title> +<indexterm><primary>WINS</primary></indexterm> + <para> A WINS (Windows Internet Name Server) service is the equivalent of the rfc1001/1002 specified NBNS (NetBIOS Name Server). A WINS server stores @@ -541,25 +575,28 @@ To configure Samba to be a WINS server the following parameter needs to be added to the &smb.conf; file: </para> -<para><screen> - wins support = Yes -</screen></para> +<para><smbconfblock> +<smbconfoption><name>wins support</name><value>Yes</value></smbconfoption> +</smbconfblock></para> <para> To configure Samba to use a WINS server the following parameters are needed in the &smb.conf; file: </para> -<para><screen> - wins support = No - wins server = xxx.xxx.xxx.xxx -</screen></para> +<para><smbconfblock> +<smbconfoption><name>wins support</name><value>No</value></smbconfoption> +<smbconfoption><name>wins server</name><value>xxx.xxx.xxx.xxx</value></smbconfoption> +</smbconfblock></para> <para> where <replaceable>xxx.xxx.xxx.xxx</replaceable> is the IP address of the WINS server. </para> +<para>For information about setting up Samba as a WINS server, read + <link linkend="NetworkBrowsing">the chapter on network browsing</link>.</para> + </sect2> </sect1> @@ -573,11 +610,11 @@ carelessness. Of course, no one is every deliberately careless! </para> <sect2> - <title>My Boomerang Won't Come Back</title> + <title>Pinging works only in one way</title> <para> - Well, the real complaint said, "I can ping my samba server from Windows, but I can - not ping my Windows machine from the samba server." + <quote>I can ping my samba server from Windows, but I can + not ping my Windows machine from the samba server.</quote> </para> <para> @@ -614,9 +651,9 @@ carelessness. Of course, no one is every deliberately careless! <title>Samba server name change problem</title> <para> - The name of the samba server was changed, samba was restarted, samba server can not be + <quote>The name of the samba server was changed, samba was restarted, samba server can not be pinged by new name from MS Windows NT4 Workstation, but it does still respond to ping using - the old name. Why? + the old name. Why?</quote> </para> <para> @@ -635,35 +672,35 @@ carelessness. Of course, no one is every deliberately careless! </para> <para> - <screen> - C:\temp\>nbtstat -n +<screen> +&dosprompt;<userinput>nbtstat -n</userinput> - NetBIOS Local Name Table + NetBIOS Local Name Table - Name Type Status - ------------------------------------------------ - SLACK <03> UNIQUE Registered - ADMINISTRATOR <03> UNIQUE Registered - SLACK <00> UNIQUE Registered - SARDON <00> GROUP Registered - SLACK <20> UNIQUE Registered - SLACK <1F> UNIQUE Registered + Name Type Status +------------------------------------------------ +&example.workstation.windows; <03> UNIQUE Registered +ADMINSTRATOR <03> UNIQUE Registered +&example.workstation.windows; <00> UNIQUE Registered +SARDON <00> GROUP Registered +&example.workstation.windows; <20> UNIQUE Registered +&example.workstation.windows; <1F> UNIQUE Registered - C:\Temp\>nbtstat -c +&dosprompt;nbtstat -c - NetBIOS Remote Cache Name Table + NetBIOS Remote Cache Name Table - Name Type Host Address Life [sec] - -------------------------------------------------------------- - FRODO <20> UNIQUE 192.168.1.1 240 + Name Type Host Address Life [sec] +-------------------------------------------------------------- +&example.server.samba; <20> UNIQUE 192.168.1.1 240 - C:\Temp\> - </screen> +&dosprompt; +</screen> </para> <para> - In the above example, FRODO is the Samba server and SLACK is the MS Windows NT4 Workstation. + In the above example, &example.server.samba; is the Samba server and &example.workstation.windows; is the MS Windows NT4 Workstation. The first listing shows the contents of the Local Name Table (i.e.: Identity information on the MS Windows workstation), the second shows the NetBIOS name in the NetBIOS name cache. The name cache contains the remote machines known to this workstation. diff --git a/docs/docbook/projdoc/InterdomainTrusts.xml b/docs/docbook/projdoc/InterdomainTrusts.xml index 31f9697bf3..04efc6fda6 100644 --- a/docs/docbook/projdoc/InterdomainTrusts.xml +++ b/docs/docbook/projdoc/InterdomainTrusts.xml @@ -2,17 +2,27 @@ <chapterinfo> &author.jht; &author.mimir; + <author>&person.jelmer;<contrib>drawing</contrib></author> + <author> + <firstname>Stephen</firstname><surname>Langasek</surname> + <affiliation> + <address><email>vorlon@netexpress.net</email></address> + </affiliation> + </author> <pubdate>April 3, 2003</pubdate> </chapterinfo> <title>Interdomain Trust Relationships</title> +<indexterm><primary>Interdomain Trusts</primary></indexterm> + <para> Samba-3 supports NT4 style domain trust relationships. This is feature that many sites will want to use if they migrate to Samba-3 from and NT4 style domain and do NOT want to adopt Active Directory or an LDAP based authentication back end. This section explains some background information regarding trust relationships and how to create them. It is now -possible for Samba-3 to NT4 trust (and vice versa), as well as Samba3 to Samba3 trusts. +possible for Samba-3 to trust NT4 (and vice versa), as well as to create Samba3-to-Samba3 +trusts. </para> <sect1> @@ -40,7 +50,7 @@ That was, after all, a key reason for the development and adoption of Microsoft <para> MS Windows NT3.x/4.0 type security domains employ a non-hierarchical security structure. The limitations of this architecture as it affects the scalability of MS Windows networking -in large organisations is well known. Additionally, the flat-name space that results from +in large organisations is well known. Additionally, the flat namespace that results from this design significantly impacts the delegation of administrative responsibilities in large and diverse organisations. </para> @@ -74,6 +84,7 @@ transitive. </para> <para> +<!-- FIXME: What are these colors doing here - I can't find them ... Jelmer --> New to MS Windows 2000 ADS security contexts is the fact that trust relationships are two-way by default. Also, all inter-ADS domain trusts are transitive. In the case of the RED, WHITE and BLUE domains above, with Windows 2000 and ADS the RED and BLUE domains CAN trust each other. This is @@ -88,32 +99,37 @@ security domains in similar manner to MS Windows NT4 style domains. <title>Native MS Windows NT4 Trusts Configuration</title> <para> -There are two steps to creating an interdomain trust relationship. +There are two steps to creating an interdomain trust relationship. To effect a two-way trust +relationship it is necessary for each domain administrator to create a trust account for the +other domain to use in verifying security credentials. + +<indexterm><primary>Interdomain Trusts</primary><secondary>creating</secondary></indexterm> </para> <sect2> -<title>NT4 as the Trusting Domain (ie. creating the trusted account)</title> +<title>Creating an NT4 Domain Trust</title> <para> For MS Windows NT4, all domain trust relationships are configured using the -<application>Domain User Manager</application>. To affect a two way trust relationship it is -necessary for each domain administrator to make available (for use by an external domain) it's -security resources. This is done from the Domain User Manager Policies entry on the menu bar. -From the <guimenu>Policy</guimenu> menu, select <guimenuitem>Trust Relationships</guimenuitem>, then -next to the lower box that is labelled <guilabel>Permitted to Trust this Domain</guilabel> are two -buttons, <guibutton>Add</guibutton> and <guibutton>Remove</guibutton>. The <guibutton>Add</guibutton> -button will open a panel in which needs to be entered the remote domain that will be able to assign -user rights to your domain. In addition it is necessary to enter a password -that is specific to this trust relationship. The password needs to be -typed twice (for standard confirmation). +<application>Domain User Manager</application>. This is done from the Domain User Manager Policies +entry on the menu bar. From the <guimenu>Policy</guimenu> menu, select +<guimenuitem>Trust Relationships</guimenuitem>. Next to the lower box labelled +<guilabel>Permitted to Trust this Domain</guilabel> are two buttons, <guibutton>Add</guibutton> +and <guibutton>Remove</guibutton>. The <guibutton>Add</guibutton> button will open a panel in which +to enter the name of the remote domain that will be able to assign access rights to users in +your domain. You will also need to enter a password for this trust relationship, which the +trusting domain will use when authenticating users from the trusted domain. +The password needs to be typed twice (for standard confirmation). </para> </sect2> + <sect2> -<title>NT4 as the Trusted Domain (ie. creating trusted account's password)</title> +<title>Completing an NT4 Domain Trust</title> <para> +<indexterm><primary>Interdomain Trusts</primary><secondary>completing</secondary></indexterm> A trust relationship will work only when the other (trusting) domain makes the appropriate connections with the trusted domain. To consummate the trust relationship the administrator will launch the Domain User Manager, from the menu select Policies, then select Trust Relationships, then click on the @@ -123,6 +139,92 @@ domain as well as the password assigned to that trust. </para> </sect2> + +<sect2> +<title>Inter-Domain Trust Facilities</title> + +<indexterm><primary>Interdomain Trusts</primary><secondary>Facilities</secondary></indexterm> + +<para> +A two-way trust relationship is created when two one-way trusts are created, one in each direction. +Where a one-way trust has been established between two MS Windows NT4 domains (let's call them +DomA and DomB) the following facilities are created: +</para> + +<image><imagefile>trusts1</imagefile><imagedescription>Trusts overview</imagedescription></image> + +<itemizedlist> + <listitem><para> + DomA (completes the trust connection) Trusts DomB + </para></listitem> + + <listitem><para> + DomA is the Trusting domain + </para></listitem> + + <listitem><para> + DomB is the Trusted domain (originates the trust account) + </para></listitem> + + <listitem><para> + Users in DomB can access resources in DomA + </para></listitem> + + <listitem><para> + Users in DomA can NOT access resources in DomB + </para></listitem> + + <listitem><para> + Global groups from DomB CAN be used in DomA + </para></listitem> + + <listitem><para> + Global groups from DomA can NOT be used in DomB + </para></listitem> + + <listitem><para> + DomB DOES appear in the logon dialog box on client workstations in DomA + </para></listitem> + + <listitem><para> + DomA does NOT appear in the logon dialog box on client workstations in DomB + </para></listitem> +</itemizedlist> + +<itemizedlist> + <listitem><para> + Users / Groups in a trusting domain can NOT be granted rights, permissions or access + to a trusted domain. + </para></listitem> + + <listitem><para> + The trusting domain CAN access and use accounts (Users / Global Groups) in the + trusted domain. + </para></listitem> + + <listitem><para> + Administrators of the trusted domain CAN be granted admininstrative rights in the + trusting domain. + </para></listitem> + + <listitem><para> + Users in a trusted domain CAN be given rights and privileges in the trusting + domain. + </para></listitem> + + <listitem><para> + Trusted domain Global Groups CAN be given rights and permissions in the trusting + domain. + </para></listitem> + + <listitem><para> + Global Groups from the trusted domain CAN be made members in Local Groups on + MS Windows domain member machines. + </para></listitem> +</itemizedlist> + +</sect2> + </sect1> <sect1> @@ -135,18 +237,19 @@ is in its early stage, so lot of things don't work yet. </para> <para> -Each of the procedures described below is treated as they were performed with Windows NT4 Server on -one end. The remote end could just as well be another Samba-3 domain. It can be clearly seen, after -reading this document, that combining Samba-specific parts of what's written below leads to trust -between domains in purely Samba environment. +Each of the procedures described below assumes the peer domain in the trust relationship is +controlled by a Windows NT4 server. However, the remote end could just as well be another +Samba-3 domain. It can be clearly seen, after reading this document, that combining +Samba-specific parts of what's written below leads to trust between domains in a purely Samba +environment. </para> -<sect2> -<title>Samba-3 as the Trusting Domain</title> +<sect2 id="samba-trusted-domain"> +<title>Samba as the Trusted Domain</title> <para> -In order to set the Samba PDC to be the trusted party of the relationship first you need -to create special account for the domain that will be the trusting party. To do that, +In order to set the Samba PDC to be the trusted party of the relationship you first need +to create a special account for the domain that will be the trusting party. To do that, you can use the 'smbpasswd' utility. Creating the trusted domain account is very similar to creating a trusted machine account. Suppose, your domain is called SAMBA, and the remote domain is called RUMBA. The first step @@ -156,9 +259,9 @@ will be to issue this command from your favourite shell: <para> <screen> &rootprompt; <userinput>smbpasswd -a -i rumba</userinput> - New SMB password: XXXXXXXX - Retype SMB password: XXXXXXXX - Added user rumba$ +New SMB password: <userinput>XXXXXXXX</userinput> +Retype SMB password: <userinput>XXXXXXXX</userinput> +Added user rumba$ </screen> where <option>-a</option> means to add a new account into the @@ -175,18 +278,20 @@ After issuing this command you'll be asked to enter the password for the account. You can use any password you want, but be aware that Windows NT will not change this password until 7 days following account creation. After the command returns successfully, you can look at the entry for the new account -(in the standard way depending on your configuration) and see that account's name is -really RUMBA$ and it has 'I' flag in the flags field. Now you're ready to confirm +(in the standard way as appropriate for your configuration) and see that account's name is +really RUMBA$ and it has the 'I' flag set in the flags field. Now you're ready to confirm the trust by establishing it from Windows NT Server. </para> +<indexterm><primary>User Manager</primary></indexterm> + <para> -Open <application>User Manager for Domains</application> and from menu -<guimenu>Policies</guimenu> select <guimenuitem>Trust Relationships...</guimenuitem>. -Right beside <guilabel>Trusted domains</guilabel> list box press the +Open <application>User Manager for Domains</application> and from the +<guimenu>Policies</guimenu> menu, select <guimenuitem>Trust Relationships...</guimenuitem>. +Right beside the <guilabel>Trusted domains</guilabel> list box press the <guimenu>Add...</guimenu> button. You will be prompted for the trusted domain name and the relationship password. Type in SAMBA, as this is -your domain name, and the password used at the time of account creation. +the name of the remote domain, and the password used at the time of account creation. Press OK and, if everything went without incident, you will see <computeroutput>Trusted domain relationship successfully established</computeroutput> message. @@ -194,7 +299,7 @@ established</computeroutput> message. </sect2> <sect2> -<title>Samba-3 as the Trusted Domain</title> +<title>Samba as the Trusting Domain</title> <para> This time activities are somewhat reversed. Again, we'll assume that your domain @@ -202,14 +307,16 @@ controlled by the Samba PDC is called SAMBA and NT-controlled domain is called R </para> <para> -The very first thing requirement is to add an account for the SAMBA domain on RUMBA's PDC. +The very first step is to add an account for the SAMBA domain on RUMBA's PDC. </para> +<indexterm><primary>User Manager</primary></indexterm> + <para> Launch the <application>Domain User Manager</application>, then from the menu select <guimenu>Policies</guimenu>, <guimenuitem>Trust Relationships</guimenuitem>. -Now, next to <guilabel>Trusted Domains</guilabel> box press the <guibutton>Add</guibutton> -button, and type in the name of the trusted domain (SAMBA) and password securing +Now, next to the <guilabel>Trusted Domains</guilabel> box press the <guibutton>Add</guibutton> +button, and type in the name of the trusted domain (SAMBA) and the password to use in securing the relationship. </para> @@ -229,12 +336,12 @@ Using your favourite shell while being logged in as root, issue this command: <para> You will be prompted for the password you just typed on your Windows NT4 Server box. -Do not worry if you see an error message that mentions a returned code of -<errorname>NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT</errorname>. It means the +Do not worry if you see an error message that mentions a return code of +NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT. It means the password you gave is correct and the NT4 Server says the account is ready for interdomain connection and not for ordinary -connection. After that, be patient it can take a while (especially -in large networks), you should see the <computeroutput>Success</computeroutput> message. +connection. After that, be patient; it can take a while (especially +in large networks), but eventually you should see the <computeroutput>Success</computeroutput> message. Congratulations! Your trust relationship has just been established. </para> @@ -247,6 +354,34 @@ the <filename>secrets.tdb</filename> file. </sect1> <sect1> +<title>NT4-style Domain Trusts with Windows 2000</title> +<para> +Although <application>Domain User Manager</application> is not present in Windows 2000, it is +also possible to establish an NT4-style trust relationship with a Windows 2000 domain +controller running in mixed mode as the trusting server. It should also be possible for +Samba to trust a Windows 2000 server, however, more testing is still needed in this area. +</para> + +<para> +After <link linkend="samba-trusted-domain">creating the interdomain trust account on the +Samba server</link> as described above, open <application>Active Directory Domains and +Trusts</application> on the AD controller of the domain whose resources you wish Samba users +to have access to. Remember that since NT4-style trusts are not transitive, if you want +your users to have access to multiple mixed-mode domains in your AD forest, you will need to +repeat this process for each of those domains. With <application>Active Directory Domains +and Trusts</application> open, right-click on the name of the Active Directory domain that +will trust our Samba domain and choose <guimenuitem>Properties</guimenuitem>, then click on +the <guilabel>Trusts</guilabel> tab. In the upper part of the panel, you will see a list box +labelled <guilabel>Domains trusted by this domain:</guilabel>, and an +<guilabel>Add...</guilabel> button next to it. Press this button, and just as with NT4, you +will be prompted for the trusted domain name and the relationship password. Press OK, and +after a moment, Active Directory will respond with <computeroutput>The trusted domain has +been added and the trust has been verified.</computeroutput> Your Samba users can now be +granted acess to resources in the AD domain. +</para> +</sect1> + +<sect1> <title>Common Errors</title> <para> @@ -255,39 +390,6 @@ or that suffer regular outages. Network stability and integrity are key concerns distributed trusted domains. </para> - <sect2> - <title>Tell me about Trust Relationships using Samba</title> - - <para> - Like many, I administer multiple LANs connected together using NT trust - relationships. This was implemented about 4 years ago. I now have the - occasion to consider performing this same task again, but this time, I - would like to implement it solely through samba - no Microsoft PDCs - anywhere. - </para> - - <para> - I have read documentation on samba.org regarding NT-style trust - relationships and am now wondering, can I do what I want to? I already - have successfully implemented 2 samba servers, but they are not PDCs. - They merely act as file servers. I seem to remember, and it appears to - be true (according to samba.org) that trust relationships are a - challenge. - </para> - - <para> - Please provide any helpful feedback that you may have. - </para> - - <para> - These are almost complete in Samba 3.0 snapshots. The main catch - is getting winbindd to be able to allocate UID/GIDs for trusted - users/groups. See the updated Samba HOWTO collection for more - details. - </para> - - </sect2> - </sect1> </chapter> diff --git a/docs/docbook/projdoc/NT4Migration.xml b/docs/docbook/projdoc/NT4Migration.xml index 8c2d0e19f3..36bafee2af 100644 --- a/docs/docbook/projdoc/NT4Migration.xml +++ b/docs/docbook/projdoc/NT4Migration.xml @@ -38,25 +38,24 @@ pressure to return to a Microsoft based platform solution at the first sign of t </para> <para> -It is strongly advised that before attempting a migration to a Samba-3 controlled network -that every possible effort be made to gain all-round commitment to the change. Firstly, you -should know precisely <emphasis>why</emphasis> the change is important for the organisation. -Possible motivations to make a change include: +Before attempting a migration to a Samba-3 controlled network make every possible effort to +gain all-round commitment to the change. Know precisely <emphasis>why</emphasis> the change +is important for the organisation. Possible motivations to make a change include: </para> -<simplelist> - <member>Improve network manageability</member> - <member>Obtain better user level functionality</member> - <member>Reduce network operating costs</member> - <member>Reduce exposure caused by Microsoft withdrawal of NT4 support</member> - <member>Avoid MS License 6 implications</member> - <member>Reduce organisation's dependency on Microsoft</member> -</simplelist> +<itemizedlist> + <listitem><para>Improve network manageability</para></listitem> + <listitem><para>Obtain better user level functionality</para></listitem> + <listitem><para>Reduce network operating costs</para></listitem> + <listitem><para>Reduce exposure caused by Microsoft withdrawal of NT4 support</para></listitem> + <listitem><para>Avoid MS License 6 implications</para></listitem> + <listitem><para>Reduce organisation's dependency on Microsoft</para></listitem> +</itemizedlist> <para> -It is vital that it be well recognised that Samba-3 is NOT MS Windows NT4. Samba-3 offers -an alternative solution that is both different from MS Windows NT4 and that offers some -advantages compared with it. It should also be recognised that Samba-3 lacks many of the +Make sure that everyone knows that Samba-3 is NOT MS Windows NT4. Samba-3 offers +an alternative solution that is both different from MS Windows NT4 and that offers +advantages compared with it. Gain recognition that Samba-3 lacks many of the features that Microsoft has promoted as core values in migration from MS Windows NT4 to MS Windows 2000 and beyond (with or without Active Directory services). </para> @@ -65,37 +64,37 @@ MS Windows 2000 and beyond (with or without Active Directory services). What are the features that Samba-3 can NOT provide? </para> -<simplelist> - <member>Active Directory Server</member> - <member>Group Policy Objects (in Active Directory)</member> - <member>Machine Policy objects</member> - <member>Logon Scripts in Active Directory</member> - <member>Software Application and Access Controls in Active Directory</member> -</simplelist> +<itemizedlist> + <listitem><para>Active Directory Server</para></listitem> + <listitem><para>Group Policy Objects (in Active Directory)</para></listitem> + <listitem><para>Machine Policy objects</para></listitem> + <listitem><para>Logon Scripts in Active Directory</para></listitem> + <listitem><para>Software Application and Access Controls in Active Directory</para></listitem> +</itemizedlist> <para> The features that Samba-3 DOES provide and that may be of compelling interest to your site includes: </para> -<simplelist> - <member>Lower Cost of Ownership</member> - <member>Global availability of support with no strings attached</member> - <member>Dynamic SMB Servers (ie:Can run more than one server per Unix/Linux system)</member> - <member>Creation of on-the-fly logon scripts</member> - <member>Creation of on-the-fly Policy Files</member> - <member>Greater Stability, Reliability, Performance and Availability</member> - <member>Manageability via an ssh connection</member> - <member>Flexible choices of back-end authentication technologies (tdbsam, ldapsam, mysqlsam)</member> - <member>Ability to implement a full single-sign-on architecture</member> - <member>Ability to distribute authentication systems for absolute minimum wide area network bandwidth demand</member> -</simplelist> +<itemizedlist> + <listitem><para>Lower Cost of Ownership</para></listitem> + <listitem><para>Global availability of support with no strings attached</para></listitem> + <listitem><para>Dynamic SMB Servers (ie:Can run more than one server per Unix/Linux system)</para></listitem> + <listitem><para>Creation of on-the-fly logon scripts</para></listitem> + <listitem><para>Creation of on-the-fly Policy Files</para></listitem> + <listitem><para>Greater Stability, Reliability, Performance and Availability</para></listitem> + <listitem><para>Manageability via an ssh connection</para></listitem> + <listitem><para>Flexible choices of back-end authentication technologies (tdbsam, ldapsam, mysqlsam)</para></listitem> + <listitem><para>Ability to implement a full single-sign-on architecture</para></listitem> + <listitem><para>Ability to distribute authentication systems for absolute minimum wide area network bandwidth demand</para></listitem> +</itemizedlist> <para> -Before migrating a network from MS Windows NT4 to Samba-3 it is vital that all necessary factors are -considered. Users should be educated about changes they may experience so that the change will be a -welcome one and not become an obstacle to the work they need to do. The following are some of the -factors that will go into a successful migration: +Before migrating a network from MS Windows NT4 to Samba-3 consider all necessary factors. Users +should be educated about changes they may experience so that the change will be a welcome one +and not become an obstacle to the work they need to do. The following are factors that will +help ensure a successful migration: </para> <sect3> @@ -106,26 +105,25 @@ Samba-3 can be configured as a domain controller, a back-up domain controller (p a secondary controller), a domain member, or as a stand-alone server. The Windows network security domain context should be sized and scoped before implementation. Particular attention needs to be paid to the location of the primary domain controller (PDC) as well as backup controllers (BDCs). -It should be noted that one way in which Samba-3 differs from Microsoft technology is that if one -chooses to use an LDAP authentication backend then the same database can be used by several different -domains. This means that in a complex organisation there can be a single LDAP database, that itself -can be distributed, that can simultaneously serve multiple domains (that can also be widely distributed). +One way in which Samba-3 differs from Microsoft technology is that if one chooses to use an LDAP +authentication backend then the same database can be used by several different domains. In a +complex organisation there can be a single LDAP database, which itself can be distributed (ie: Have +a master server and multiple slave servers) that can simultaneously serve multiple domains. </para> <para> -It is recommended that from a design perspective, the number of users per server, as well as the number -of servers, per domain should be scaled according to needs and should also consider server capacity -and network bandwidth. +From a design perspective, the number of users per server, as well as the number of servers, per +domain should be scaled taking into consideration server capacity and network bandwidth. </para> <para> -A physical network segment may house several domains, each of which may span multiple network segments. -Where domains span routed network segments it is most advisable to consider and test the performance -implications of the design and layout of a network. A Centrally located domain controller that is being -designed to serve multiple routed network segments may result in severe performance problems if the -response time (eg: ping timing) between the remote segment and the PDC is more than 100 ms. In situations -where the delay is too long it is highly recommended to locate a backup controller (BDC) to serve as -the local authentication and access control server. +A physical network segment may house several domains. Each may span multiple network segments. +Where domains span routed network segments, consider and test the performance implications of +the design and layout of a network. A Centrally located domain controller that is designed to +serve multiple routed network segments may result in severe performance problems. Check the +response time (eg: ping timing) between the remote segment and the PDC. If long (more than 100 ms) +locate a backup controller (BDC) on the remote segmanet to serve as the local authentication and +access control server. </para> </sect3> @@ -133,18 +131,17 @@ the local authentication and access control server. <title>Server Share and Directory Layout</title> <para> -There are few cardinal rules to effective network design that can be broken with impunity. -The most important rule of effective network management is that simplicity is king in every -well controlled network. Every part of the infrastructure must be managed, the more complex -it is, the greater will be the demand of keeping systems secure and functional. +There are cardinal rules to effective network design. These can not be broken with impunity. +The most important rule: Simplicity is king in every well controlled network. Every part of +the infrastructure must be managed, the more complex it is, the greater will be the demand +of keeping systems secure and functional. </para> <para> -The nature of the data that must be stored needs to be born in mind when deciding how many -shares must be created. The physical disk space layout should also be taken into account -when designing where share points will be created. Keep in mind that all data needs to be -backed up, thus the simpler the disk layout the easier it will be to keep track of what must -be backed up to tape or other off-line storage medium. Always plan and implement for minimum +Keep in mind the nature of how data must be share. Physical disk space layout should be considered +carefully. Some data must be backed up. The simpler the disk layout the easier it will be to +keep track of backed needs. Identify what back media will be meet needs, consider backup to tape +, CD-ROM or (DVD-ROM), or other off-line storage medium. Plan and implement for minimum maintenance. Leave nothing to chance in your design, above all, do not leave backups to chance: Backup and test, validate every backup, create a disaster recovery plan and prove that it works. </para> @@ -156,13 +153,14 @@ directories may substantially avoid file access complaints from samba share user </para> <para> -Many network administrators who are new to the game will attempt to use elaborate techniques -to set access controls, on files, directories, shares, as well as in share definitions. -There is the ever present danger that that administrator's successor will not understand the -complex mess that has been inherited. Remember, apparent job security through complex design -and implementation may ultimately cause loss of operations and downtime to users as the new -administrator learns to untangle your web. Keep access controls simple and effective and -make sure that users will never be interrupted by the stupidity of complexity. +Inexperienced network administrators often attempt elaborate techniques to set access +controls on files, directories, shares, as well as in share definitions. +Keep your design and implementation simple and document your design extensively. Have others +audit your documentation. Do not create a complex mess that your successor will not understand. +Remember, job security through complex design and implementation may cause loss of operations +and downtime to users as the new administrator learns to untangle your knots. Keep access +controls simple and effective and make sure that users will never be interrupted by stupid +complexity. </para> </sect3> @@ -170,16 +168,14 @@ make sure that users will never be interrupted by the stupidity of complexity. <title>Logon Scripts</title> <para> -Please refer to the section of this document on Advanced Network Administration for information -regarding the network logon script options for Samba-3. Logon scripts can help to ensure that -all users gain share and printer connections they need. +Logon scripts can help to ensure that all users gain share and printer connections they need. </para> <para> -Logon scripts can be created on-the-fly so that all commands executed are specific to the -rights and privileges granted to the user. The preferred controls should be affected through +Logon scripts can be created 'on-the-fly' so that all commands executed are specific to the +rights and priviliges granted to the user. The preferred controls should be affected through group membership so that group information can be used to custom create a logon script using -the <parameter>root preexec</parameter> parameters to the <filename>NETLOGON</filename> share. +the <smbconfoption><name>root preexec</name></smbconfoption> parameters to the <smbconfsection>NETLOGON</smbconfsection> share. </para> <para> @@ -211,8 +207,8 @@ to be changed to the SID of the Samba-3 domain. <para> It is possible to migrate all account settings from an MS Windows NT4 domain to Samba-3. Before attempting to migrate user and group accounts it is STRONGLY advised to create in Samba-3 the -groups that are present on the MS Windows NT4 domain <emphasis>AND</emphasis> to connect these to -suitable Unix/Linux groups. Following this simple advice will mean that all user and group attributes +groups that are present on the MS Windows NT4 domain <emphasis>AND</emphasis> to map these to +suitable Unix/Linux groups. By following this simple advice all user and group attributes should migrate painlessly. </para> </sect3> @@ -232,7 +228,8 @@ You will have an NT4 PDC that has the users, groups, policies and profiles to be </para></listitem> <listitem><para> -Samba-3 set up as a DC with netlogon share, profile share, etc. +Samba-3 set up as a DC with netlogon share, profile share, etc. Configure the &smb.conf; file +to fucntion as a BDC. ie: <parameter>domain master = No</parameter>. </para></listitem> </itemizedlist> @@ -240,23 +237,6 @@ Samba-3 set up as a DC with netlogon share, profile share, etc. <step><para>Create a BDC account for the samba server using NT Server Manager</para> <substeps><step><para>Samba must NOT be running</para></step></substeps></step> - <step> - <para><userinput>rpcclient <replaceable>NT4PDC</replaceable> -U Administrator%<replaceable>passwd</replaceable></userinput></para> - <substeps><step><para>lsaquery</para></step> - <step><para>Note the SID returned</para></step> - </substeps> - </step> - - <step><para><userinput>net getsid -S <replaceable>NT4PDC</replaceable> -w <replaceable>DOMNAME</replaceable> -U Administrator%<replaceable>passwd</replaceable></userinput></para> - <substeps><step><para>Note the SID</para></step></substeps> - </step> - - <step><para><userinput>net getlocalsid</userinput></para> - <substeps> - <step><para>Note the SID, now check that all three SIDS reported are the same!</para></step> - </substeps> - </step> - <step><para><userinput>net rpc join -S <replaceable>NT4PDC</replaceable> -w <replaceable>DOMNAME</replaceable> -U Administrator%<replaceable>passwd</replaceable></userinput></para></step> <step><para><userinput>net rpc vampire -S <replaceable>NT4PDC</replaceable> -U administrator%<replaceable>passwd</replaceable></userinput></para></step> @@ -265,24 +245,33 @@ Samba-3 set up as a DC with netlogon share, profile share, etc. <substeps><step><para>Note - did the users migrate?</para></step></substeps> </step> - <step><para><userinput>initGrps.sh <replaceable>DOMNAME</replaceable></userinput></para></step> + <step><para> + Now assign each of the UNIX groups to NT groups: + (Note: It may be useful to copy this text to a script called + <filename>initGroups.sh</filename>) + <programlisting> +#!/bin/bash +#### Keep this as a shell script for future re-use + +# First assign well known domain global groups +net groupmap modify ntgroup="Domain Admins" unixgroup=ntadmins +net groupmap modify ntgroup="Domain Guests" unixgroup=nobody +net groupmap modify ntgroup="Domain Users" unixgroup=users + +# Now for our added domain global groups +net groupmap add ntgroup="Designers" unixgroup=designers type=d rid=3200 +net groupmap add ntgroup="Engineers" unixgroup=engineers type=d rid=3210 +net groupmap add ntgroup="QA Team" unixgroup=qateam type=d rid=3220 +</programlisting> + </para></step> <step><para><userinput>net groupmap list</userinput></para> <substeps><step><para>Now check that all groups are recognised</para></step></substeps> </step> - - <step><para><userinput>net rpc vampire -S <replaceable>NT4PDC</replaceable> -U administrator%<replaceable>passwd</replaceable></userinput></para></step> - - <step><para><userinput>pdbedit -Lv</userinput></para> - <substeps><step> - <para>Note - check that all group membership has been migrated</para> - </step></substeps> - </step> </procedure> <para> -Now it is time to migrate all the profiles, then migrate all policy files. -More later. +Now migrate all the profiles, then migrate all policy files. </para> </sect2> @@ -292,13 +281,14 @@ More later. <title>Migration Options</title> <para> -Based on feedback from many sites as well as from actual installation and maintenance -experience sites that wish to migrate from MS Windows NT4 Domain Control to a Samba -based solution fit into three basic categories. +Sites that wish to migrate from MS Windows NT4 Domain Control to a Samba based solution +generally fit into three basic categories. </para> <table frame="all"><title>The 3 Major Site Types</title> <tgroup cols="2"> + <colspec align="left"/> + <colspec align="justify"/> <thead> <row><entry>Number of Users</entry><entry>Description</entry></row> </thead> @@ -333,7 +323,7 @@ to Samba-3. </itemizedlist> <para> -No matter what choice you make, the following rules will minimise down-stream problems: +Minimise down-stream problems by: </para> <itemizedlist> @@ -354,8 +344,11 @@ No matter what choice you make, the following rules will minimise down-stream pr </para></listitem> </itemizedlist> -<table frame="top"><title>Nature of the Conversion Choices</title> +<table frame="all"><title>Nature of the Conversion Choices</title> <tgroup cols="3"> + <colspec align="justify"/> + <colspec align="justify"/> + <colspec align="justify"/> <thead> <row><entry>Simple</entry><entry>Upgraded</entry><entry>Redesign</entry></row> </thead> @@ -396,68 +389,103 @@ No matter what choice you make, the following rules will minimise down-stream pr </sect2> <sect2> -<title>Samba Implementation Choices</title> - -<!-- FIXME: Either a better layout or more written-out text--> -<para><programlisting> -Authentication database back end - Winbind (external Samba or NT4/200x server) - Can use pam_mkhomedir.so to auto-create home dirs - External server could use Active Directory or NT4 Domain - -Database type - smbpasswd, tdbsam, ldapsam, mysqlsam - -Access Control Points - On the Share itself (Use NT4 Server Manager) - On the file system - Unix permissions on files and directories - Enable Posix ACLs in file system? - Through Samba share parameters - Not recommended - except as only resort - -Policies (migrate or create new ones) - Group Policy Editor (NT4) - Watch out for Tattoo effect - -User and Group Profiles - Platform specific so use platform tool to change from a Local - to a Roaming profile Can use new profiles tool to change SIDs - (NTUser.DAT) - -Logon Scripts (Know how they work) - -User and Group mapping to Unix/Linux - username map facility may be needed - Use 'net groupmap' to connect NT4 groups to Unix groups - Use pdbedit to set/change user configuration -NOTE: -If migrating to LDAP back end it may be easier to dump initial LDAP database -to LDIF, then edit, then reload into LDAP - - OS specific scripts / programs may be needed - Add / delete Users - Note OS limits on size of name (Linux 8 chars) - NT4 up to 254 chars - Add / delete machines - Applied only to domain members (note up to 16 chars) - Add / delete Groups - Note OS limits on size and nature - Linux limit is 16 char, - no spaces and no upper case chars (groupadd) - -Migration Tools - Domain Control (NT4 Style) - Profiles, Policies, Access Controls, Security - -Migration Tools - Samba: net, rpcclient, smbpasswd, pdbedit, profiles - Windows: NT4 Domain User Manager, Server Manager (NEXUS) - -Authentication - New SAM back end (smbpasswd, tdbsam, ldapsam, mysqlsam) -</programlisting> -</para> +<title>Samba-3 Implementation Choices</title> + +<variablelist> + <varlistentry><term>Authentication database/back end:</term><listitem> + <para> + Samba-3 can use an external authentication backend: + </para> + + <para> + <itemizedlist> + <listitem><para>Winbind (external Samba or NT4/200x server)</para></listitem> + <listitem><para>External server could use Active Directory or NT4 Domain</para></listitem> + <listitem><para>Can use pam_mkhomedir.so to auto-create home dirs</para></listitem> + </itemizedlist> + </para> + + <para> + Samba-3 can use a local authentication backend: + <itemizedlist> + <listitem><para>smbpasswd, tdbsam, ldapsam, mysqlsam</para></listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + + <varlistentry><term>Access Control Points:</term><listitem> + <itemizedlist> + <listitem><para>On the Share itself - using Share ACLs</para></listitem> + <listitem><para>On the file system - using UNIX permissions on files and directories</para> + <para>Note: Can Enable Posix ACLs in file system also</para></listitem> + <listitem><para>Through Samba share parameters - Not recommended - except as last resort</para></listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry><term>Policies (migrate or create new ones):</term><listitem> + <itemizedlist> + <listitem><para>Using Group Policy Editor (NT4)</para></listitem> + <listitem><para>- Watch out for Tattoo effect</para></listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry><term>User and Group Profiles:</term><listitem> + <para> + Platform specific so use platform tool to change from a Local to a Roaming profile + Can use new profiles tool to change SIDs (NTUser.DAT) + </para> + </listitem> + </varlistentry> + + <varlistentry><term>Logon Scripts:</term><listitem> + <para> + Know how they work + </para> + </listitem> + </varlistentry> + + <varlistentry><term>User and Group mapping to Unix/Linux:</term><listitem> + <itemizedlist> + <listitem><para>username map facility may be needed</para></listitem> + <listitem><para>Use 'net groupmap' to connect NT4 groups to Unix groups</para></listitem> + <listitem><para>Use pdbedit to set/change user configuration</para> + + <para> + NOTE: When migrating to LDAP back, end it may be easier to dump initial + LDAP database to LDIF, then edit, then reload into LDAP + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry><term>OS specific scripts/programs may be needed:</term><listitem> + <itemizedlist> + <listitem><para>Add/Delete Users: Note OS limits on size of name + (Linux 8 chars) NT4 up to 254 chars</para></listitem> + <listitem><para>Add/Delete Machines: Applied only to domain members + (Note: Machine names may be limited to 16 characters)</para></listitem> + <listitem><para>Use 'net groupmap' to connect NT4 groups to Unix groups</para></listitem> + <listitem><para>Add/Delete Groups: Note OS limits on size and nature. + Linux limit is 16 char, no spaces and no upper case chars (groupadd)</para></listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry><term>Migration Tools:</term><listitem> + <para> + Domain Control (NT4 Style) Profiles, Policies, Access Controls, Security + <itemizedlist> + <listitem><para>Samba: net, rpcclient, smbpasswd, pdbedit, profiles</para></listitem> + <listitem><para>Windows: NT4 Domain User Manager, Server Manager (NEXUS)</para></listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> +</variablelist> </sect2> diff --git a/docs/docbook/projdoc/NetworkBrowsing.xml b/docs/docbook/projdoc/NetworkBrowsing.xml index c87ede5906..2db154be33 100644 --- a/docs/docbook/projdoc/NetworkBrowsing.xml +++ b/docs/docbook/projdoc/NetworkBrowsing.xml @@ -1,6 +1,7 @@ <chapter id="NetworkBrowsing"> <chapterinfo> &author.jht; + &author.jelmer; <pubdate>July 5, 1998</pubdate> <pubdate>Updated: April 21, 2003</pubdate> </chapterinfo> @@ -31,6 +32,8 @@ they were the best of times. The more we look back, them more we long for what w hope it never returns!</emphasis>. </para> +<indexterm><primary>NetBIOS</primary></indexterm> + <para> For many MS Windows network administrators, that statement sums up their feelings about NetBIOS networking precisely. For those who mastered NetBIOS networking, its fickle @@ -64,7 +67,7 @@ help Samba to affect stable WINS operations beyond the normal scope of MS WINS. <para> Please note that WINS is exclusively a service that applies only to those systems that run NetBIOS over TCP/IP. MS Windows 200x / XP have the capacity to turn off -support for NetBIOS, in which case WINS is of no relevance. Samba-3 supports this also. +support for NetBIOS, in which case WINS is of no relevance. Samba supports this also. </para> <para> @@ -88,46 +91,43 @@ What seems so simple is in fact a very complex interaction of different technolo The technologies (or methods) employed in making all of this work includes: </para> -<simplelist> - <member>MS Windows machines register their presence to the network</member> - <member>Machines announce themselves to other machines on the network</member> - <member>One or more machine on the network collates the local announcements</member> - <member>The client machine finds the machine that has the collated list of machines</member> - <member>The client machine is able to resolve the machine names to IP addresses</member> - <member>The client machine is able to connect to a target machine</member> -</simplelist> +<itemizedlist> + <listitem><para>MS Windows machines register their presence to the network</para></listitem> + <listitem><para>Machines announce themselves to other machines on the network</para></listitem> + <listitem><para>One or more machine on the network collates the local announcements</para></listitem> + <listitem><para>The client machine finds the machine that has the collated list of machines</para></listitem> + <listitem><para>The client machine is able to resolve the machine names to IP addresses</para></listitem> + <listitem><para>The client machine is able to connect to a target machine</para></listitem> +</itemizedlist> <para> The Samba application that controls browse list management and name resolution is called <filename>nmbd</filename>. The configuration parameters involved in nmbd's operation are: </para> -<para><programlisting> - <!--FIXME--> - Browsing options: - ----------------- - * os level - lm announce - lm interval - * preferred master - * local master - * domain master - browse list - enhanced browsing - - Name Resolution Method: - ----------------------- - * name resolve order - - WINS options: - ------------- - dns proxy - wins proxy - * wins server - * wins support - wins hook -</programlisting></para> +<para>Browsing options: <smbconfoption><name>os level</name></smbconfoption>(*), + <smbconfoption><name>lm announce</name></smbconfoption>, + <smbconfoption><name>lm interval</name></smbconfoption>, + <smbconfoption><name>preferred master</name></smbconfoption>(*), + <smbconfoption><name>local master</name></smbconfoption>(*), + <smbconfoption><name>domain master</name></smbconfoption>(*), + <smbconfoption><name>browse list</name></smbconfoption>, + <smbconfoption><name>enhanced browsing</name></smbconfoption>. +</para> + +<para>Name Resolution Method: + <smbconfoption><name>name resolve order</name></smbconfoption>(*). +</para> + +<para>WINS options: + <smbconfoption><name>dns proxy</name></smbconfoption>, + <smbconfoption><name>wins proxy</name></smbconfoption>, + <smbconfoption><name>wins server</name></smbconfoption>(*), + <smbconfoption><name>wins support</name></smbconfoption>(*), + <smbconfoption><name>wins hook</name></smbconfoption>. +</para> +<indexterm><primary>WINS</primary></indexterm> <para> For Samba, the WINS Server and WINS Support are mutually exclusive options. Those marked with an '*' are the only options that commonly MAY need to be modified. Even if not one of these @@ -156,11 +156,13 @@ affect browse list management. When running NetBIOS over TCP/IP, this uses UDP b UDP messages can be broadcast or unicast. </para> +<indexterm><primary>UDP</primary></indexterm> + <para> Normally, only unicast UDP messaging can be forwarded by routers. The -<command>remote announce</command> parameter to smb.conf helps to project browse announcements +<smbconfoption><name>remote announce</name></smbconfoption> parameter to smb.conf helps to project browse announcements to remote network segments via unicast UDP. Similarly, the -<command>remote browse sync</command> parameter of <filename>smb.conf</filename> +<smbconfoption><name>remote browse sync</name></smbconfoption> parameter of &smb.conf; implements browse list collation using unicast UDP. </para> @@ -170,14 +172,15 @@ wherever possible <filename>nmbd</filename> should be configured on one (1) mach server. This makes it easy to manage the browsing environment. If each network segment is configured with it's own Samba WINS server, then the only way to get cross segment browsing to work is by using the -<command>remote announce</command> and the <command>remote browse sync</command> -parameters to your <filename>smb.conf</filename> file. +<smbconfoption><name>remote announce</name></smbconfoption> and the <smbconfoption><name>remote browse sync</name></smbconfoption> +parameters to your &smb.conf; file. </para> <para> +<indexterm><primary>WINS</primary></indexterm> If only one WINS server is used for an entire multi-segment network then -the use of the <command>remote announce</command> and the -<command>remote browse sync</command> parameters should NOT be necessary. +the use of the <smbconfoption><name>remote announce</name></smbconfoption> and the +<smbconfoption><name>remote browse sync</name></smbconfoption> parameters should NOT be necessary. </para> <para> @@ -192,7 +195,7 @@ Right now Samba WINS does not support MS-WINS replication. This means that when setting up Samba as a WINS server there must only be one <filename>nmbd</filename> configured as a WINS server on the network. Some sites have used multiple Samba WINS servers for redundancy (one server per subnet) and then used -<command>remote browse sync</command> and <command>remote announce</command> +<smbconfoption><name>remote browse sync</name></smbconfoption> and <smbconfoption><name>remote announce</name></smbconfoption> to affect browse list collation across all segments. Note that this means clients will only resolve local names, and must be configured to use DNS to resolve names on other subnets in order to resolve the IP addresses of the servers they can see @@ -213,6 +216,9 @@ minutes to stabilise, particularly across network segments. <title>TCP/IP - without NetBIOS</title> <para> +<indexterm><primary>NetBIOS</primary></indexterm> +<indexterm><primary>NetBIOS-less</primary></indexterm> +<indexterm><primary>DNS</primary></indexterm> All TCP/IP using systems use various forms of host name resolution. The primary methods for TCP/IP hostname resolutions involves either a static file (<filename>/etc/hosts </filename>) or DNS (the Domain Name System). DNS is the technology that makes @@ -253,6 +259,8 @@ it follows a defined path: </para></listitem> </orderedlist> +<indexterm><primary>DNS</primary></indexterm> + <para> Windows 200x / XP can register it's host name with a Dynamic DNS server. You can force register with a Dynamic DNS server in Windows 200x / XP using: @@ -277,8 +285,10 @@ records that are needed for Active Directory. <sect2> <title>DNS and Active Directory</title> +<indexterm><primary>DNS</primary><secondary>Active Directory</secondary></indexterm> + <para> -Occasionally we hear from Unix network administrators who want to use a Unix based Dynamic +Occasionally we hear from UNIX network administrators who want to use a UNIX based Dynamic DNS server in place of the Microsoft DNS server. While this might be desirable to some, the MS Windows 200x DNS server is auto-configured to work with Active Directory. It is possible to use BIND version 8 or 9, but it will almost certainly be necessary to create service records @@ -353,7 +363,7 @@ 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 -<command>remote announce</command> parameter). +<smbconfoption><name>remote announce</name></smbconfoption> parameter). </para> <para> @@ -391,14 +401,12 @@ inability to use the network services. <para> Samba supports a feature that allows forced synchronisation -of browse lists across routed networks using the <command>remote -browse sync</command> parameter in the <filename>smb.conf</filename> file. +of browse lists across routed networks using the <smbconfoption><name>remote browse sync</name></smbconfoption> 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 <command>remote -browse sync</command> parameter provides browse list synchronisation - and +based name resolution, but it should be noted that the <smbconfoption><name>remote browse sync</name></smbconfoption> 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. @@ -406,7 +414,7 @@ This mechanism could be via DNS, <filename>/etc/hosts</filename>, and so on. </para> -<sect2> +<sect2 id="DMB"> <title>Setting up WORKGROUP Browsing</title> <para> @@ -427,29 +435,31 @@ cross subnet browsing possible for a workgroup. In an WORKGROUP environment the domain master browser must be a Samba server, and there must only be one domain master browser per workgroup name. To set up a Samba server as a domain master browser, -set the following option in the <parameter>[global]</parameter> section +set the following option in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; file : </para> <para> -<programlisting> - domain master = yes -</programlisting> +<smbconfblock> +<smbconfoption><name>domain master</name><value>yes</value></smbconfoption> +</smbconfblock> </para> <para> -The domain master browser should also preferrably be the local master +The domain master browser should also preferably be the local master browser for its own subnet. In order to achieve this set the following -options in the <parameter>[global]</parameter> section of the &smb.conf; file : +options in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; file : </para> <para> -<programlisting> - domain master = yes - local master = yes - preferred master = yes - os level = 65 -</programlisting> + <smbconfexample> + <title>Domain master browser smb.conf</title> + <smbconfsection>[global]</smbconfsection> +<smbconfoption><name>domain master</name><value>yes</value></smbconfoption> +<smbconfoption><name>local master</name><value>yes</value></smbconfoption> +<smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> +<smbconfoption><name>os level</name><value>65</value></smbconfoption> +</smbconfexample> </para> <para> @@ -464,17 +474,19 @@ workgroup. Any MS Windows NT/2K/XP/2003 machine should be able to do this, as will Windows 9x machines (although these tend to get rebooted more often, so it's not such a good idea to use these). To make a Samba server a local master browser -set the following options in the <parameter>[global]</parameter> section of the +set the following options in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; file : </para> <para> -<programlisting> - domain master = no - local master = yes - preferred master = yes - os level = 65 -</programlisting> +<smbconfexample> + <title>Local master browser smb.conf</title> + <smbconfsection>[global]</smbconfsection> +<smbconfoption><name>domain master</name><value>no</value></smbconfoption> +<smbconfoption><name>local master</name><value>yes</value></smbconfoption> +<smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> +<smbconfoption><name>os level</name><value>65</value></smbconfoption> +</smbconfexample> </para> <para> @@ -484,9 +496,9 @@ master browser. </para> <para> -The <parameter>local master</parameter> parameter allows Samba to act as a -local master browser. The <parameter>preferred master</parameter> causes nmbd -to force a browser election on startup and the <parameter>os level</parameter> +The <smbconfoption><name>local master</name></smbconfoption> parameter allows Samba to act as a +local master browser. The <smbconfoption><name>preferred master</name></smbconfoption> causes nmbd +to force a browser election on startup and the <smbconfoption><name>os level</name></smbconfoption> parameter sets Samba high enough so that it should win any browser elections. </para> @@ -494,17 +506,19 @@ parameter sets Samba high enough so that it should win any browser elections. If you have an NT machine on the subnet that you wish to be the local master browser then you can disable Samba from becoming a local master browser by setting the following -options in the <parameter>[global]</parameter> section of the +options in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; file : </para> <para> -<programlisting> - domain master = no - local master = no - preferred master = no - os level = 0 -</programlisting> +<smbconfexample> + <title>smb.conf for not being a master browser</title> + <smbconfsection>[global]</smbconfsection> +<smbconfoption><name>domain master</name><value>no</value></smbconfoption> +<smbconfoption><name>local master</name><value>no</value></smbconfoption> +<smbconfoption><name>preferred master</name><value>no</value></smbconfoption> +<smbconfoption><name>os level</name><value>0</value></smbconfoption> +</smbconfexample> </para> </sect2> @@ -526,22 +540,24 @@ with WINS instead of the PDC. For subnets other than the one containing the Windows NT PDC you may set up Samba servers as local master browsers as described. To make a Samba server a local master browser set -the following options in the <command>[global]</command> section +the following options in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; file : </para> <para> -<programlisting> - domain master = no - local master = yes - preferred master = yes - os level = 65 -</programlisting> + <smbconfexample> + <title>Local master browser smb.conf</title> + <smbconfsection>[global]</smbconfsection> +<smbconfoption><name>domain master</name><value>no</value></smbconfoption> +<smbconfoption><name>local master</name><value>yes</value></smbconfoption> +<smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> +<smbconfoption><name>os level</name><value>65</value></smbconfoption> +</smbconfexample> </para> <para> If you wish to have a Samba server fight the election with machines -on the same subnet you may set the <parameter>os level</parameter> parameter +on the same subnet you may set the <smbconfoption><name>os level</name></smbconfoption> parameter to lower levels. By doing this you can tune the order of machines that will become local master browsers if they are running. For more details on this see the section <link linkend="browse-force-master"> @@ -554,17 +570,19 @@ If you have Windows NT machines that are members of the domain on all subnets, and you are sure they will always be running then you can disable Samba from taking part in browser elections and ever becoming a local master browser by setting following options -in the <parameter>[global]</parameter> section of the &smb.conf; +in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; file : </para> <para> -<programlisting> - domain master = no - local master = no - preferred master = no - os level = 0 -</programlisting> +<smbconfexample> + <title>smb.conf for not being a master browser</title> + <smbconfsection>[global]</smbconfsection> +<smbconfoption><name>domain master</name><value>no</value></smbconfoption> +<smbconfoption><name>local master</name><value>no</value></smbconfoption> +<smbconfoption><name>preferred master</name><value>no</value></smbconfoption> +<smbconfoption><name>os level</name><value>0</value></smbconfoption> +</smbconfexample> </para> </sect2> @@ -573,7 +591,7 @@ file : <title>Forcing Samba to be the master</title> <para> -Who becomes the <parameter>master browser</parameter> is determined by an election +Who becomes the master browser is determined by an election process using broadcasts. Each election packet contains a number of parameters which determine what precedence (bias) a host should have in the election. By default Samba uses a very low precedence and thus loses @@ -581,14 +599,14 @@ elections to just about anyone else. </para> <para> -If you want Samba to win elections then just set the <parameter>os level</parameter> global +If you want Samba to win elections then just set the <smbconfoption><name>os level</name></smbconfoption> global option in &smb.conf; to a higher number. It defaults to 0. Using 34 would make it win all elections over every other system (except other samba systems!) </para> <para> -A <parameter>os level</parameter> of 2 would make it beat WfWg and Win95, but not MS Windows +A <smbconfoption><name>os level</name></smbconfoption> of 2 would make it beat WfWg and Win95, but not MS Windows NT/2K Server. A MS Windows NT/2K Server domain controller uses level 32. </para> @@ -596,18 +614,18 @@ NT/2K Server. A MS Windows NT/2K Server domain controller uses level 32. <para> If you want Samba to force an election on startup, then set the -<parameter>preferred master</parameter> global option in &smb.conf; to <constant>yes</constant>. Samba will +<smbconfoption><name>preferred master</name></smbconfoption> global option in &smb.conf; to <constant>yes</constant>. Samba will then have a slight advantage over other potential master browsers that are not preferred master browsers. Use this parameter with care, as if you have two hosts (whether they are Windows 95 or NT or -Samba) on the same local subnet both set with <parameter>preferred master</parameter> to +Samba) on the same local subnet both set with <smbconfoption><name>preferred master</name></smbconfoption> to <constant>yes</constant>, then periodically and continually they will force an election in order to become the local master browser. </para> <para> -If you want Samba to be a <parameter>domain master browser</parameter>, then it is -recommended that you also set <parameter>preferred master</parameter> to <constant>yes</constant>, because + If you want Samba to be a <emphasis>domain master browser</emphasis>, then it is +recommended that you also set <smbconfoption><name>preferred master</name></smbconfoption> to <constant>yes</constant>, because Samba will not become a domain master browser for the whole of your LAN or WAN if it is not also a local master browser on its own broadcast isolated subnet. @@ -631,7 +649,7 @@ the current domain master browser fail. <para> The domain master is responsible for collating the browse lists of multiple subnets so that browsing can occur between subnets. You can -make Samba act as the domain master by setting <parameter>domain master = yes</parameter> +make Samba act as the domain master by setting <smbconfoption><name>domain master</name><value>yes</value></smbconfoption> in &smb.conf;. By default it will not be a domain master. </para> @@ -649,8 +667,8 @@ browse lists. <para> If you want Samba to be the domain master then I suggest you also set -the <parameter>os level</parameter> high enough to make sure it wins elections, and set -<parameter>preferred master</parameter> to <constant>yes</constant>, to get Samba to force an election on +the <smbconfoption><name>os level</name></smbconfoption> high enough to make sure it wins elections, and set +<smbconfoption><name>preferred master</name></smbconfoption> to <constant>yes</constant>, to get Samba to force an election on startup. </para> @@ -720,30 +738,34 @@ that browsing and name lookups won't work. <para> Samba now supports machines with multiple network interfaces. If you -have multiple interfaces then you will need to use the <command>interfaces</command> +have multiple interfaces then you will need to use the <smbconfoption><name>interfaces</name></smbconfoption> option in &smb.conf; to configure them. </para> </sect2> <sect2> <title>Use of the Remote Announce parameter</title> <para> -The <parameter>remote announce</parameter> parameter of -<filename>smb.conf</filename> can be used to forcibly ensure +The <smbconfoption><name>remote announce</name></smbconfoption> parameter of +&smb.conf; can be used to forcibly ensure that all the NetBIOS names on a network get announced to a remote network. -The syntax of the <parameter>remote announce</parameter> parameter is: -<programlisting> - remote announce = a.b.c.d [e.f.g.h] ... -</programlisting> +The syntax of the <smbconfoption><name>remote announce</name></smbconfoption> parameter is: +<smbconfblock> +<smbconfoption><name>remote announce</name><value>a.b.c.d [e.f.g.h] ...</value></smbconfoption> +</smbconfblock> <emphasis>or</emphasis> -<programlisting> - remote announce = a.b.c.d/WORKGROUP [e.f.g.h/WORKGROUP] ... -</programlisting> +<smbconfblock> +<smbconfoption><name>remote announce</name><value>a.b.c.d/WORKGROUP [e.f.g.h/WORKGROUP] ...</value></smbconfoption> +</smbconfblock> where: <variablelist> <varlistentry><term><replaceable>a.b.c.d</replaceable> and <replaceable>e.f.g.h</replaceable></term> -<listitem><para>is either the LMB (Local Master Browser) IP address +<listitem><para> + <indexterm><primary>LMB</primary><see>Local Master Browser</see></indexterm> +<indexterm><primary>Local Master Browser</primary></indexterm> + + is either the LMB (Local Master Browser) IP address or the broadcast address of the remote network. ie: the LMB is at 192.168.1.10, or the address could be given as 192.168.1.255 where the netmask @@ -774,19 +796,19 @@ name resolution problems and should be avoided. <title>Use of the Remote Browse Sync parameter</title> <para> -The <parameter>remote browse sync</parameter> parameter of -<filename>smb.conf</filename> is used to announce to +The <smbconfoption><name>remote browse sync</name></smbconfoption> parameter of +&smb.conf; is used to announce to another LMB that it must synchronise its NetBIOS name list with our Samba LMB. It works ONLY if the Samba server that has this option is simultaneously the LMB on its network segment. </para> <para> -The syntax of the <parameter>remote browse sync</parameter> parameter is: +The syntax of the <smbconfoption><name>remote browse sync</name></smbconfoption> parameter is: -<programlisting> -remote browse sync = <replaceable>a.b.c.d</replaceable> -</programlisting> +<smbconfblock> +<smbconfoption><name>remote browse sync</name><value><replaceable>a.b.c.d</replaceable></value></smbconfoption> +</smbconfblock> where <replaceable>a.b.c.d</replaceable> is either the IP address of the remote LMB or else is the network broadcast address of the remote segment. @@ -850,18 +872,18 @@ errors. <para> To configure Samba as a WINS server just add -<parameter>wins support = yes</parameter> to the <filename>smb.conf</filename> -file [globals] section. +<smbconfoption><name>wins support</name><value>yes</value></smbconfoption> to the &smb.conf; +file [global] section. </para> <para> To configure Samba to register with a WINS server just add -<parameter>wins server = a.b.c.d</parameter> to your &smb.conf; file <parameter>[globals]</parameter> section. +<smbconfoption><name>wins server</name><value>a.b.c.d</value></smbconfoption> to your &smb.conf; file <smbconfsection>[global]</smbconfsection> section. </para> <important><para> -Never use both <parameter>wins support = yes</parameter> together -with <parameter>wins server = a.b.c.d</parameter> +Never use both <smbconfoption><name>wins support</name><value>yes</value></smbconfoption> together +with <smbconfoption><name>wins server</name><value>a.b.c.d</value></smbconfoption> particularly not using it's own IP address. Specifying both will cause &nmbd; to refuse to start! </para></important> @@ -873,13 +895,13 @@ Specifying both will cause &nmbd; to refuse to start! Either a Samba machine or a Windows NT Server machine may be set up as a WINS server. To set a Samba machine to be a WINS server you must add the following option to the &smb.conf; file on the selected machine : -in the <parameter>[globals]</parameter> section add the line +in the <smbconfsection>[global]</smbconfsection> section add the line </para> <para> -<programlisting> - wins support = yes -</programlisting> + <smbconfblock> +<smbconfoption><name>wins support</name><value>yes</value></smbconfoption> +</smbconfblock> </para> <para> @@ -890,13 +912,13 @@ least set the parameter to 'no' on all these machines. </para> <para> -Machines with <parameter>wins support = yes</parameter> will keep a list of +Machines with <smbconfoption><name>wins support</name><value>yes</value></smbconfoption> will keep a list of all NetBIOS names registered with them, acting as a DNS for NetBIOS names. </para> <para> You should set up only ONE WINS server. Do NOT set the -<parameter>wins support = yes</parameter> option on more than one Samba +<smbconfoption><name>wins support</name><value>yes</value></smbconfoption> option on more than one Samba server. </para> @@ -910,7 +932,7 @@ participate in these replications. It is possible in the future that a Samba->Samba WINS replication protocol may be defined, in which case more than one Samba machine could be set up as a WINS server but currently only one Samba server should have the -<parameter>wins support = yes</parameter> parameter set. +<smbconfoption><name>wins support</name><value>yes</value></smbconfoption> parameter set. </para> <para> @@ -920,14 +942,14 @@ of this WINS server. If your WINS server is a Samba machine, fill in the Samba machine IP address in the <guilabel>Primary WINS Server</guilabel> field of the <guilabel>Control Panel->Network->Protocols->TCP->WINS Server</guilabel> dialogs in Windows 95 or Windows NT. To tell a Samba server the IP address -of the WINS server add the following line to the <parameter>[global]</parameter> section of +of the WINS server add the following line to the <smbconfsection>[global]</smbconfsection> section of all &smb.conf; files : </para> <para> -<programlisting> - wins server = <name or IP address> -</programlisting> + <smbconfblock> +<smbconfoption><name>wins server</name><value><name or IP address></value></smbconfoption> +</smbconfblock> </para> <para> @@ -938,8 +960,8 @@ machine or its IP address. <para> Note that this line MUST NOT BE SET in the &smb.conf; file of the Samba server acting as the WINS server itself. If you set both the -<parameter>wins support = yes</parameter> option and the -<parameter>wins server = <name></parameter> option then +<smbconfoption><name>wins support</name><value>yes</value></smbconfoption> option and the +<smbconfoption><name>wins server</name><value><name></value></smbconfoption> option then nmbd will fail to start. </para> @@ -968,7 +990,7 @@ section of the documentation to provide usage and technical details. <title>Static WINS Entries</title> <para> -Adding static entries to your Samba-3 WINS server is actually fairly easy. +Adding static entries to your Samba WINS server is actually fairly easy. All you have to do is add a line to <filename>wins.dat</filename>, typically located in <filename class="directory">/usr/local/samba/var/locks</filename>. </para> @@ -1072,37 +1094,36 @@ of methods. The only ones that can provide NetBIOS name_type information are: </para> -<simplelist> - <member>WINS: the best tool!</member> - <member>LMHOSTS: is static and hard to maintain.</member> - <member>Broadcast: uses UDP and can not resolve names across remote segments.</member> -</simplelist> +<itemizedlist> + <listitem><para>WINS: the best tool!</para></listitem> + <listitem><para>LMHOSTS: is static and hard to maintain.</para></listitem> + <listitem><para>Broadcast: uses UDP and can not resolve names across remote segments.</para></listitem> +</itemizedlist> <para> Alternative means of name resolution includes: </para> -<simplelist> -<member><filename>/etc/hosts</filename>: is static, hard to maintain, and lacks name_type info</member> -<member>DNS: is a good choice but lacks essential name_type info.</member> -</simplelist> +<itemizedlist> +<listitem><para><filename>/etc/hosts</filename>: is static, hard to maintain, and lacks name_type info</para></listitem> +<listitem><para>DNS: is a good choice but lacks essential name_type info.</para></listitem> +</itemizedlist> <para> Many sites want to restrict DNS lookups and want to avoid broadcast name -resolution traffic. The <parameter>name resolve order</parameter> parameter is -of great help here. The syntax of the <parameter>name resolve order</parameter> -parameter is: -<programlisting> -name resolve order = wins lmhosts bcast host -</programlisting> +resolution traffic. The <parameter>name resolve order</parameter> parameter is of great help here. +The syntax of the <parameter>name resolve order</parameter> parameter is: +<smbconfblock> +<smbconfoption><name>name resolve order</name><value>wins lmhosts bcast host</value></smbconfoption> +</smbconfblock> <emphasis>or</emphasis> -<programlisting> -name resolve order = wins lmhosts (eliminates bcast and host) -</programlisting> +<smbconfblock> +<smbconfoption><name>name resolve order</name><value>wins lmhosts (eliminates bcast and host)</value></smbconfoption> +</smbconfblock> The default is: -<programlisting> -name resolve order = host lmhost wins bcast -</programlisting> -where "host" refers the the native methods used by the Unix system +<smbconfblock> +<smbconfoption><name>name resolve order</name><value>host lmhost wins bcast</value></smbconfoption> +</smbconfblock> +where "host" refers to the native methods used by the UNIX system to implement the gethostbyname() function call. This is normally controlled by <filename>/etc/host.conf</filename>, <filename>/etc/nsswitch.conf</filename> and <filename>/etc/resolv.conf</filename>. </para> @@ -1114,7 +1135,7 @@ controlled by <filename>/etc/host.conf</filename>, <filename>/etc/nsswitch.conf< <para> SMB networking provides a mechanism by which clients can access a list -of machines in a network, a so-called <parameter>browse list</parameter>. This list +of machines in a network, a so-called <smbconfoption><name>browse list</name></smbconfoption>. This list contains machines that are ready to offer file and/or print services to other machines within the network. Thus it does not include machines which aren't currently able to do server tasks. The browse @@ -1176,7 +1197,7 @@ recommended that you use one and only one Samba server as your WINS server. <para> To get browsing to work you need to run nmbd as usual, but will need -to use the <parameter>workgroup</parameter> option in &smb.conf; +to use the <smbconfoption><name>workgroup</name></smbconfoption> option in &smb.conf; to control what workgroup Samba becomes a part of. </para> @@ -1184,7 +1205,7 @@ to control what workgroup Samba becomes a part of. Samba also has a useful option for a Samba server to offer itself for browsing on another subnet. It is recommended that this option is only used for 'unusual' purposes: announcements over the internet, for -example. See <parameter>remote announce</parameter> in the +example. See <smbconfoption><name>remote announce</name></smbconfoption> in the &smb.conf; man page. </para> </sect2> @@ -1207,7 +1228,7 @@ hit enter and filemanager should display the list of available shares. <para> Some people find browsing fails because they don't have the global -<parameter>guest account</parameter> set to a valid account. Remember that the +<smbconfoption><name>guest account</name></smbconfoption> set to a valid account. Remember that the IPC$ connection that lists the shares is done as guest, and thus you must have a valid guest account. </para> @@ -1268,28 +1289,10 @@ Samba is capable of cross subnet browsing when configured correctly. </para> <para> -Consider a network set up as follows : + Consider a network set up as <link linkend="browsing1">in the diagram below</link>. </para> -<para> - <!-- FIXME: Convert this to diagram --> -<programlisting> - (DMB) - N1_A N1_B N1_C N1_D N1_E - | | | | | - ------------------------------------------------------- - | subnet 1 | - +---+ +---+ - |R1 | Router 1 Router 2 |R2 | - +---+ +---+ - | | - | subnet 2 subnet 3 | - -------------------------- ------------------------------------ - | | | | | | | | - N2_A N2_B N2_C N2_D N3_A N3_B N3_C N3_D - (WINS) -</programlisting> -</para> +<image><imagedescription>Cross subnet browsing example</imagedescription><imagefile>browsing1</imagefile></image> <para> Consisting of 3 subnets (1, 2, 3) connected by two routers @@ -1388,14 +1391,19 @@ are done the browse lists look like : <para> <table frame="all"> <title>Browse subnet example 2</title> - <tgroup align="left" cols="3"> + <tgroup cols="3"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="justify"/> <thead> <row><entry>Subnet</entry><entry>Browse Master</entry><entry>List</entry></row> </thead> <tbody> - <row><entry>Subnet1</entry><entry>N1_C</entry><entry>N1_A, N1_B, N1_C, N1_D, N1_E, N2_A(*), N2_B(*), N2_C(*), N2_D(*)</entry></row> - <row><entry>Subnet2</entry><entry>N2_B</entry><entry>N2_A, N2_B, N2_C, N2_D, N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*)</entry></row> + <row><entry>Subnet1</entry><entry>N1_C</entry><entry>N1_A, N1_B, N1_C, N1_D, N1_E, +N2_A(*), N2_B(*), N2_C(*), N2_D(*)</entry></row> + <row><entry>Subnet2</entry><entry>N2_B</entry><entry>N2_A, N2_B, N2_C, N2_D, N1_A(*), +N1_B(*), N1_C(*), N1_D(*), N1_E(*)</entry></row> <row><entry>Subnet3</entry><entry>N3_D</entry><entry>N3_A, N3_B, N3_C, N3_D</entry></row> </tbody> </tgroup> @@ -1411,7 +1419,7 @@ subnet 3 will still only see the servers on their own subnet. </para> <para> -The same sequence of events that occured for N2_B now occurs +The same sequence of events that occurred for N2_B now occurs for the local master browser on subnet 3 (N3_D). When it synchronizes browse lists with the domain master browser (N1_A) it gets both the server entries on subnet 1, and those on @@ -1423,14 +1431,21 @@ the browse lists look like. <table frame="all"> <title>Browse subnet example 3</title> <tgroup cols="3" align="left"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="justify"/> + <thead> <row><entry>Subnet</entry><entry>Browse Master</entry><entry>List</entry></row> </thead> <tbody> - <row><entry>Subnet1</entry><entry>N1_C</entry><entry>N1_A, N1_B, N1_C, N1_D, N1_E, N2_A(*), N2_B(*), N2_C(*), N2_D(*), N3_A(*), N3_B(*), N3_C(*), N3_D(*)</entry></row> - <row><entry>Subnet2</entry><entry>N2_B</entry><entry>N2_A, N2_B, N2_C, N2_D, N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*)</entry></row> - <row><entry>Subnet3</entry><entry>N3_D</entry><entry>N3_A, N3_B, N3_C, N3_D, N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*), N2_A(*), N2_B(*), N2_C(*), N2_D(*)</entry></row> + <row><entry>Subnet1</entry><entry>N1_C</entry><entry>N1_A, N1_B, N1_C, N1_D, N1_E, +N2_A(*), N2_B(*), N2_C(*), N2_D(*), N3_A(*), N3_B(*), N3_C(*), N3_D(*)</entry></row> + <row><entry>Subnet2</entry><entry>N2_B</entry><entry>N2_A, N2_B, N2_C, N2_D, N1_A(*), +N1_B(*), N1_C(*), N1_D(*), N1_E(*)</entry></row> + <row><entry>Subnet3</entry><entry>N3_D</entry><entry>N3_A, N3_B, N3_C, N3_D, N1_A(*), +N1_B(*), N1_C(*), N1_D(*), N1_E(*), N2_A(*), N2_B(*), N2_C(*), N2_D(*)</entry></row> </tbody> </tgroup> </table> @@ -1455,14 +1470,24 @@ are removed or shut off) the browse lists will look like : <table frame="all"> <title>Browse subnet example 4</title> <tgroup cols="3" align="left"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="justify"/> + <thead> <row><entry>Subnet</entry><entry>Browse Master</entry><entry>List</entry></row> </thead> <tbody> - <row><entry>Subnet1</entry><entry>N1_C</entry><entry>N1_A, N1_B, N1_C, N1_D, N1_E, N2_A(*), N2_B(*), N2_C(*), N2_D(*), N3_A(*), N3_B(*), N3_C(*), N3_D(*)</entry></row> - <row><entry>Subnet2</entry><entry>N2_B</entry><entry>N2_A, N2_B, N2_C, N2_D, N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*), N3_A(*), N3_B(*), N3_C(*), N3_D(*)</entry></row> - <row><entry>Subnet3</entry><entry>N3_D</entry><entry>N3_A, N3_B, N3_C, N3_D, N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*), N2_A(*), N2_B(*), N2_C(*), N2_D(*)</entry></row> + <row><entry>Subnet1</entry><entry>N1_C</entry><entry>N1_A, N1_B, N1_C, N1_D, N1_E, +N2_A(*), N2_B(*), N2_C(*), N2_D(*), N3_A(*), N3_B(*), +N3_C(*), N3_D(*)</entry></row> + <row><entry>Subnet2</entry><entry>N2_B</entry><entry>N2_A, N2_B, N2_C, N2_D, N1_A(*), +N1_B(*), N1_C(*), N1_D(*), N1_E(*), N3_A(*), N3_B(*), +N3_C(*), N3_D(*)</entry></row> + <row><entry>Subnet3</entry><entry>N3_D</entry><entry>N3_A, N3_B, N3_C, N3_D, N1_A(*), +N1_B(*), N1_C(*), N1_D(*), N1_E(*), N2_A(*), N2_B(*), +N2_C(*), N2_D(*)</entry></row> </tbody> </tgroup> </table> @@ -1544,8 +1569,23 @@ guest account for browsing in smbd. Check that your guest account is valid. </para> -<para>See also <parameter>guest account</parameter> in the &smb.conf; man page.</para> +<para>See also <smbconfoption><name>guest account</name></smbconfoption> in the &smb.conf; man page.</para> + +</sect2> +<sect2> + <title>I get an <errorname>Unable to browse the network</errorname> error</title> + + <para>This error can have multiple causes:</para> + + <itemizedlist> + <listitem><para>There is no local master browser. Configure &nmbd; + or any other machine to serve as local master browser.</para></listitem> + <listitem><para>You can not log onto the machine that is the local master + browser. Can you logon to it as guest user? </para></listitem> + <listitem><para>There is no IP connectivity to the local master browser. + Can you reach it by broadcast?</para></listitem> +</itemizedlist> </sect2> </sect1> diff --git a/docs/docbook/projdoc/Other-Clients.xml b/docs/docbook/projdoc/Other-Clients.xml index d05c58c89d..968a584f9d 100644 --- a/docs/docbook/projdoc/Other-Clients.xml +++ b/docs/docbook/projdoc/Other-Clients.xml @@ -1,8 +1,7 @@ <chapter id="Other-Clients"> <chapterinfo> - &author.jmcd; &author.jelmer; - + <author>&person.jmcd;<contrib>OS/2</contrib></author> <pubdate>5 Mar 2001</pubdate> </chapterinfo> @@ -14,7 +13,7 @@ <title>Macintosh clients?</title> <para> -Yes. <ulink url="http://www.thursby.com/">Thursby</ulink> now has a CIFS Client / Server called <ulink url="http://www.thursby.com/products/dave.html">DAVE</ulink> + Yes. <ulink url="http://www.thursby.com/">Thursby</ulink> now has a CIFS Client / Server called <ulink url="http://www.thursby.com/products/dave.html">DAVE</ulink> </para> <para> @@ -36,29 +35,27 @@ the Macintosh. The two free implementations are What Samba offers MS Windows users, these packages offer to Macs. For more info on these packages, Samba, and Linux (and other UNIX-based systems) see -<ulink url="http://www.eats.com/linux_mac_win.html">http://www.eats.com/linux_mac_win.html</ulink> +<ulink noescape="1" url="http://www.eats.com/linux_mac_win.html">http://www.eats.com/linux_mac_win.html</ulink> </para> +<para>Newer versions of the Macintosh (Mac OS X) include Samba.</para> + </sect1> <sect1> <title>OS2 Client</title> <sect2> - <title>How can I configure OS/2 Warp Connect or - OS/2 Warp 4 as a client for Samba?</title> + <title>Configuring OS/2 Warp Connect or + OS/2 Warp 4 as a client for Samba</title> - <para>A more complete answer to this question can be - found on <ulink url="http://carol.wins.uva.nl/~leeuw/samba/warp.html"> - http://carol.wins.uva.nl/~leeuw/samba/warp.html</ulink>.</para> - <para>Basically, you need three components:</para> - <simplelist> - <member>The File and Print Client ('IBM Peer')</member> - <member>TCP/IP ('Internet support') </member> - <member>The "NetBIOS over TCP/IP" driver ('TCPBEUI')</member> - </simplelist> + <itemizedlist> + <listitem><para>The File and Print Client ('IBM Peer')</para></listitem> + <listitem><para>TCP/IP ('Internet support') </para></listitem> + <listitem><para>The "NetBIOS over TCP/IP" driver ('TCPBEUI')</para></listitem> + </itemizedlist> <para>Installing the first two together with the base operating system on a blank system is explained in the Warp manual. If Warp @@ -83,16 +80,14 @@ packages, Samba, and Linux (and other UNIX-based systems) see </sect2> <sect2> - <title>How can I configure OS/2 Warp 3 (not Connect), - OS/2 1.2, 1.3 or 2.x for Samba?</title> + <title>Configuring OS/2 Warp 3 (not Connect), + OS/2 1.2, 1.3 or 2.x for Samba</title> <para>You can use the free Microsoft LAN Manager 2.2c Client for OS/2 from - <ulink url="ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/"> + <ulink noescape="1" url="ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/"> ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/</ulink>. - See <ulink url="http://carol.wins.uva.nl/~leeuw/lanman.html"> - http://carol.wins.uva.nl/~leeuw/lanman.html</ulink> for - more information on how to install and use this client. In + In a nutshell, edit the file \OS2VER in the root directory of the OS/2 boot partition and add the lines:</para> @@ -105,24 +100,22 @@ packages, Samba, and Linux (and other UNIX-based systems) see <para>before you install the client. Also, don't use the included NE2000 driver because it is buggy. Try the NE2000 or NS2000 driver from - <ulink url="ftp://ftp.cdrom.com/pub/os2/network/ndis/"> + <ulink noescape="1" url="ftp://ftp.cdrom.com/pub/os2/network/ndis/"> ftp://ftp.cdrom.com/pub/os2/network/ndis/</ulink> instead. </para> </sect2> <sect2> - <title>How do I get printer driver download working - for OS/2 clients?</title> + <title>Printer driver download for for OS/2 clients?</title> - <para>First, create a share called <parameter>[PRINTDRV]</parameter> that is + <para>First, create a share called <smbconfsection>[PRINTDRV]</smbconfsection> that is world-readable. Copy your OS/2 driver files there. Note that the .EA_ files must still be separate, so you will need to use the original install files, and not copy an installed driver from an OS/2 system.</para> <para>Install the NT driver first for that printer. Then, - add to your &smb.conf; a parameter, <parameter>os2 driver map = - <replaceable>filename</replaceable></parameter>. Then, in the file + add to your &smb.conf; a parameter, <smbconfoption><name>os2 driver map</name><value><replaceable>filename</replaceable></value></smbconfoption>. Then, in the file specified by <replaceable>filename</replaceable>, map the name of the NT driver name to the OS/2 driver name as follows:</para> @@ -148,7 +141,7 @@ packages, Samba, and Linux (and other UNIX-based systems) see <title>Windows for Workgroups</title> <sect2> -<title>Use latest TCP/IP stack from Microsoft</title> +<title>Latest TCP/IP stack from Microsoft</title> <para>Use the latest TCP/IP stack from Microsoft if you use Windows for Workgroups. @@ -194,7 +187,7 @@ Often WfWg will totally ignore a password you give it in a dialog box. </sect2> <sect2> -<title>Configure WfW password handling</title> + <title>Configuring WfW password handling</title> <para> There is a program call admincfg.exe @@ -203,7 +196,7 @@ type <userinput>EXPAND A:\ADMINCFG.EX_ C:\WINDOWS\ADMINCFG.EXE</userinput>. Then add an icon for it via the <application>Program Manager</application> <guimenu>New</guimenu> Menu. This program allows you to control how WFW handles passwords. ie disable Password Caching etc -for use with <parameter>security = user</parameter> +for use with <smbconfoption><name>security</name><value>user</value></smbconfoption> </para> </sect2> @@ -211,7 +204,7 @@ for use with <parameter>security = user</parameter> <sect2> <title>Case handling of passwords</title> -<para>Windows for Workgroups uppercases the password before sending it to the server. Unix passwords can be case-sensitive though. Check the <ulink url="smb.conf.5.html">smb.conf(5)</ulink> information on <parameter>password level</parameter> to specify what characters samba should try to uppercase when checking.</para> +<para>Windows for Workgroups uppercases the password before sending it to the server. Unix passwords can be case-sensitive though. Check the &smb.conf; information on <smbconfoption><name>password level</name></smbconfoption> to specify what characters samba should try to uppercase when checking.</para> </sect2> @@ -230,8 +223,8 @@ It is presumably a WfWg bug.</para> <title>Speed improvement</title> <para> -Note that some people have found that setting <parameter>DefaultRcvWindow</parameter> in -the <parameter>[MSTCP]</parameter> section of the + Note that some people have found that setting <parameter>DefaultRcvWindow</parameter> in +the <smbconfsection>[MSTCP]</smbconfsection> section of the <filename>SYSTEM.INI</filename> file under WfWg to 3072 gives a big improvement. I don't know why. </para> @@ -304,15 +297,15 @@ likely occur if it is not. <para> In order to serve profiles successfully to Windows 2000 SP2 clients (when not operating as a PDC), Samba must have -<parameter>nt acl support = no</parameter> +<smbconfoption><name>nt acl support</name><value>no</value></smbconfoption> added to the file share which houses the roaming profiles. If this is not done, then the Windows 2000 SP2 client will complain about not being able to access the profile (Access Denied) and create multiple copies of it on disk (DOMAIN.user.001, DOMAIN.user.002, etc...). See the -<ulink url="smb.conf.5.html">smb.conf(5)</ulink> man page +&smb.conf; man page for more details on this option. Also note that the -<parameter>nt acl support</parameter> parameter was formally a global parameter in +<smbconfoption><name>nt acl support</name></smbconfoption> parameter was formally a global parameter in releases prior to Samba 2.2.2. </para> @@ -320,14 +313,15 @@ releases prior to Samba 2.2.2. The following is a minimal profile share: </para> -<para><programlisting> - [profile] - path = /export/profile - create mask = 0600 - directory mask = 0700 - nt acl support = no - read only = no -</programlisting></para> +<para><smbconfexample> + <title>Minimal profile share</title> +<smbconfsection>[profile]</smbconfsection> +<smbconfoption><name>path</name><value>/export/profile</value></smbconfoption> +<smbconfoption><name>create mask</name><value>0600</value></smbconfoption> +<smbconfoption><name>directory mask</name><value>0700</value></smbconfoption> +<smbconfoption><name>nt acl support</name><value>no</value></smbconfoption> +<smbconfoption><name>read only</name><value>no</value></smbconfoption> +</smbconfexample></para> <para> The reason for this bug is that the Win2k SP2 client copies @@ -339,7 +333,7 @@ for the <errorname>access denied</errorname> message. </para> <para> -By disabling the <parameter>nt acl support</parameter> parameter, Samba will send +By disabling the <smbconfoption><name>nt acl support</name></smbconfoption> parameter, Samba will send the Win2k client a response to the QuerySecurityDescriptor trans2 call which causes the client to set a default ACL for the profile. This default ACL includes @@ -356,7 +350,7 @@ create accounts on the Samba host for Domain users.</para></note> <title>Windows NT 3.1</title> <para>If you have problems communicating across routers with Windows -NT 3.1 workstations, read <ulink url="http://support.microsoft.com/default.aspx?scid=kb;[LN];Q103765">this Microsoft Knowledge Base article</ulink>. +NT 3.1 workstations, read <ulink url="http://support.microsoft.com/default.aspx?scid=kb;Q103765">this Microsoft Knowledge Base article</ulink>. </para> diff --git a/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml b/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml index 660efdd295..addd646057 100644 --- a/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml +++ b/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml @@ -14,7 +14,7 @@ <para> This chapter you should help you to deploy winbind based authentication on any PAM enabled -Unix/Linux system. Winbind can be used to enable user level application access authentication +UNIX/Linux system. Winbind can be used to enable user level application access authentication from any MS Windows NT Domain, MS Windows 200x Active Directory based domain, or any Samba based domain environment. It will also help you to configure PAM based local host access controls that are appropriate to your Samba configuration. @@ -33,7 +33,7 @@ The use of Winbind require more than PAM configuration alone. Please refer to <l <title>Features and Benefits</title> <para> -A number of Unix systems (eg: Sun Solaris), as well as the xxxxBSD family and Linux, +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>) @@ -50,7 +50,7 @@ located in <filename>/etc/pam.d</filename>. </para> <para> -On PAM enabled Unix/Linux systems it is an easy matter to configure the system to use any +On PAM enabled UNIX/Linux systems it is an easy matter to configure the system to use any authentication backend, so long as the appropriate dynamically loadable library modules are available for it. The backend may be local to the system, or may be centralised on a remote server. @@ -61,15 +61,15 @@ PAM support modules are available for: </para> <variablelist> - <varlistentry><term><filename>/etc/passwd</filename></term><listitem><para>-</para> + <varlistentry><term><filename>/etc/passwd</filename>:</term><listitem> <para> - There are several PAM modules that interact with this standard Unix user + There are several PAM modules that interact with this standard UNIX user database. The most common are called: pam_unix.so, pam_unix2.so, pam_pwdb.so and pam_userdb.so. </para> </listitem></varlistentry> - <varlistentry><term>Kerberos</term><listitem><para>-</para> + <varlistentry><term>Kerberos:</term><listitem> <para> The pam_krb5.so module allows the use of any Kerberos compliant server. This tool is used to access MIT Kerberos, Heimdal Kerberos, and potentially @@ -77,7 +77,7 @@ PAM support modules are available for: </para> </listitem></varlistentry> - <varlistentry><term>LDAP</term><listitem><para>-</para> + <varlistentry><term>LDAP:</term><listitem> <para> The pam_ldap.so module allows the use of any LDAP v2 or v3 compatible backend server. Commonly used LDAP backend servers include: OpenLDAP v2.0 and v2.1, @@ -85,28 +85,28 @@ PAM support modules are available for: </para> </listitem></varlistentry> - <varlistentry><term>NetWare Bindery</term><listitem><para>-</para> + <varlistentry><term>NetWare Bindery:</term><listitem> <para> The pam_ncp_auth.so module allows authentication off any bindery enabled NetWare Core Protocol based server. </para> </listitem></varlistentry> - <varlistentry><term>SMB Password</term><listitem><para>-</para> + <varlistentry><term>SMB Password:</term><listitem> <para> This module, called pam_smbpass.so, will allow user authentication off the passdb backend that is configured in the Samba &smb.conf; file. </para> </listitem></varlistentry> - <varlistentry><term>SMB Server</term><listitem><para>-</para> + <varlistentry><term>SMB Server:</term><listitem> <para> The pam_smb_auth.so module is the original MS Windows networking authentication tool. This module has been somewhat outdated by the Winbind module. </para> </listitem></varlistentry> - <varlistentry><term>Winbind</term><listitem><para>-</para> + <varlistentry><term>Winbind:</term><listitem> <para> The pam_winbind.so module allows Samba to obtain authentication from any MS Windows Domain Controller. It can just as easily be used to authenticate @@ -114,7 +114,7 @@ PAM support modules are available for: </para> </listitem></varlistentry> - <varlistentry><term>RADIUS</term><listitem><para>-</para> + <varlistentry><term>RADIUS:</term><listitem> <para> There is a PAM RADIUS (Remote Access Dial-In User Service) authentication module. In most cases the administrator will need to locate the source code @@ -172,9 +172,9 @@ is located outside the default then the path must be specified as: </para> <para> -<screen> +<programlisting> auth required /other_path/pam_strange_module.so -</screen> +</programlisting> </para> <sect3> @@ -183,8 +183,7 @@ auth required /other_path/pam_strange_module.so <para> The remaining information in this subsection was taken from the documentation of the Linux-PAM project. For more information on PAM, see -<ulink url="http://ftp.kernel.org/pub/linux/libs/pam/"> -http://ftp.kernel.org/pub/linux/libs/pam</ulink> The Official Linux-PAM home page. +<ulink url="http://ftp.kernel.org/pub/linux/libs/pam/">The Official Linux-PAM home page</ulink> </para> <para> @@ -192,9 +191,9 @@ A general configuration line of the /etc/pam.conf file has the following form: </para> <para> -<screen> +<programlisting> service-name module-type control-flag module-path args -</screen> +</programlisting> </para> <para> @@ -204,7 +203,7 @@ Once we have explained the meaning of the above tokens, we will describe this me </para> <variablelist> - <varlistentry><term>service-name</term><listitem><para>-</para> + <varlistentry><term>service-name:</term><listitem> <para> The name of the service associated with this entry. Frequently the service name is the conventional name of the given application. For example, `ftpd', `rlogind' and `su', etc. . @@ -214,10 +213,11 @@ Once we have explained the meaning of the above tokens, we will describe this me There is a special service-name, reserved for defining a default authentication mechanism. It has the name `OTHER' and may be specified in either lower or upper case characters. Note, when there is a module specified for a named service, the `OTHER' entries are ignored. - </para></listitem> + </para> + </listitem> </varlistentry> - <varlistentry><term>module-type</term><listitem><para>-</para> + <varlistentry><term>module-type:</term><listitem> <para> One of (currently) four types of module. The four types are as follows: </para> @@ -250,10 +250,11 @@ Once we have explained the meaning of the above tokens, we will describe this me token associated with the user. Typically, there is one module for each `challenge/response' based authentication (auth) module-type. </para></listitem> - </itemizedlist></listitem> + </itemizedlist> + </listitem> </varlistentry> - <varlistentry><term>control-flag</term><listitem><para>-</para> + <varlistentry><term>control-flag:</term><listitem> <para> The control-flag is used to indicate how the PAM library will react to the success or failure of the module it is associated with. Since modules can be stacked (modules of the same type execute in series, @@ -316,9 +317,9 @@ Once we have explained the meaning of the above tokens, we will describe this me consists of a series of value=action tokens: </para> - <para><screen> - [value1=action1 value2=action2 ...] - </screen></para> +<para><programlisting> +[value1=action1 value2=action2 ...] +</programlisting></para> <para> Here, value1 is one of the following return values: success; open_err; symbol_err; service_err; @@ -409,7 +410,7 @@ Once we have explained the meaning of the above tokens, we will describe this me </listitem> </varlistentry> - <varlistentry><term>module-path</term><listitem><para>-</para> + <varlistentry><term>module-path:</term><listitem> <para> The path-name of the dynamically loadable object file; the pluggable module itself. If the first character of the module path is `/', it is assumed to be a complete path. If this is not the case, the given module path is appended @@ -427,27 +428,28 @@ Once we have explained the meaning of the above tokens, we will describe this me Note, if you wish to include spaces in an argument, you should surround that argument with square brackets. For example: </para> -<para><screen> +<para><programlisting> squid auth required pam_mysql.so user=passwd_query passwd=mada \ db=eminence [query=select user_name from internet_service where \ user_name='%u' and password=PASSWORD('%p') and \ service='web_proxy'] -</screen></para> +</programlisting></para> <para> Note, when using this convention, you can include `[' characters inside the string, and if you wish to include a `]' character inside the string that will survive the argument parsing, you should use `\['. In other words: </para> -<para><screen> +<para><programlisting><!--FIXME:Diagram--> [..[..\]..] --> ..[..].. -</screen></para> +</programlisting></para> <para> Any line in (one of) the configuration file(s), that is not formatted correctly, will generally tend (erring on the side of caution) to make the authentication process fail. A corresponding error is written to the system log files with a call to syslog(3). - </para></listitem> + </para> + </listitem> </varlistentry> </variablelist> @@ -469,7 +471,7 @@ by commenting them out except the calls to <filename>pam_pwdb.so</filename>. <sect3> <title>PAM: original login config</title> -<para><screen> +<para><programlisting> #%PAM-1.0 # The PAM configuration file for the `login' service # @@ -484,7 +486,7 @@ session required pam_pwdb.so # session optional pam_lastlog.so # password required pam_cracklib.so retry=3 password required pam_pwdb.so shadow md5 -</screen></para> +</programlisting></para> </sect3> @@ -496,7 +498,7 @@ PAM allows use of replaceable modules. Those available on a sample system includ </para> <para><prompt>$</prompt><userinput>/bin/ls /lib/security</userinput> -<screen> +<programlisting> 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 @@ -509,7 +511,7 @@ 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 -</screen></para> +</programlisting></para> <para> The following example for the login program replaces the use of @@ -522,7 +524,7 @@ 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 +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 by specifying the <option>--with-pam_smbpass</option> options when running Samba's @@ -532,7 +534,7 @@ in the <filename>source/pam_smbpass</filename> directory of the Samba source distribution. </para> -<para><screen> +<para><programlisting> #%PAM-1.0 # The PAM configuration file for the `login' service # @@ -540,14 +542,14 @@ auth required pam_smbpass.so nodelay account required pam_smbpass.so nodelay session required pam_smbpass.so nodelay password required pam_smbpass.so nodelay -</screen></para> +</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><screen> +<para><programlisting> #%PAM-1.0 # The PAM configuration file for the `samba' service # @@ -555,7 +557,7 @@ auth required pam_pwdb.so nullok nodelay shadow audit account required pam_pwdb.so audit nodelay session required pam_pwdb.so nodelay password required pam_pwdb.so shadow md5 -</screen></para> +</programlisting></para> <para> In the following example the decision has been made to use the @@ -565,7 +567,7 @@ thus allow the smbpasswd passwords to be changed using the passwd program. </para> -<para><screen> +<para><programlisting> #%PAM-1.0 # The PAM configuration file for the `samba' service # @@ -573,7 +575,7 @@ auth required pam_smbpass.so nodelay account required pam_pwdb.so audit nodelay session required pam_pwdb.so nodelay password required pam_smbpass.so nodelay smbconf=/etc/samba.d/smb.conf -</screen></para> +</programlisting></para> <note><para>PAM allows stacking of authentication mechanisms. It is also possible to pass information obtained within one PAM module through @@ -596,26 +598,25 @@ PAM documentation for further helpful information. <title>smb.conf PAM Configuration</title> <para> -There is an option in smb.conf called <ulink -url="smb.conf.5.html#OBEYPAMRESTRICTIONS">obey pam restrictions</ulink>. + There is an option in smb.conf called <smbconfoption><name>obey pam restrictions</name></smbconfoption>. The following is from the on-line help for this option in SWAT; </para> <para> -When Samba-3 is configured to enable PAM support (i.e. +When Samba is configured to enable PAM support (i.e. <option>--with-pam</option>), 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>. +<smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption>. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption. </para> -<para>Default: <parameter>obey pam restrictions = no</parameter></para> +<para>Default: <smbconfoption><name>obey pam restrictions</name><value>no</value></smbconfoption></para> </sect2> @@ -624,7 +625,7 @@ password encryption. <para> All operating systems depend on the provision of users credentials acceptable to the platform. -Unix requires the provision of a user identifier (UID) as well as a group identifier (GID). +UNIX requires the provision of a user identifier (UID) as well as a group identifier (GID). These are both simple integer type numbers that are obtained from a password backend such as <filename>/etc/passwd</filename>. </para> @@ -683,6 +684,8 @@ Options recognized by this module are as follows: <table frame="all"> <title>Options recognized by pam_smbpass</title> <tgroup cols="2" align="left"> + <colspec align="left"/> + <colspec align="justify"/> <tbody> <row><entry>debug</entry><entry>log more debugging info</entry></row> <row><entry>audit</entry><entry>like debug, but also logs unknown usernames</entry></row> @@ -701,18 +704,17 @@ Options recognized by this module are as follows: </para> <para> -Thanks go to the following people: -<simplelist> - <member><ulink url="mailto:morgan@transmeta.com">Andrew Morgan</ulink>, for providing the Linux-PAM - framework, without which none of this would have happened</member> +<itemizedlist> + <listitem><para><ulink url="mailto:morgan@transmeta.com">Andrew Morgan</ulink>, for providing the Linux-PAM + framework, without which none of this would have happened</para></listitem> - <member><ulink url="gafton@redhat.com">Christian Gafton</ulink> and Andrew Morgan again, for the - pam_pwdb module upon which pam_smbpass was originally based</member> +<listitem><para><ulink url="mailto:gafton@redhat.com">Christian Gafton</ulink> and Andrew Morgan again, for the + pam_pwdb module upon which pam_smbpass was originally based</para></listitem> - <member><ulink url="lkcl@switchboard.net">Luke Leighton</ulink> for being receptive to the idea, +<listitem><para><ulink url="mailto:lkcl@switchboard.net">Luke Leighton</ulink> for being receptive to the idea, and for the occasional good-natured complaint about the project's status - that keep me working on it :)</member> -</simplelist>. + that keep me working on it :)</para></listitem> +</itemizedlist>. </para> <para> @@ -731,7 +733,7 @@ is changed. Useful when an expired password might be changed by an application (such as ssh). </para> -<para><screen> +<para><programlisting> #%PAM-1.0 # password-sync # @@ -742,7 +744,7 @@ password requisite pam_cracklib.so retry=3 password requisite pam_unix.so shadow md5 use_authtok try_first_pass password required pam_smbpass.so nullok use_authtok try_first_pass session required pam_unix.so -</screen></para> +</programlisting></para> </sect3> <sect3> @@ -756,7 +758,7 @@ password migration takes place when users ftp in, login using ssh, pop their mail, etc. </para> -<para><screen> +<para><programlisting> #%PAM-1.0 # password-migration # @@ -769,7 +771,7 @@ password requisite pam_cracklib.so retry=3 password requisite pam_unix.so shadow md5 use_authtok try_first_pass password optional pam_smbpass.so nullok use_authtok try_first_pass session required pam_unix.so -</screen></para> +</programlisting></para> </sect3> <sect3> @@ -778,10 +780,10 @@ session required pam_unix.so <para> A sample PAM configuration for a 'mature' smbpasswd installation. private/smbpasswd is fully populated, and we consider it an error if -the smbpasswd doesn't exist or doesn't match the Unix password. +the smbpasswd doesn't exist or doesn't match the UNIX password. </para> -<para><screen> +<para><programlisting> #%PAM-1.0 # password-mature # @@ -792,7 +794,7 @@ password requisite pam_cracklib.so retry=3 password requisite pam_unix.so shadow md5 use_authtok try_first_pass password required pam_smbpass.so use_authtok use_first_pass session required pam_unix.so -</screen></para> +</programlisting></para> </sect3> <sect3> @@ -804,7 +806,7 @@ pam_krb5. This could be useful on a Samba PDC that is also a member of a Kerberos realm. </para> -<para><screen> +<para><programlisting> #%PAM-1.0 # kdc-pdc # @@ -816,7 +818,7 @@ password requisite pam_cracklib.so retry=3 password optional pam_smbpass.so nullok use_authtok try_first_pass password required pam_krb5.so use_authtok try_first_pass session required pam_krb5.so -</screen></para> +</programlisting></para> </sect3> @@ -836,11 +838,13 @@ the Samba mailing list. <title>pam_winbind problem</title> <para> - I have the following PAM configuration: + <quote> + I have the following PAM configuration: + </quote> </para> -<para> -<screen> + <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 nullok @@ -849,16 +853,18 @@ auth required /lib/security/pam_nologin.so account required /lib/security/pam_stack.so service=system-auth account required /lib/security/pam_winbind.so password required /lib/security/pam_stack.so service=system-auth -</screen> -</para> +</programlisting> + </para> <para> + <quote> When I open a new console with [ctrl][alt][F1], then I cant log in with my user "pitie". I've tried with user "scienceu+pitie" also. +</quote> </para> <para> - Answer: The problem may lie with your inclusion of <parameter>pam_stack.so + The problem may lie with your inclusion of <parameter>pam_stack.so service=system-auth</parameter>. That file often contains a lot of stuff that may duplicate what you're already doing. Try commenting out the pam_stack lines for auth and account and see if things work. If they do, look at @@ -869,6 +875,59 @@ password required /lib/security/pam_stack.so service=system-auth </sect2> + <sect2> + <title>Winbind is not resolving users and groups</title> + + <para> + <quote> + My smb.conf file is correctly configured. I have specified + <smbconfoption><name>idmap uid</name><value>12000</value></smbconfoption>, + and <smbconfoption><name>idmap gid</name><value>3000-3500</value></smbconfoption> + and <command>winbind</command> is running. When I do the following it all works fine. +</quote> + </para> + +<para><screen> +&rootprompt;<userinput>wbinfo -u</userinput> +MIDEARTH+maryo +MIDEARTH+jackb +MIDEARTH+ameds +... +MIDEARTH+root + +&rootprompt;<userinput>wbinfo -g</userinput> +MIDEARTH+Domain Users +MIDEARTH+Domain Admins +MIDEARTH+Domain Guests +... +MIDEARTH+Accounts + +&rootprompt;<userinput>getent passwd</userinput> +root:x:0:0:root:/root:/bin/bash +bin:x:1:1:bin:/bin:/bin/bash +... +maryo:x:15000:15003:Mary Orville:/home/MIDEARTH/maryo:/bin/false +</screen></para> + +<para> + <quote> + But the following command just fails: +</quote> +<screen> +&rootprompt;<userinput>chown 'maryo' a_file</userinput> +chown: `maryo': invalid user +</screen> +<quote> +This is driving me nuts! What can be wrong? +</quote> + </para> + + <para> + Your system is likely running <command>nscd</command>, the name service + caching daemon. Shut it down, do NOT restart it! You will find your problem resolved. + </para> + + </sect2> </sect1> </chapter> diff --git a/docs/docbook/projdoc/PolicyMgmt.xml b/docs/docbook/projdoc/PolicyMgmt.xml index 12289df7c3..351c51d1c6 100644 --- a/docs/docbook/projdoc/PolicyMgmt.xml +++ b/docs/docbook/projdoc/PolicyMgmt.xml @@ -42,7 +42,7 @@ network client workstations. </para> <para> -A tool new to Samba-3 may become an important part of the future Samba Administrators' +A tool new to Samba may become an important part of the future Samba Administrators' arsenal. The <command>editreg</command> tool is described in this document. </para> @@ -88,7 +88,7 @@ be a step forward, but improved functionality comes at a great price. Before embarking on the configuration of network and system policies it is highly advisable to read the documentation available from Microsoft's web site regarding <ulink url="http://www.microsoft.com/ntserver/management/deployment/planguide/prof_policies.asp"> -Implementing Profiles and Policies in Windows NT 4.0 from http://www.microsoft.com/ntserver/management/deployment/planguide/prof_policies.asp</ulink> available from Microsoft. +Implementing Profiles and Policies in Windows NT 4.0</ulink> available from Microsoft. There are a large number of documents in addition to this old one that should also be read and understood. Try searching on the Microsoft web site for "Group Policies". </para> @@ -112,7 +112,7 @@ here is incomplete - you are warned. Use the Group Policy Editor to create a policy file that specifies the location of user profiles and/or the <filename>My Documents</filename> etc. Then save these settings in a file called <filename>Config.POL</filename> that needs to be placed in the - root of the <parameter>[NETLOGON]</parameter> share. If Win98 is configured to log onto + root of the <smbconfsection>[NETLOGON]</smbconfsection> share. If Win98 is configured to log onto the Samba Domain, it will automatically read this file and update the Win9x/Me registry of the machine as it logs on. </para> @@ -293,7 +293,7 @@ here is incomplete - you are warned. <para> Policies can define a specific user's settings or the settings for a group of users. The resulting policy file contains the registry settings for all users, groups, and computers that will be using -the policy file. Separate policy files for each user, group, or computer are not not necessary. +the policy file. Separate policy files for each user, group, or computer are not necessary. </para> <para> @@ -326,20 +326,27 @@ Common restrictions that are frequently used includes: </para> <para> -<simplelist> - <member>Logon Hours</member> - <member>Password Aging</member> - <member>Permitted Logon from certain machines only</member> - <member>Account type (Local or Global)</member> - <member>User Rights</member> -</simplelist> +<itemizedlist> + <listitem><para>Logon Hours</para></listitem> + <listitem><para>Password Aging</para></listitem> + <listitem><para>Permitted Logon from certain machines only</para></listitem> + <listitem><para>Account type (Local or Global)</para></listitem> + <listitem><para>User Rights</para></listitem> +</itemizedlist> </para> <sect2> <title>Samba Editreg Toolset</title> <para> - Describe in detail the benefits of <command>editreg</command> and how to use it. + A new tool called <command>editreg</command> is under development. This tool can be used + to edit registry files (called NTUser.DAT) that are stored in user and group profiles. + NTConfig.POL files have the same structure as the NTUser.DAT file and can be editted using + this tool. <command>editreg</command> is being built with the intent to enable NTConfig.POL + files to be saved in text format and to permit the building of new NTConfig.POL files with + extended capabilities. It is proving difficult to realise this capability, so do not be surprised + if this feature does not materialise. Formal capabilities will be announced at the time that + this tool is released for production use. </para> </sect2> @@ -385,11 +392,11 @@ reboot and as part of the user logon: <listitem><para> Where Active Directory is involved, an ordered list of Group Policy Objects (GPOs) is downloaded and applied. The list may include GPOs that: -<simplelist> - <member>Apply to the location of machines in a Directory</member> - <member>Apply only when settings have changed</member> - <member>Depend on configuration of scope of applicability: local, site, domain, organizational unit, etc.</member> -</simplelist> +<itemizedlist> + <listitem><para>Apply to the location of machines in a Directory</para></listitem> + <listitem><para>Apply only when settings have changed</para></listitem> + <listitem><para>Depend on configuration of scope of applicability: local, site, domain, organizational unit, etc.</para></listitem> +</itemizedlist> No desktop user interface is presented until the above have been processed. </para></listitem> @@ -408,12 +415,12 @@ reboot and as part of the user logon: <listitem><para> An ordered list of User GPOs is obtained. The list contents depends on what is configured in respect of: -<simplelist> - <member>Is user a domain member, thus subject to particular policies</member> - <member>Loopback enablement, and the state of the loopback policy (Merge or Replace)</member> - <member>Location of the Active Directory itself</member> - <member>Has the list of GPOs changed. No processing is needed if not changed.</member> -</simplelist> +<itemizedlist> + <listitem><para>Is user a domain member, thus subject to particular policies</para></listitem> + <listitem><para>Loopback enablement, and the state of the loopback policy (Merge or Replace)</para></listitem> + <listitem><para>Location of the Active Directory itself</para></listitem> + <listitem><para>Has the list of GPOs changed. No processing is needed if not changed.</para></listitem> +</itemizedlist> </para></listitem> <listitem><para> @@ -446,13 +453,13 @@ collection demonstrates only basic issues. <title>Policy Does Not Work</title> <para> -Question: We have created the <filename>config.pol</filename> file and put it in the <emphasis>NETLOGON</emphasis> share. + <quote>We have created the <filename>config.pol</filename> file and put it in the <emphasis>NETLOGON</emphasis> share. It has made no difference to our Win XP Pro machines, they just don't see it. IT worked fine with Win 98 but does not -work any longer since we upgraded to Win XP Pro. Any hints? +work any longer since we upgraded to Win XP Pro. Any hints?</quote> </para> <para> -<emphasis>ANSWER:</emphasis> Policy files are NOT portable between Windows 9x / Me and MS Windows NT4 / 200x / XP based +Policy files are NOT portable between Windows 9x / Me and MS Windows NT4 / 200x / XP based platforms. You need to use the NT4 Group Policy Editor to create a file called <filename>NTConfig.POL</filename> so that it is in the correct format for your MS Windows XP Pro clients. </para> diff --git a/docs/docbook/projdoc/Portability.xml b/docs/docbook/projdoc/Portability.xml index 205d384843..50cc8b4c7c 100644 --- a/docs/docbook/projdoc/Portability.xml +++ b/docs/docbook/projdoc/Portability.xml @@ -45,17 +45,17 @@ Samba. </sect1> <sect1> -<title>SCO Unix</title> +<title>SCO UNIX</title> <para> -If you run an old version of SCO Unix then you may need to get important +If you run an old version of SCO UNIX then you may need to get important TCP/IP patches for Samba to work correctly. Without the patch, you may encounter corrupt data transfers using samba. </para> <para> The patch you need is UOD385 Connection Drivers SLS. It is available from -SCO (<ulink url="ftp://ftp.sco.com/">ftp.sco.com</ulink>, directory SLS, +SCO (<ulink noescape="1" url="ftp://ftp.sco.com/">ftp.sco.com</ulink>, directory SLS, files uod385a.Z and uod385a.ltr.Z). </para> @@ -125,8 +125,8 @@ after creating the above files you then assemble them using </para> <screen> - <prompt>$ </prompt><userinput>as seteuid.s</userinput> - <prompt>$ </prompt><userinput>as setegid.s</userinput> +&prompt;<userinput>as seteuid.s</userinput> +&prompt;<userinput>as setegid.s</userinput> </screen> <para> diff --git a/docs/docbook/projdoc/Problems.xml b/docs/docbook/projdoc/Problems.xml index 16e4c8ad54..46f3c002d2 100644 --- a/docs/docbook/projdoc/Problems.xml +++ b/docs/docbook/projdoc/Problems.xml @@ -3,13 +3,7 @@ <chapterinfo> &author.jerry; &author.jelmer; - <author> - <firstname>David</firstname><surname>Bannon</surname> - <affiliation> - <orgname>Samba Team</orgname> - <address><email>dbannon@samba.org</email></address> - </affiliation> - </author> + &author.dbannon; <pubdate>8 Apr 2003</pubdate> </chapterinfo> @@ -24,10 +18,20 @@ general SMB topics such as browsing.</para> <sect1> <title>Diagnostics tools</title> +<para>With SMB networking, it is often not immediately clear what +the cause is of a certain problem. Samba itself provides rather +useful information, but in some cases you might have to fall back +to using a <emphasis>sniffer</emphasis>. A sniffer is a program that +listens on your LAN, analyses the data sent on it and displays it +on the screen.</para> + +<sect2> +<title>Debugging with Samba itself</title> + <para> One of the best diagnostic tools for debugging problems is Samba itself. You can use the <option>-d option</option> for both &smbd; and &nmbd; to specify what -<parameter>debug level</parameter> at which to run. See the man pages on smbd, nmbd and +<smbconfoption><name>debug level</name></smbconfoption> 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). </para> @@ -52,17 +56,44 @@ Some useful samba commands worth investigating: </para> <screen> - <prompt>$ </prompt><userinput>testparm | more</userinput> - <prompt>$ </prompt><userinput>smbclient -L //{netbios name of server}</userinput> +&prompt;<userinput>testparm | more</userinput> +&prompt;<userinput>smbclient -L //{netbios name of server}</userinput> </screen> - + +</sect2> + +<sect2> + <title>Tcpdump</title> + +<para><ulink url="http://www.tcpdump.org/">Tcpdump</ulink> was the first +unix sniffer with SMB support. It is a command-line utility and +nowadays, it's SMB support is somewhat less then that of ethereal +and tethereal.</para> + +</sect2> + +<sect2> + <title>Ethereal</title> + <para> -An SMB enabled version of tcpdump is available from -<ulink url="http://www.tcpdump.org/">http://www.tcpdup.org/</ulink>. -Ethereal, another good packet sniffer for Unix and Win32 -hosts, can be downloaded from <ulink -url="http://www.ethereal.com/">http://www.ethereal.com</ulink>. -</para> +<ulink url="http://www.ethereal.com/">Ethereal</ulink> is a graphical +sniffer, available for both unix (Gtk) and Windows. Ethereal's +SMB support is very good.</para> + +<para>For details on the use of ethereal, read the well-written +ethereal User Guide.</para> + +<para> +Listen for data on ports 137, 138, 139 and 445. E.g. +use the filter <userinput>port 137 or port 138 or port 139 or port 445</userinput>.</para> + +<para>A console version of ethereal is available as well and is called +<command>tethereal</command>.</para> + +</sect2> + +<sect2> +<title>The Windows Network Monitor</title> <para> For tracing things on the Microsoft Windows NT, Network Monitor @@ -76,10 +107,8 @@ local subnet. Be aware that Ethereal can read and write netmon formatted files. </para> -</sect1> - -<sect1> -<title>Installing 'Network Monitor' on an NT Workstation or a Windows 9x box</title> +<sect3> +<title>Installing 'Network Monitor' on an NT Workstation</title> <para> Installing netmon on an NT workstation requires a couple @@ -144,14 +173,18 @@ permissions as you deem appropriate for your site. You will need administrative rights on the NT box to run netmon. </para> +</sect3> +<sect3> +<title>Installing 'Network Monitor' on an 9x Workstation</title> <para> To install Netmon on a Windows 9x box install the network monitor agent from the Windows 9x CD (<filename>\admin\nettools\netmon</filename>). There is a readme file located with the netmon driver files on the CD if you need information on how to do this. Copy the files from a working Netmon installation. -</para> - +</para> +</sect3> +</sect2> </sect1> <sect1> @@ -159,15 +192,14 @@ Netmon installation. <itemizedlist> <listitem><para>See how Scott Merrill simulates a BDC behavior at - <ulink url="http://www.skippy.net/linux/smb-howto.html"> + <ulink noescape="1" url="http://www.skippy.net/linux/smb-howto.html"> http://www.skippy.net/linux/smb-howto.html</ulink>. </para></listitem> <listitem><para>FTP site for older SMB specs: - <ulink url="ftp://ftp.microsoft.com/developr/drg/CIFS/"> + <ulink noescape="1" url="ftp://ftp.microsoft.com/developr/drg/CIFS/"> ftp://ftp.microsoft.com/developr/drg/CIFS/</ulink></para></listitem> </itemizedlist> -<!-- FIXME: Merge with Further Resources --> </sect1> @@ -176,14 +208,14 @@ Netmon installation. <para> There are a number of Samba related mailing lists. Go to <ulink -url="http://samba.org">http://samba.org</ulink>, click on your nearest mirror +noescape="1" url="http://samba.org">http://samba.org</ulink>, click on your nearest mirror and then click on <command>Support</command> and then click on <command> Samba related mailing lists</command>. </para> <para> For questions relating to Samba TNG go to -<ulink url="http://www.samba-tng.org/">http://www.samba-tng.org/</ulink> +<ulink noescape="1" url="http://www.samba-tng.org/">http://www.samba-tng.org/</ulink> It has been requested that you don't post questions about Samba-TNG to the main stream Samba lists.</para> @@ -193,12 +225,12 @@ If you post a message to one of the lists please observe the following guide lin <itemizedlist> -<listitem><para> Always remember that the developers are volunteers, they are +<listitem><para>Always remember that the developers are volunteers, they are not paid and they never guarantee to produce a particular feature at a particular time. Any time lines are 'best guess' and nothing more. </para></listitem> -<listitem><para> Always mention what version of samba you are using and what +<listitem><para>Always mention what version of samba you are using and what operating system its running under. You should probably list the relevant sections of your &smb.conf; file, at least the options in [global] that affect PDC support.</para></listitem> @@ -244,10 +276,9 @@ smb.conf in their attach directory?</para></listitem> <para>To have your name removed from a samba mailing list, go to the same place you went to to get on it. Go to <ulink -url="http://lists.samba.org/">http://lists.samba.org</ulink>, + noescape="1" url="http://lists.samba.org/">http://lists.samba.org</ulink>, click on your nearest mirror and then click on <command>Support</command> and -then click on <command> Samba related mailing lists</command>. Or perhaps see -<ulink url="http://lists.samba.org/mailman/roster/samba-ntdom">here</ulink> +then click on <command> Samba related mailing lists</command>. </para> <para> diff --git a/docs/docbook/projdoc/ProfileMgmt.xml b/docs/docbook/projdoc/ProfileMgmt.xml index 58c6f34030..37ae2d41e8 100644 --- a/docs/docbook/projdoc/ProfileMgmt.xml +++ b/docs/docbook/projdoc/ProfileMgmt.xml @@ -73,15 +73,15 @@ following (for example): </para> <para> -<programlisting> - logon path = \\profileserver\profileshare\profilepath\%U\moreprofilepath -</programlisting> +<smbconfblock> +<smbconfoption><name>logon path</name><value>\\profileserver\profileshare\profilepath\%U\moreprofilepath</value></smbconfoption> +</smbconfblock> This is typically implemented like: -<programlisting> - logon path = \\%L\Profiles\%u -</programlisting> +<smbconfblock> +<smbconfoption><name>logon path</name><value>\\%L\Profiles\%u</value></smbconfoption> +</smbconfblock> where %L translates to the name of the Samba server and %u translates to the user name </para> @@ -97,7 +97,7 @@ semantics of %L and %N, as well as %U and %u. <note> <para> MS Windows NT/2K clients at times do not disconnect a connection to a server -between logons. It is recommended to NOT use the <parameter>homes</parameter> +between logons. It is recommended to NOT use the <smbconfsection>homes</smbconfsection> meta-service name as part of the profile share path. </para> </note> @@ -107,7 +107,7 @@ meta-service name as part of the profile share path. <title>Windows 9x / Me User Profiles</title> <para> - To support Windows 9x / Me clients, you must use the <parameter>logon home</parameter> parameter. Samba has + To support Windows 9x / Me clients, you must use the <smbconfoption><name>logon home</name></smbconfoption> parameter. Samba has now been fixed so that <userinput>net use /home</userinput> now works as well, and it, too, relies on the <command>logon home</command> parameter. </para> @@ -115,11 +115,11 @@ on the <command>logon home</command> parameter. <para> By using the logon home parameter, you are restricted to putting Win9x / Me profiles in the user's home directory. But wait! There is a trick you -can use. If you set the following in the <parameter>[global]</parameter> section of your &smb.conf; file: +can use. If you set the following in the <smbconfsection>[global]</smbconfsection> section of your &smb.conf; file: </para> -<para><programlisting> - logon home = \\%L\%U\.profiles -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>logon home</name><value>\\%L\%U\.profiles</value></smbconfoption> +</smbconfblock></para> <para> then your Windows 9x / Me clients will dutifully put their clients in a subdirectory @@ -130,7 +130,7 @@ of your home directory called <filename>.profiles</filename> (thus making them h Not only that, but <userinput>net use /home</userinput> will also work, because of a feature in Windows 9x / Me. It removes any directory stuff off the end of the home directory area and only uses the server and share portion. That is, it looks like you -specified <filename>\\%L\%U</filename> for <parameter>logon home</parameter>. +specified <filename>\\%L\%U</filename> for <smbconfoption><name>logon home</name></smbconfoption>. </para> </sect3> @@ -139,13 +139,13 @@ specified <filename>\\%L\%U</filename> for <parameter>logon home</parameter>. <para> You can support profiles for both Win9X and WinNT clients by setting both the -<parameter>logon home</parameter> and <parameter>logon path</parameter> parameters. For example: +<smbconfoption><name>logon home</name></smbconfoption> and <smbconfoption><name>logon path</name></smbconfoption> parameters. For example: </para> -<para><programlisting> - logon home = \\%L\%u\.profiles - logon path = \\%L\profiles\%u -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>logon home</name><value>\\%L\%u\.profiles</value></smbconfoption> +<smbconfoption><name>logon path</name><value>\\%L\profiles\%u</value></smbconfoption> +</smbconfblock></para> </sect3> <sect3> @@ -166,10 +166,10 @@ There are three ways of doing this: <listitem><para> Affect the following settings and ALL clients will be forced to use a local profile: - <programlisting> - logon home = - logon path = - </programlisting> + <smbconfblock> + <smbconfoption><name>logon home</name></smbconfoption> + <smbconfoption><name>logon path</name></smbconfoption> + </smbconfblock> </para></listitem> </varlistentry> @@ -178,6 +178,7 @@ There are three ways of doing this: <listitem><para> By using the Microsoft Management Console gpedit.msc to instruct your MS Windows XP machine to use only a local profile. This of course modifies registry settings. The full path to the option is: <!-- FIXME: Diagram for this ? --> + <!-- FIXME: Yes, a diagram will help - JHT --> <programlisting> Local Computer Policy\ Computer Configuration\ @@ -228,9 +229,9 @@ as are folders <filename>Start Menu</filename>, <filename>Desktop</filename>, <filename>Programs</filename> and <filename>Nethood</filename>. These directories and their contents will be merged with the local versions stored in <filename>c:\windows\profiles\username</filename> on subsequent logins, -taking the most recent from each. You will need to use the <parameter>[global]</parameter> -options <parameter>preserve case = yes</parameter>, <parameter>short preserve case = yes</parameter> and -<parameter>case sensitive = no</parameter> in order to maintain capital letters in shortcuts +taking the most recent from each. You will need to use the <smbconfsection>[global]</smbconfsection> +options <smbconfoption><name>preserve case</name><value>yes</value></smbconfoption>, <smbconfoption><name>short preserve case</name><value>yes</value></smbconfoption> and +<smbconfoption><name>case sensitive</name><value>no</value></smbconfoption> in order to maintain capital letters in shortcuts in any of the profile folders. </para> @@ -281,13 +282,13 @@ supports it), user name and user's password. <para> Once the user has been successfully validated, the Windows 9x / Me machine -will inform you that <computeroutput>The user has not logged on before' and asks you - if you wish to save the user's preferences?</computeroutput> Select <guibutton>yes</guibutton>. +will inform you that <computeroutput>The user has not logged on before</computeroutput> and asks you +<computeroutput>Do you wish to save the user's preferences?</computeroutput>. Select <guibutton>yes</guibutton>. </para> <para> Once the Windows 9x / Me client comes up with the desktop, you should be able -to examine the contents of the directory specified in the <parameter>logon path</parameter> +to examine the contents of the directory specified in the <smbconfoption><name>logon path</name></smbconfoption> on the samba server and verify that the <filename>Desktop</filename>, <filename>Start Menu</filename>, <filename>Programs</filename> and <filename>Nethood</filename> folders have been created. </para> @@ -305,7 +306,7 @@ the newest folders and short-cuts from each set. If you have made the folders / files read-only on the samba server, then you will get errors from the Windows 9x / Me machine on logon and logout, as it attempts to merge the local and the remote profile. Basically, if -you have any errors reported by the Windows 9x / Me machine, check the Unix file +you have any errors reported by the Windows 9x / Me machine, check the UNIX file permissions and ownership rights on the profile directory contents, on the samba server. </para> @@ -316,6 +317,25 @@ local desktop cache, as shown below. When this user then next logs in, they will be told that they are logging in "for the first time". </para> + <warning> + <para> + Before deleting the contents of the + directory listed in the ProfilePath (this is likely to be + <filename>c:\windows\profiles\username)</filename>, ask them if they + have any important files stored on their desktop or in their start menu. + Delete the contents of the directory ProfilePath (making a backup if any + of the files are needed). + </para> + + <para> + This will have the effect of removing the local (read-only hidden + system file) user.DAT in their profile directory, as well as the + local "desktop", "nethood", "start menu" and "programs" folders. + </para> + </warning> + + + <orderedlist> <listitem> <para> @@ -342,23 +362,6 @@ they will be told that they are logging in "for the first time". <para>[Exit the registry editor].</para> </listitem> - <warning> - <para> - Before deleting the contents of the - directory listed in the ProfilePath (this is likely to be - <filename>c:\windows\profiles\username)</filename>, ask them if they - have any important files stored on their desktop or in their start menu. - Delete the contents of the directory ProfilePath (making a backup if any - of the files are needed). - </para> - - <para> - This will have the effect of removing the local (read-only hidden - system file) user.DAT in their profile directory, as well as the - local "desktop", "nethood", "start menu" and "programs" folders. - </para> - </warning> - <listitem> <para> search for the user's .PWL password-caching file in the <filename>c:\windows</filename> @@ -374,7 +377,7 @@ they will be told that they are logging in "for the first time". <listitem> <para> - check the contents of the profile path (see <parameter>logon path</parameter> described + check the contents of the profile path (see <smbconfoption><name>logon path</name></smbconfoption> described above), and delete the <filename>user.DAT</filename> or <filename>user.MAN</filename> file for the user, making a backup if required. </para> @@ -403,13 +406,13 @@ differences are with the equivalent samba trace. <para> When a user first logs in to a Windows NT Workstation, the profile NTuser.DAT is created. The profile location can be now specified -through the <parameter>logon path</parameter> parameter. +through the <smbconfoption><name>logon path</name></smbconfoption> parameter. </para> <para> There is a parameter that is now available for use with NT Profiles: -<parameter>logon drive</parameter>. This should be set to <filename>H:</filename> or any other drive, and -should be used in conjunction with the new "logon home" parameter. +<smbconfoption><name>logon drive</name></smbconfoption>. This should be set to <filename>H:</filename> or any other drive, and +should be used in conjunction with the new <smbconfoption><name>logon home</name></smbconfoption> parameter. </para> <para> @@ -481,8 +484,7 @@ profile on the MS Windows workstation as follows: profile must be accessible. </para> - <note><para>You will need to log on if a logon box opens up. Eg: In the connect - as: <replaceable>MIDEARTH</replaceable>\root, password: <replaceable>mypassword</replaceable>.</para></note> + <note><para>You will need to log on if a logon box opens up. Eg: In the connect as: <replaceable>DOMAIN</replaceable>\root, password: <replaceable>mypassword</replaceable>.</para></note> </step> <step><para> @@ -500,7 +502,7 @@ profile on the MS Windows workstation as follows: </procedure> <para> -Done. You now have a profile that can be edited using the samba-3.0.0 +Done. You now have a profile that can be edited using the samba <command>profiles</command> tool. </para> @@ -511,8 +513,8 @@ storage of mail data. That keeps desktop profiles usable. </para> </note> -<note> <procedure> + <title>Windows XP Service Pack 1</title> <step><para> This is a security check new to Windows XP (or maybe only Windows XP service pack 1). It can be disabled via a group policy in @@ -562,7 +564,6 @@ On the XP workstation log in with an Administrator account. <step><para>Reboot</para></step> </procedure> -</note> </sect3> </sect2> @@ -582,9 +583,9 @@ on again with the newer version of MS Windows. <para> If you then want to share the same Start Menu / Desktop with W9x/Me, you will -need to specify a common location for the profiles. The smb.conf parameters -that need to be common are <parameter>logon path</parameter> and -<parameter>logon home</parameter>. +need to specify a common location for the profiles. The &smb.conf; parameters +that need to be common are <smbconfoption><name>logon path</name></smbconfoption> and +<smbconfoption><name>logon home</name></smbconfoption>. </para> <para> @@ -659,12 +660,6 @@ Follow the above for every profile you need to migrate. You should obtain the SID of your NT4 domain. You can use smbpasswd to do this. Read the man page.</para> -<para> -With Samba-3.0.0 alpha code you can import all you NT4 domain accounts -using the net samsync method. This way you can retain your profile -settings as well as all your users. -</para> - </sect3> <sect3> @@ -844,10 +839,10 @@ customisable per user depending on the profile settings chosen/created. When a new user first logs onto an MS Windows NT4 machine a new profile is created from: </para> -<simplelist> - <member>All Users settings</member> - <member>Default User settings (contains the default NTUser.DAT file)</member> -</simplelist> +<itemizedlist> + <listitem><para>All Users settings</para></listitem> + <listitem><para>Default User settings (contains the default NTUser.DAT file)</para></listitem> +</itemizedlist> <para> When a user logs onto an MS Windows NT4 machine that is a member of a Microsoft security domain @@ -903,8 +898,8 @@ also remain stored in the same way, unless the following registry key is created <para> <programlisting> - HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\winlogon\ - "DeleteRoamingCache"=dword:00000001 +HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\ +winlogon\"DeleteRoamingCache"=dword:00000001 </programlisting> In which case, the local copy (in <filename>%SystemRoot%\Profiles\%USERNAME%</filename>) will be @@ -1013,7 +1008,7 @@ login name of the user. <note> <para> - This path translates, in Samba parlance, to the &smb.conf; <parameter>[NETLOGON]</parameter> share. The directory + This path translates, in Samba parlance, to the &smb.conf; <smbconfsection>[NETLOGON]</smbconfsection> share. The directory should be created at the root of this share and must be called <filename>Default Profile</filename>. </para> </note> @@ -1124,7 +1119,7 @@ You could also use: <para> in which case the default folders will be stored in the server named <replaceable>SambaServer</replaceable> in the share called <replaceable>FolderShare</replaceable> under a directory that has the name of the MS Windows -user as seen by the Linux/Unix file system. +user as seen by the Linux/UNIX file system. </para> <para> @@ -1137,7 +1132,10 @@ MS Windows 200x/XP profiles may be <emphasis>Local</emphasis> or <emphasis>Roami A roaming profile will be cached locally unless the following registry key is created: </para> -<para><filename>HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\winlogon\"DeleteRoamingCache"=dword:00000001</filename></para> +<para> +<programlisting> +HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\ + winlogon\"DeleteRoamingCache"=dword:00000001</programlisting></para> <para> In which case, the local cache copy will be deleted on logout. @@ -1153,7 +1151,7 @@ The following are some typical errors/problems/questions that have been asked. </para> <sect2> -<title>How does one set up roaming profiles for just one (or a few) user/s or group/s?</title> +<title>Setting up roaming profiles for just a few user's or group's?</title> <para> With samba-2.2.x the choice you have is to enable or disable roaming @@ -1171,8 +1169,8 @@ machine. </para> <para> -With samba-3.0.0 (soon to be released) you can have a global profile -setting in smb.conf _AND_ you can over-ride this by per-user settings +With samba-3 you can have a global profile +setting in &smb.conf; _AND_ you can over-ride this by per-user settings using the Domain User Manager (as with MS Windows NT4/ Win 2Kx). </para> @@ -1181,11 +1179,11 @@ In any case, you can configure only one profile per user. That profile can be either: </para> -<simplelist> - <member>A profile unique to that user</member> - <member>A mandatory profile (one the user can not change)</member> - <member>A group profile (really should be mandatory ie:unchangable)</member> -</simplelist> +<itemizedlist> + <listitem><para>A profile unique to that user</para></listitem> + <listitem><para>A mandatory profile (one the user can not change)</para></listitem> + <listitem><para>A group profile (really should be mandatory ie:unchangable)</para></listitem> +</itemizedlist> </sect2> @@ -1193,66 +1191,69 @@ be either: <title>Can NOT use Roaming Profiles</title> <para> +A user requested the following: <quote> - I dont want Roaming profile to be implemented, I just want to give users - local profiles only. -... - Please help me I am totally lost with this error from past two days I tried - everything and googled around quite a bit but of no help. Please help me. +I do not want Roaming profiles to be implemented. I want to give users a local profile alone. ... +Please help me I am totally lost with this error. For the past two days I tried everything, I googled +around but found no useful pointers. Please help me. </quote></para> <para> -Your choices are: -<!-- FIXME: Write to whole sentences --> +The choices are: +</para> <variablelist> <varlistentry> - <term>Local profiles</term> + <term>Local profiles:</term> <listitem><para> - I know of no registry keys that will allow auto-deletion of LOCAL profiles on log out + I know of no registry keys that will allow auto-deletion of LOCAL profiles on log out </para></listitem> </varlistentry> <varlistentry> - <term>Roaming profiles</term> + <term>Roaming profiles:</term> <listitem><para> - <simplelist> - <member>can use auto-delete on logout option</member> - <member>requires a registry key change on workstation</member> - </simplelist> - - Your choices are: - - <variablelist> - <varlistentry> - <term>Personal Roaming profiles</term> - <listitem><para> - - should be preserved on a central server - - workstations 'cache' (store) a local copy - - used in case the profile can not be downloaded - at next logon - </para></listitem> - </varlistentry> - - <varlistentry> - <term>Group profiles</term> - <listitem><para>- loaded from a central place</para></listitem> - </varlistentry> - - <varlistentry> - <term>Mandatory profiles</term> - <listitem><para> - - can be personal or group - - can NOT be changed (except by an administrator - </para></listitem> - </varlistentry> - </variablelist> + As a user logs onto the network a centrally stored profile is copied to the workstation + to form a local profile. This local profile will persist (remain on the workstation disk) + unless a registry key is changed that will cause this profile to be automatically deleted + on logout. </para></listitem> </varlistentry> </variablelist> +<para> +The <emphasis>Roaming Profile</emphasis> choices are: </para> +<variablelist> + <varlistentry> + <term>Personal Roaming profiles</term> + <listitem><para> + These are typically stored in a profile share on a central (or conveniently located + local) server. + </para> + + <para> + Workstations 'cache' (store) a local copy of the profile. This cached copy is used when + the profile can not be downloaded at next logon. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>Group profiles</term> + <listitem><para>These are loaded from a central profile server</para></listitem> + </varlistentry> + + <varlistentry> + <term>Mandatory profiles</term> + <listitem><para> + Mandatory profiles can be created for a user as well as for any group that a user + is a member of. Mandatory profiles can NOT be changed by ordinary users. Only the administrator + can change or reconfigure a mandatory profile. + </para></listitem> + </varlistentry> +</variablelist> + <para> A WinNT4/2K/XP profile can vary in size from 130KB to off the scale. Outlook PST files are most often part of the profile and can be many GB in @@ -1271,56 +1272,53 @@ a problem free site. <para> Microsoft's answer to the PST problem is to store all email in an MS -Exchange Server back-end. But this is another story ...! +Exchange Server back-end. This removes the need for a PST file. </para> <para> -So, having LOCAL profiles means: - -<simplelist> - <member>If lots of users user each machine - lot's of local disk storage needed for local profiles</member> - <member>Every workstation the user logs into has it's own profile - can be very different from machine to machine</member> -</simplelist> - -On the other hand, having roaming profiles means: -<simplelist> - <member>The network administrator can control EVERY aspect of user profiles</member> - <member>With the use of mandatory profiles - a drastic reduction in network management overheads</member> - <member>User unhappiness about not being able to change their profiles soon fades as they get used to being able to work reliably</member> -</simplelist> - +LOCAL profiles mean: </para> +<itemizedlist> + <listitem><para>If each machine is used my many users then much local disk storage is needed for local profiles</para></listitem> + <listitem><para>Every workstation the user logs into has it's own profile, these can be very different from machine to machine</para></listitem> +</itemizedlist> + <para> -I have managed and installed MANY NT/2K networks and have NEVER found one -where users who move from machine to machine are happy with local -profiles. In the long run local profiles bite them. +On the other hand, use of roaming profiles means: </para> -</sect2> +<itemizedlist> + <listitem><para>The network administrator can control the desktop environment of all users.</para></listitem> + <listitem><para>Use of mandatory profiles drasitcally reduces network management overheads.</para></listitem> + <listitem><para>In the long run users will be experience fewer problems.</para></listitem> +</itemizedlist> -<!-- FIXME: Everything below this is a mess. I didn't quite understand it - Jelmer --> +</sect2> <sect2> - <title>Changing the default profile</title> +<title>Changing the default profile</title> -<para><quote> -When the client tries to logon to the PDC it looks for a profile to download -where do I put this default profile. +<para> +<emphasis>Question:</emphasis> +<quote> +When the client logs onto the domain controller it searches for a profile to download, +where do I put this default profile? </quote></para> <para> -Firstly, your samba server need to be configured as a domain controller. +Firstly, the samba server needs to be configured as a domain controller. +This can be done by setting in &smb.conf;: </para> -<programlisting> - server = user - os level = 32 (or more) - domain logons = Yes -</programlisting> +<smbconfblock> +<smbconfoption><name>security</name><value>user</value></smbconfoption> +<smbconfoption><name>os level</name><value>32 (or more)</value></smbconfoption> +<smbconfoption><name>domain logons</name><value>Yes</value></smbconfoption> +</smbconfblock> <para> -Plus you need to have a <parameter>[netlogon]</parameter> share that is world readable. +There must be an <smbconfsection>[netlogon]</smbconfsection> share that is world readable. It is a good idea to add a logon script to pre-set printer and drive connections. There is also a facility for automatically synchronizing the workstation time clock with that of the logon @@ -1329,23 +1327,26 @@ server (another good thing to do). <note><para> To invoke auto-deletion of roaming profile from the local -workstation cache (disk storage) you need to use the <application>Group Policy Editor</application> +workstation cache (disk storage) use the <application>Group Policy Editor</application> to create a file called <filename>NTConfig.POL</filename> with the appropriate entries. This -file needs to be located in the <parameter>netlogon</parameter> share root directory.</para></note> +file needs to be located in the <smbconfsection>netlogon</smbconfsection> share root directory.</para></note> <para> -Oh, of course the windows clients need to be members of the domain. -Workgroup machines do NOT do network logons - so they never see domain -profiles. +Windows clients need to be members of the domain. Workgroup machines do NOT use network logons so +they do not interoperate with domain profiles. </para> <para> -Secondly, for roaming profiles you need: - - logon path = \\%N\profiles\%U (with some such path) - logon drive = H: (Z: is the default) +For roaming profiles add to &smb.conf;: +</para> - Plus you need a PROFILES share that is world writable. +<para> +<smbconfblock> +<smbconfoption><name>logon path</name><value>\\%N\profiles\%U</value></smbconfoption> +<smbconfcomment>Default logon drive is Z:</smbconfcomment> +<smbconfoption><name>logon drive</name><value>H:</value></smbconfoption> +<smbconfcomment>This requires a PROFILES share that is world writable.</smbconfcomment> +</smbconfblock> </para> </sect2> diff --git a/docs/docbook/projdoc/SWAT.xml b/docs/docbook/projdoc/SWAT.xml index 1ea0789661..90994f65e0 100644 --- a/docs/docbook/projdoc/SWAT.xml +++ b/docs/docbook/projdoc/SWAT.xml @@ -40,7 +40,7 @@ and only non-default settings will be written to the file. <para> SWAT should be installed to run via the network super daemon. Depending on which system -your Unix/Linux system has you will have either an <command>inetd</command> or +your UNIX/Linux system has you will have either an <command>inetd</command> or <command>xinetd</command> based system. </para> @@ -132,11 +132,11 @@ Modifications to the swat setup are as following: <step><para> generate certificate and private key - <screen> +<screen> &rootprompt;<userinput>/usr/bin/openssl req -new -x509 -days 365 -nodes -config \ - /usr/share/doc/packages/stunnel/stunnel.cnf \ + /usr/share/doc/packages/stunnel/stunnel.cnf \ -out /etc/stunnel/stunnel.pem -keyout /etc/stunnel/stunnel.pem</userinput> - </screen></para></step> +</screen></para></step> <step><para> remove swat-entry from [x]inetd @@ -145,14 +145,14 @@ Modifications to the swat setup are as following: <step><para> start stunnel - <screen> +<screen> &rootprompt;<userinput>stunnel -p /etc/stunnel/stunnel.pem -d 901 \ -l /usr/local/samba/bin/swat swat </userinput> - </screen></para></step> +</screen></para></step> </procedure> <para> -afterwords simply contact to swat by using the URL <ulink url="https://myhost:901">https://myhost:901</ulink>, accept the certificate +afterwords simply contact to swat by using the URL <ulink noescape="1" url="https://myhost:901">https://myhost:901</ulink>, accept the certificate and the SSL connection is up. </para> @@ -171,8 +171,7 @@ document) as well as the O'Reilly book "Using Samba". Administrators who wish to validate their samba configuration may obtain useful information from the man pages for the diagnostic utilities. These are available from the SWAT home page also. One diagnostic tool that is NOT mentioned on this page, but that is particularly -useful is <command>ethereal</command>, available from <ulink url="http://www.ethereal.com"> -http://www.ethereal.com</ulink>. +useful is <ulink url="http://www.ethereal.com/"><command>ethereal</command></ulink>. </para> <warning><para> @@ -211,8 +210,8 @@ in smb.conf. There are three levels of exposure of the parameters: <para> To switch to other than <emphasis>Basic</emphasis> editing ability click on either the -<emphasis>Advanced</emphasis> or the <emphasis>Developer</emphasis> dial, then click the -<guibutton>Commit Changes</guibutton> button. +<emphasis>Advanced</emphasis> or the <emphasis>Developer</emphasis> button. You may also +do this by clicking on the radio button, then click the <guibutton>Commit Changes</guibutton> button. </para> <para> diff --git a/docs/docbook/projdoc/Samba-BDC-HOWTO.xml b/docs/docbook/projdoc/Samba-BDC-HOWTO.xml index 52e53a51c7..9800c508d5 100644 --- a/docs/docbook/projdoc/Samba-BDC-HOWTO.xml +++ b/docs/docbook/projdoc/Samba-BDC-HOWTO.xml @@ -9,8 +9,7 @@ <para> Before you continue reading in this section, please make sure that you are comfortable -with configuring a Samba Domain Controller as described in the -<link linkend="samba-pdc">Domain Control</link> chapter. +with configuring a Samba Domain Controller as described in <link linkend="samba-pdc">chapter on setting up Samba as a PDC</link>. </para> <sect1> @@ -20,19 +19,19 @@ with configuring a Samba Domain Controller as described in the This is one of the most difficult chapters to summarise. It does not matter what we say here for someone will still draw conclusions and / or approach the Samba-Team with expectations that are either not yet capable of being delivered, or that can be achieved far more -effectively using a totally different approach. Since this HOWTO is already so large and -extensive, we have taken the decision to provide sufficient (but not comprehensive) -information regarding Backup Domain Control. In the event that you should have a persistent -concern that is not addressed in this HOWTO document then please email +effectively using a totally different approach. In the event that you should have a persistent +concern that is not addressed in this book then please email <ulink url="mailto:jht@samba.org">John H Terpstra</ulink> clearly setting out your requirements and / or question and we will do our best to provide a solution. </para> <para> Samba-3 is capable of acting as a Backup Domain Controller to another Samba Primary Domain -Controller. A Samba-3 PDC can operate with an LDAP Account backend. The Samba-3 BDC can -operate with a slave LDAP server for the Account backend. This effectively gives samba a high -degree of scalability. This is a very sweet (nice) solution for large organisations. +Controller. A Samba-3 PDC can operate with an LDAP Account backend. The LDAP backend can be +either a common master LDAP server, or a slave server. The use of a slave LDAP server has the +benefit that when the master is down clients may still be able to log onto the network. +This effectively gives samba a high degree of scalability iand is a very sweet (nice) solution +for large organisations. </para> <para> @@ -74,8 +73,9 @@ lets consider each possible option and look at the pro's and con's for each theo </listitem> <listitem><para> - Passdb Backend is tdbsam based, BDCs use cron based "net rpc vampire" to - suck down the Accounts database from the PDC + Passdb Backend is tdbsam based, BDCs use cron based <emphasis>net rpc vampire</emphasis> to + obtain the Accounts database from the PDC and place them into the Samba SAM. + <emphasis>net rpc vampire</emphasis> is a Samba function of the "net" command. </para> <para> @@ -225,19 +225,21 @@ Server Manager for Domains. <para> Since version 2.2 Samba officially supports domain logons for all current Windows Clients, including Windows NT4, 2003 and XP Professional. For samba to be enabled as a PDC some -parameters in the <parameter>[global]</parameter>-section of the &smb.conf; have to be set: +parameters in the <smbconfsection>[global]</smbconfsection>-section of the &smb.conf; have to be set: </para> -<para><programlisting> - workgroup = SAMBA - domain master = yes - domain logons = yes -</programlisting></para> +<para><smbconfexample> +<title>Minimal smb.conf for being a PDC</title> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +<smbconfoption><name>domain master</name><value>yes</value></smbconfoption> +<smbconfoption><name>domain logons</name><value>yes</value></smbconfoption> +</smbconfexample></para> <para> -Several other things like a <parameter>[homes]</parameter> and a <parameter>[netlogon]</parameter> share also need to be set along with +Several other things like a <smbconfsection>[homes]</smbconfsection> and a +<smbconfsection>[netlogon]</smbconfsection> share also need to be set along with settings for the profile path, the users home drive, etc.. This will not be covered in this -chapter, for more information please refer to the chapter on <link linkend="samba-pdc">Domain Control</link>. +chapter, for more information please refer to <link linkend="samba-pdc">the chapter about samba as a PDC</link>. </para> </sect3> @@ -298,8 +300,8 @@ Several things have to be done: <listitem><para> The domain SID has to be the same on the PDC and the BDC. This used to be stored in the file private/MACHINE.SID. This file is not created - anymore since Samba 2.2.5 or even earlier. Nowadays the domain SID is - stored in the file private/secrets.tdb. Simply copying the secrets.tdb + since Samba 2.2.5. Nowadays the domain SID is stored in the file + private/secrets.tdb. Simply copying the secrets.tdb from the PDC to the BDC does not work, as the BDC would generate a new SID for itself and override the domain SID with this new BDC SID.</para> @@ -308,13 +310,13 @@ Several things have to be done: To retrieve the domain SID from the PDC or an existing BDC and store it in the secrets.tdb, execute: </para> - <screen> - &rootprompt;<userinput>net rpc getsid</userinput> - </screen> +<screen> +&rootprompt;<userinput>net rpc getsid</userinput> +</screen> </listitem> <listitem><para> - The Unix user database has to be synchronized from the PDC to the + The UNIX user database has to be synchronized from the PDC to the BDC. This means that both the /etc/passwd and /etc/group have to be replicated from the PDC to the BDC. This can be done manually whenever changes are made, or the PDC is set up as a NIS master @@ -350,21 +352,38 @@ Several things have to be done: Finally, the BDC has to be found by the workstations. This can be done by setting: </para> -<para><programlisting> - workgroup = SAMBA - domain master = no - domain logons = yes -</programlisting></para> +<para><smbconfexample> +<title>Minimal setup for being a BDC</title> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +<smbconfoption><name>domain master</name><value>no</value></smbconfoption> +<smbconfoption><name>domain logons</name><value>yes</value></smbconfoption> +<smbconfoption><name>idmap backend</name><value>ldapsam://slave-ldap.quenya.org</value></smbconfoption> +</smbconfexample></para> <para> -in the <parameter>[global]</parameter>-section of the &smb.conf; of the BDC. This makes the BDC +In the <smbconfsection>[global]</smbconfsection>-section of the &smb.conf; of the BDC. This makes the BDC only register the name SAMBA<#1c> with the WINS server. This is no problem as the name SAMBA<#1c> is a NetBIOS group name that is meant to -be registered by more than one machine. The parameter 'domain master = -no' forces the BDC not to register SAMBA<#1b> which as a unique NetBIOS +be registered by more than one machine. The parameter +<smbconfoption><name>domain master</name><value>no</value></smbconfoption> +forces the BDC not to register SAMBA<#1b> which as a unique NetBIOS name is reserved for the Primary Domain Controller. </para> +<para> +The <parameter>idmap backend</parameter> will redirect the <command>winbindd</command> utility to +use the LDAP database to resolve all UIDs and GIDs for UNIX accounts. +</para> + +<note><para> +Samba-3 has introduced a new ID mapping facility. One of the features of this facility is that it +allows greater flexibility in how user and group IDs are handled in respect of NT Domain User and Group +SIDs. One of the new facilities provides for explicitly ensuring that UNIX / Linux UID and GID values +will be consistent on the PDC, all BDCs and all Domain Member servers. The parameter that controls this +is called <parameter>idmap backend</parameter>. Please refer to the man page for &smb.conf; for more information +regarding it's behaviour. Do NOT set this parameter except where an LDAP backend (ldapsam) is in use. +</para></note> + </sect2> </sect1> @@ -402,16 +421,11 @@ an slave LDAP server for each BDC, and a master LDAP server for the PDC. <para> With version 2.2, no. The native NT4 SAM replication protocols have not yet been fully implemented. The Samba Team is working on understanding and implementing the protocols, -but this work has not been finished for version 2.2. -</para> - -<para> -With version 3.0, the work on both the replication protocols and a suitable storage -mechanism has progressed, and some form of NT4 BDC support is expected soon. +but this work has not been finished for Samba-3. </para> <para> -Can I get the benefits of a BDC with Samba? Yes. The main reason for implementing a +Can I get the benefits of a BDC with Samba? Yes, but only to a Samba PDC. The main reason for implementing a BDC is availability. If the PDC is a Samba machine, a second Samba machine can be set up to service logon requests whenever the PDC is down. </para> diff --git a/docs/docbook/projdoc/Samba-PDC-HOWTO.xml b/docs/docbook/projdoc/Samba-PDC-HOWTO.xml index f208e16d28..78a875792c 100644 --- a/docs/docbook/projdoc/Samba-PDC-HOWTO.xml +++ b/docs/docbook/projdoc/Samba-PDC-HOWTO.xml @@ -3,13 +3,7 @@ <chapterinfo> &author.jht; &author.jerry; - <author> - <firstname>David</firstname><surname>Bannon</surname> - <affiliation> - <orgname>Samba Team</orgname> - <address><email>dbannon@samba.org</email></address> - </affiliation> - </author> + &author.dbannon; </chapterinfo> <title>Domain Control</title> @@ -26,12 +20,20 @@ that is already available. <para> The reader is advised NOT to tackle this section without having first understood and mastered some basics. MS Windows networking is not particularly forgiving of -misconfiguration. Users of MS Windows networking are likely to complain bitterly -of persistent niggles that may be caused by broken network or system configuration. +misconfiguration. Users of MS Windows networking are likely to complain +of persistent niggles that may be caused by a broken network configuration. To a great many people however, MS Windows networking starts with a domain controller that in some magical way is expected to solve all ills. </para> +<figure id="domain-example"><title>An Example Domain</title> +<mediaobject> +<imageobject role="latex"><imagedata fileref="projdoc/imagefiles/domain" scalefit="1"/></imageobject> +<imageobject><imagedata fileref="projdoc/imagefiles/domain.png" scale="50" scalefit="1"/></imageobject> +</mediaobject> +</figure> + + <para> From the Samba mailing list one can readily identify many common networking issues. If you are not clear on the following subjects, then it will do much good to read the @@ -39,18 +41,18 @@ sections of this HOWTO that deal with it. These are the most common causes of MS networking problems: </para> -<simplelist> - <member>Basic TCP/IP configuration</member> - <member>NetBIOS name resolution</member> - <member>Authentication configuration</member> - <member>User and Group configuration</member> - <member>Basic File and Directory Permission Control in Unix/Linux</member> - <member>Understanding of how MS Windows clients interoperate in a network - environment</member> -</simplelist> +<itemizedlist> + <listitem><para>Basic TCP/IP configuration</para></listitem> + <listitem><para>NetBIOS name resolution</para></listitem> + <listitem><para>Authentication configuration</para></listitem> + <listitem><para>User and Group configuration</para></listitem> + <listitem><para>Basic File and Directory Permission Control in UNIX/Linux</para></listitem> + <listitem><para>Understanding of how MS Windows clients interoperate in a network + environment</para></listitem> +</itemizedlist> <para> -Do not be put off; on the surface of it MS Windows networking seems so simple that any fool +Do not be put off; on the surface of it MS Windows networking seems so simple that anyone can do it. In fact, it is not a good idea to set up an MS Windows network with inadequate training and preparation. But let's get our first indelible principle out of the way: <emphasis>It is perfectly OK to make mistakes!</emphasis> In the right place and at @@ -83,7 +85,12 @@ security protocols. </para> <para> -The benefits of Domain security are fully available to those sites that deploy a Samba PDC. +The benefits of Domain security are available to those sites that deploy a Samba PDC. +A Domain provides a unique network security identifier (SID). Domain user and group security +identifiers are comprised of the network SID plus a relative identifier (RID) that is unique to +the account. User and Group SIDs (the network SID plus the RID) can be used to create Access Control +Lists (ACLs) attached to network resources to provide organizational access control. UNIX systems +know only of local security identifiers. </para> <note><para> @@ -91,7 +98,7 @@ Network clients of an MS Windows Domain security environment must be Domain memb able to gain access to the advanced features provided. Domain membership involves more than just setting the workgroup name to the Domain name. It requires the creation of a Domain trust account for the workstation (called a machine account). Please refer to the chapter on -<link linkend="domain-member">Domain Membership</link> for more information. +<link linkend="domain-member">setting up samba as a domain member</link> for more information. </para></note> <para> @@ -106,8 +113,7 @@ The following functionalities are new to the Samba-3 release: <listitem><para> Adding users via the User Manager for Domains. This can be done on any MS Windows client using the Nexus toolkit that is available from Microsoft's web site. - At some later date Samba-3 may get support for the use of the Microsoft Management - Console for user management. + Samba-3 supports the use of the Microsoft Management Console for user management. </para></listitem> <listitem><para> @@ -131,7 +137,9 @@ The following functionalities are NOT provided by Samba-3: <itemizedlist> <listitem><para> SAM replication with Windows NT4 Domain Controllers - (i.e. a Samba PDC and a Windows NT BDC or vice versa) + (i.e. a Samba PDC and a Windows NT BDC or vice versa). This means samba + cannot operate as a BDC when the PDC is Microsoft-based or + replicate account data to Windows-BDC's. </para></listitem> <listitem><para> @@ -140,7 +148,9 @@ The following functionalities are NOT provided by Samba-3: Active Directory Domain Control ability that is at this time purely experimental <emphasis>AND</emphasis> that is certain to change as it becomes a fully supported feature some time - during the Samba-3 (or later) life cycle. + during the Samba-3 (or later) life cycle. However, Active Directory is + more then just SMB - it's also LDAP, Kerberos, DHCP and other protocols + (with proprietary extensions, of course). </para></listitem> </itemizedlist> @@ -154,68 +164,18 @@ in Samba since approximately the Samba-1.9.15 series. <para> Samba-3 has an implementation of group mapping between Windows NT groups -and Unix groups (this is really quite complicated to explain in a short space). This is -discussed more fully in the <link linkend="groupmapping">Group Mapping</link> chapter. +and UNIX groups (this is really quite complicated to explain in a short space). This is +discussed more fully in <link linkend="groupmapping">the chapter on group mapping</link>. </para> <para> Samba-3, like an MS Windows NT4 PDC or a Windows 200x Active Directory, needs to store -user and machine trust account information in a suitable backend data store. With Samba-3 -there can be multiple back-ends for this including: +user and machine trust account information in a suitable backend data store. +Refer <link linkend="machine-trust-accounts">to the section on machine trust accounts</link>. With Samba-3 there can be multiple +back-ends for this. A complete discussion of account database backends can be found in +<link linkend="passdb">the chapter on Account Information Databases</link>. </para> -<!-- FIXME: Doesn't this belong in passdb.xml ? --> - -<itemizedlist> - <listitem><para> - <emphasis>smbpasswd</emphasis> - the plain ASCII file stored used by - earlier versions of Samba. This file configuration option requires - a Unix/Linux system account for EVERY entry (ie: both for user and for - machine accounts). This file will be located in the <emphasis>private</emphasis> - directory (default is /usr/local/samba/lib/private or on linux /etc/samba). - </para></listitem> - - <listitem><para> - <emphasis>tdbsam</emphasis> - a binary database backend that will be - stored in the <emphasis>private</emphasis> directory in a file called - <emphasis>passdb.tdb</emphasis>. The key benefit of this binary format - file is that it can store binary objects that can not be accommodated - in the traditional plain text smbpasswd file. These permit the extended - account controls that MS Windows NT4 and later also have. - </para></listitem> - - <listitem><para> - <emphasis>ldapsam</emphasis> - An LDAP based back-end. Permits the - LDAP server to be specified. eg: ldap://localhost or ldap://frodo.murphy.com. - Like the tdbsam, ldapsam permits the storing of extended account attributes - for control of things like: Permitted access times, password activation and - expiry, permitted points of access (workstation names), per user profile - location, and much more. - </para></listitem> - - <listitem><para> - <emphasis>ldapsam_compat</emphasis> - An LDAP back-end that maintains backwards - compatibility with the behaviour of samba-2.2.x. You should use this in the process - of migrating from samba-2.2.x to samba-3 if you do not want to rebuild your LDAP - database. - </para></listitem> -</itemizedlist> - -<para> -Read the chapter about <link linkend="passdb">Account Information Database</link> for details -regarding the choices available and how to configure them. -</para> - -<note><para> -The new tdbsam and ldapsam account backends store substantially more information than -smbpasswd is capable of. The new backend database includes capacity to specify -per user settings for many parameters, over-riding global settings given in the -<filename>smb.conf</filename> file. eg: logon drive, logon home, logon path, etc. -Thus, with samba-3 it is possible to have a default system configuration for profiles, -and on a per user basis to over-ride this for those users who should not be subject -to the default configuration. -</para></note> - </sect1> <sect1> @@ -238,23 +198,23 @@ there are three basic types of domain controllers: <para> The <emphasis>Primary Domain Controller</emphasis> or PDC plays an important role in the MS -Windows NT4 and Windows 200x Domain Control architecture, but not in the manner that so many -expect. There is folk lore that dictates that because of it's role in the MS Windows -network, the PDC should be the most powerful and most capable machine in the network. +Windows NT4. In Windows 200x Domain Control architecture this role is held by domain controllers. +There is folk lore that dictates that because of it's role in the MS Windows +network, the domain controllers should be the most powerful and most capable machine in the network. As strange as it may seem to say this here, good over all network performance dictates that -the entire infrastructure needs to be balanced. It is advisable to invest more in the Backup -Domain Controllers and Stand-Alone (or Domain Member) servers than in the PDC. +the entire infrastructure needs to be balanced. It is advisable to invest more in Stand-Alone +(or Domain Member) servers than in the domain controllers. </para> <para> -In the case of MS Windows NT4 style domains, it is the PDC seeds the Domain Control database, -a part of the Windows registry called the SAM (Security Account Manager). It plays a key +In the case of MS Windows NT4 style domains, it is the PDC that initiates a new Domain Control database. +This forms a part of the Windows registry called the SAM (Security Account Manager). It plays a key part in NT4 type domain user authentication and in synchronisation of the domain authentication database with Backup Domain Controllers. </para> <para> -With MS Windows 200x Server based Active Directory domains, one domain controller seeds a potential +With MS Windows 200x Server based Active Directory domains, one domain controller initiates a potential hierarchy of domain controllers, each with their own area of delegated control. The master domain controller has the ability to override any down-stream controller, but a down-line controller has control only over it's down-line. With Samba-3 this functionality can be implemented using an @@ -264,9 +224,7 @@ LDAP based user and machine account back end. <para> New to Samba-3 is the ability to use a back-end database that holds the same type of data as the NT4 style SAM (Security Account Manager) database (one of the registry files). -The Samba-3 SAM can be specified via the smb.conf file parameter -<parameter>passwd backend</parameter> and valid options include -<emphasis>smbpasswd, tdbsam, ldapsam, nisplussam, xmlsam, mysqlsam, guest</emphasis>. +<footnote><para>See also <link linkend="passdb">the chapter on Account Information Databases</link>.</para></footnote> </para> <para> @@ -307,10 +265,20 @@ MS Windows 200x domain control protocols also. <para> At this time any appearance that Samba-3 is capable of acting as an -<emphasis>ADS Domain Controller</emphasis> is limited and experimental in nature. +<emphasis>Domain Controller</emphasis> in native ADS mode is limited and experimental in nature. This functionality should not be used until the Samba-Team offers formal support for it. At such a time, the documentation will be revised to duly reflect all configuration and -management requirements. +management requirements. Samba can act as a NT4-style DC in a Windows 2000/XP +environment. However, there are certain compromises: + +<itemizedlist> + <listitem><para>No machine policy files</para></listitem> + <listitem><para>No Group Policy Objects</para></listitem> + <listitem><para>No synchronously executed AD logon scripts</para></listitem> + <listitem><para>Can't use ANY Active Directory management tools to manage users and machines</para></listitem> + <listitem><para>Registry changes tattoo the main registry, while with AD they do NOT. ie: Leave permanent changes in effect</para></listitem> + <listitem><para>Without AD you can not peprform the function of exporting specific applications to specific users or groups</para></listitem> +</itemizedlist> </para> </sect2> @@ -346,9 +314,8 @@ Domain it triggers a machine password change. <note><para> When running a Domain all MS Windows NT / 200x / XP Professional clients should be configured as full Domain Members - IF A SECURE NETWORK IS WANTED. If the machine is NOT made a member of the -Domain, then it will operate like a workgroup (stand-alone) machine. Please refer the -<link linkend="domain-member">Domain Membership</link> chapter for information regarding - HOW to make your MS Windows clients Domain members. +Domain, then it will operate like a workgroup (stand-alone) machine. Please refer to +<link linkend="domain-member">the chapter on domain membership</link> for information regarding HOW to make your MS Windows clients Domain members. </para></note> <para> @@ -356,41 +323,41 @@ The following are necessary for configuring Samba-3 as an MS Windows NT4 style P NT4 / 200x / XP clients. </para> -<simplelist> - <member>Configuration of basic TCP/IP and MS Windows Networking</member> - <member>Correct designation of the Server Role (<parameter>security = user</parameter>)</member> - <member>Consistent configuration of Name Resolution (See chapter on <link linkend="NetworkBrowsing">Browsing</link> and on - <link linkend="integrate-ms-networks">MS Windows network Integration</link>)</member> - <member>Domain logons for Windows NT4 / 200x / XP Professional clients</member> - <member>Configuration of Roaming Profiles or explicit configuration to force local profile usage</member> - <member>Configuration of Network/System Policies</member> - <member>Adding and managing domain user accounts</member> - <member>Configuring MS Windows client machines to become domain members</member> -</simplelist> +<itemizedlist> + <listitem><para>Configuration of basic TCP/IP and MS Windows Networking</para></listitem> + <listitem><para>Correct designation of the Server Role (<smbconfoption><name>security</name><value>user</value></smbconfoption>)</para></listitem> + <listitem><para>Consistent configuration of Name Resolution (See chapter on <link linkend="NetworkBrowsing">Network Browsing</link> and on + <link linkend="integrate-ms-networks">Integrating Unix into Windows networks</link>)</para></listitem> + <listitem><para>Domain logons for Windows NT4 / 200x / XP Professional clients</para></listitem> + <listitem><para>Configuration of Roaming Profiles or explicit configuration to force local profile usage</para></listitem> + <listitem><para>Configuration of Network/System Policies</para></listitem> + <listitem><para>Adding and managing domain user accounts</para></listitem> + <listitem><para>Configuring MS Windows client machines to become domain members</para></listitem> +</itemizedlist> <para> The following provisions are required to serve MS Windows 9x / Me Clients: </para> -<simplelist> - <member>Configuration of basic TCP/IP and MS Windows Networking</member> - <member>Correct designation of the Server Role (<parameter>security = user</parameter>)</member> - <member>Network Logon Configuration (Since Windows 9x / XP Home are not technically domain - members, they do not really participate in the security aspects of Domain logons as such)</member> - <member>Roaming Profile Configuration</member> - <member>Configuration of System Policy handling</member> - <member>Installation of the Network driver "Client for MS Windows Networks" and configuration - to log onto the domain</member> - <member>Placing Windows 9x / Me clients in user level security - if it is desired to allow - all client share access to be controlled according to domain user / group identities.</member> - <member>Adding and managing domain user accounts</member> -</simplelist> +<itemizedlist> + <listitem><para>Configuration of basic TCP/IP and MS Windows Networking</para></listitem> + <listitem><para>Correct designation of the Server Role (<smbconfoption><name>security</name><value>user</value></smbconfoption>)</para></listitem> + <listitem><para>Network Logon Configuration (Since Windows 9x / XP Home are not technically domain + members, they do not really participate in the security aspects of Domain logons as such)</para></listitem> + <listitem><para>Roaming Profile Configuration</para></listitem> + <listitem><para>Configuration of System Policy handling</para></listitem> + <listitem><para>Installation of the Network driver "Client for MS Windows Networks" and configuration + to log onto the domain</para></listitem> + <listitem><para>Placing Windows 9x / Me clients in user level security - if it is desired to allow + all client share access to be controlled according to domain user / group identities.</para></listitem> + <listitem><para>Adding and managing domain user accounts</para></listitem> +</itemizedlist> <note><para> Roaming Profiles and System/Network policies are advanced network administration topics that are covered in the <link linkend="ProfileMgmt">Profile Management</link> and -<link linkend="PolicyMgmt">Policy Management</link> chapters of this document. However, these are not necessarily specific -to a Samba PDC as much as they are related to Windows NT networking concepts. +<link linkend="PolicyMgmt">Policy Management</link> chapters of this document. However, these are not +necessarily specific to a Samba PDC as much as they are related to Windows NT networking concepts. </para></note> <para> @@ -415,11 +382,13 @@ A Domain Controller is an SMB/CIFS server that: </para></listitem> </itemizedlist> +<!-- FIXME: Provide link for "domain master browser" --> + <para> For Samba to provide these is rather easy to configure. Each Samba Domain Controller must provide -the NETLOGON service which Samba calls the <emphasis>domain logons</emphasis> functionality +the NETLOGON service which Samba calls the <smbconfoption><name>domain logons</name></smbconfoption> functionality (after the name of the parameter in the &smb.conf; file). Additionally, one (1) server in a Samba-3 -Domain must advertise itself as the domain master browser. This causes the Primary Domain Controller +Domain must advertise itself as the domain master browser<footnote><para>See also <link linkend="NetworkBrowsing">the chapter about network browsing</link></para></footnote>. This causes the Primary Domain Controller to claim domain specific NetBIOS name that identifies it as a domain master browser for its given domain/workgroup. Local master browsers in the same domain/workgroup on broadcast-isolated subnets then ask for a complete copy of the browse list for the whole wide area network. Browser clients @@ -435,101 +404,119 @@ instead of just the list for their broadcast-isolated subnet. <para> The first step in creating a working Samba PDC is to understand the parameters necessary -in &smb.conf;. Here we attempt to explain the parameters that are covered in -the &smb.conf; man page. -</para> - -<para> -Here is an example &smb.conf; for acting as a PDC: -</para> - -<para><programlisting> - [global] - ; Basic server settings - <ulink url="smb.conf.5.html#NETBIOSNAME">netbios name</ulink> = <replaceable>POGO</replaceable> - <ulink url="smb.conf.5.html#WORKGROUP">workgroup</ulink> = <replaceable>NARNIA</replaceable> - - ; User and Machine Account Backends - ; Choices are: tdbsam, smbpasswd, ldapsam, mysqlsam, xmlsam, guest - <ulink url="smb.conf.5.html#PASSDBBACKEND">passdb backend</ulink> = ldapsam, guest - - ; we should act as the domain and local master browser - <ulink url="smb.conf.5.html#OSLEVEL">os level</ulink> = 64 - <ulink url="smb.conf.5.html#PERFERREDMASTER">preferred master</ulink> = yes - <ulink url="smb.conf.5.html#DOMAINMASTER">domain master</ulink> = yes - <ulink url="smb.conf.5.html#LOCALMASTER">local master</ulink> = yes - - ; security settings (must user security = user) - <ulink url="smb.conf.5.html#SECURITYEQUALSUSER">security</ulink> = user - - ; encrypted passwords are a requirement for a PDC (default = Yes) - <ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords</ulink> = yes - - ; support domain logons - <ulink url="smb.conf.5.html#DOMAINLOGONS">domain logons</ulink> = yes - - ; where to store user profiles? - <ulink url="smb.conf.5.html#LOGONPATH">logon path</ulink> = \\%N\profiles\%u - - ; where is a user's home directory and where should it be mounted at? - <ulink url="smb.conf.5.html#LOGONDRIVE">logon drive</ulink> = H: - <ulink url="smb.conf.5.html#LOGONHOME">logon home</ulink> = \\homeserver\%u\winprofile - - ; specify a generic logon script for all users - ; this is a relative **DOS** path to the [netlogon] share - <ulink url="smb.conf.5.html#LOGONSCRIPT">logon script</ulink> = logon.cmd - - ; necessary share for domain controller - [netlogon] - <ulink url="smb.conf.5.html#PATH">path</ulink> = /usr/local/samba/lib/netlogon - <ulink url="smb.conf.5.html#READONLY">read only</ulink> = yes - <ulink url="smb.conf.5.html#WRITELIST">write list</ulink> = <replaceable>ntadmin</replaceable> - - ; share for storing user profiles - [profiles] - <ulink url="smb.conf.5.html#PATH">path</ulink> = /export/smb/ntprofile - <ulink url="smb.conf.5.html#READONLY">read only</ulink> = no - <ulink url="smb.conf.5.html#CREATEMASK">create mask</ulink> = 0600 - <ulink url="smb.conf.5.html#DIRECTORYMASK">directory mask</ulink> = 0700 -</programlisting></para> +in &smb.conf;. An example &smb.conf; for acting as a PDC can be found in the example +<link linkend="pdc-example">for being a PDC</link>. +</para> + +<para> +<smbconfexample id="pdc-example"> +<title>smb.conf for being a PDC</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>netbios name</name><value><replaceable>BELERIAND</replaceable></value></smbconfoption> +<smbconfoption><name>workgroup</name><value><replaceable>&example.workgroup;</replaceable></value></smbconfoption> +<smbconfoption><name>passdb backend</name><value>ldapsam, guest</value></smbconfoption> +<smbconfoption><name>os level</name><value>33</value></smbconfoption> +<smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> +<smbconfoption><name>domain master</name><value>yes</value></smbconfoption> +<smbconfoption><name>local master</name><value>yes</value></smbconfoption> +<smbconfoption><name>security</name><value>user</value></smbconfoption> +<smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption> +<smbconfoption><name>domain logons</name><value>yes</value></smbconfoption> +<smbconfoption><name>logon path</name><value>\\%N\profiles\%u</value></smbconfoption> +<smbconfoption><name>logon drive</name><value>H:</value></smbconfoption> +<smbconfoption><name>logon home</name><value>\\homeserver\%u\winprofile</value></smbconfoption> +<smbconfoption><name>logon script</name><value>logon.cmd</value></smbconfoption> + +<smbconfsection>[netlogon]</smbconfsection> +<smbconfoption><name>path</name><value>/var/lib/samba/netlogon</value></smbconfoption> +<smbconfoption><name>read only</name><value>yes</value></smbconfoption> +<smbconfoption><name>write list</name><value><replaceable>ntadmin</replaceable></value></smbconfoption> + +<smbconfsection>[profiles]</smbconfsection> +<smbconfoption><name>path</name><value>/var/lib/samba/profiles</value></smbconfoption> +<smbconfoption><name>read only</name><value>no</value></smbconfoption> +<smbconfoption><name>create mask</name><value>0600</value></smbconfoption> +<smbconfoption><name>directory mask</name><value>0700</value></smbconfoption> +</smbconfexample> +</para> + +<para> +The basic options shown above are explained as follows: +</para> + +<variablelist> + <varlistentry><term>passdb backend</term> + <listitem><para> + This contains all the user and group account information. Acceptable values for a PDC + are: <emphasis>smbpasswd, tdbsam, ldapsam</emphasis>. The 'guest' entry provides needed + default accounts.</para> + + <para> + Where is is intended to use backup domain controllers (BDCs) the only logical choice is + to use LDAP so that the passdb backend can be distributed. The tdbsam and smbpasswd files + can not effectively be distributed and therefore should not be used. + </para></listitem> + </varlistentry> + <varlistentry><term>Domain Control Parameters</term> + <listitem><para> + The parameters <emphasis>os level, preferred master, domain master, security, + encrypt passwords, domain logons</emphasis> play a central role in assuring domain + control and network logon support.</para> + + <para> + The <emphasis>os level</emphasis> must be set at or above a value of 32. A domain controller + must be the domain master browser, must be set in <emphasis>user</emphasis> mode security, + must support Microsoft compatible encrypted passwords, and must provide the network logon + service (domain logons). Encrypted passwords must be enabled, for more details on how + to do this, refer to <link linkend="passdb">the chapter on account information databases</link>. + </para></listitem> + </varlistentry> + <varlistentry><term>Environment Parameters</term> + <listitem><para> + The parameters <emphasis>logon path, logon home, logon drive, logon script</emphasis> are + environment support settings that help to facilitate client logon operations and that help + to provide automated control facilities to ease network management overheads. Please refer + to the man page information for these parameters. + </para></listitem> + </varlistentry> + <varlistentry><term>NETLOGON Share</term> + <listitem><para> + The NETLOGON share plays a central role in domain logon and domain membership support. + This share is provided on all Microsoft domain controllers. It is used to provide logon + scripts, to store Group Policy files (NTConfig.POL), as well as to locate other common + tools that may be needed for logon processing. This is an essential share on a domain controller. + </para></listitem> + </varlistentry> + <varlistentry><term>PROFILE Share</term> + <listitem><para> + This share is used to store user desktop profiles. Eash user must have a directory at the root + of this share. This directory must be write enabled for the user and must be globally read enabled. + Samba-3 has a VFS module called 'fake_permissions' that may be installed on this share. This will + allow a Samba administrator to make the directory read only to everyone. Of course this is useful + only after the profile has been properly created. + </para></listitem> + </varlistentry> +</variablelist> <note><para> The above parameters make for a full set of parameters that may define the server's mode -of operation. The following parameters are the essentials alone: - -<programlisting> - workgroup = NARNIA - domain logons = Yes - domain master = Yes - security = User -</programlisting> - -The additional parameters shown in the longer listing above just makes for a -more complete environment. -</para></note> +of operation. The following &smb.conf; parameters are the essentials alone: +</para> <para> -There are a couple of points to emphasize in the above configuration. +<smbconfblock> +<smbconfoption><name>netbios name</name><value>BELERIAND</value></smbconfoption> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +<smbconfoption><name>domain logons</name><value>Yes</value></smbconfoption> +<smbconfoption><name>domain master</name><value>Yes</value></smbconfoption> +<smbconfoption><name>security</name><value>User</value></smbconfoption> +</smbconfblock> </para> -<itemizedlist> - <listitem><para> - Encrypted passwords must be enabled. For more details on how - to do this, refer to <link linkend="passdb">Account Information Database chapter</link>. - </para></listitem> - - <listitem><para> - The server must support domain logons and have a - <parameter>[netlogon]</parameter> share - </para></listitem> - - <listitem><para> - The server must be the domain master browser in order for Windows - client to locate the server as a DC. Please refer to the various - Network Browsing documentation included with this distribution for - details. - </para></listitem> -</itemizedlist> +<para> +The additional parameters shown in the longer listing above just makes for +more complete explanation. +</para></note> </sect1> @@ -537,12 +524,22 @@ There are a couple of points to emphasize in the above configuration. <title>Samba ADS Domain Control</title> <para> -Samba-3 is not and can not act as an Active Directory Server. It can not truly function as +Samba-3 is not, and can not act as, an Active Directory Server. It can not truly function as an Active Directory Primary Domain Controller. The protocols for some of the functionality -the Active Directory Domain Controllers is have been partially implemented on an experimental -only basis. Please do NOT expect Samba-3 to support these protocols - nor should you depend -on any such functionality either now or in the future. The Samba-Team may well remove such -experimental features or may change their behaviour. +the Active Directory Domain Controllers has been partially implemented on an experimental +only basis. Please do NOT expect Samba-3 to support these protocols. Do not depend +on any such functionality either now or in the future. The Samba-Team may remove these +experimental features or may change their behaviour. This is mentioned for the benefit of those +who have discovered secret capabilities in samba-3 and who have asked when this functionality will be +completed. The answer is: Maybe or maybe never! +</para> + +<para> +To be sure: Samba-3 is designed to provide most of the functionality that Microsoft Windows NT4 style +domain controllers have. Samba-3 does NOT have all the capabilities of Windows NT4, but it does have +a number of features that Windows NT4 domain contollers do not have. In short, Samba-3 is not NT4 and it +is not Windows Server 200x and it is not an Active Directory server. We hope this is plain and simple +enough for all to understand. </para> </sect1> @@ -551,7 +548,7 @@ experimental features or may change their behaviour. <title>Domain and Network Logon Configuration</title> <para> -The subject of Network or Domain Logons is discussed here because it rightly forms +The subject of Network or Domain Logons is discussed here because it forms an integral part of the essential functionality that is provided by a Domain Controller. </para> @@ -560,25 +557,26 @@ an integral part of the essential functionality that is provided by a Domain Con <para> All Domain Controllers must run the netlogon service (<emphasis>domain logons</emphasis> -in Samba). One Domain Controller must be configured with <parameter>domain master = Yes</parameter> -(the Primary Domain Controller); on ALL Backup Domain Controllers <parameter>domain master = No</parameter> +in Samba). One Domain Controller must be configured with <smbconfoption><name>domain master</name><value>Yes</value></smbconfoption> +(the Primary Domain Controller); on ALL Backup Domain Controllers <smbconfoption><name>domain master</name><value>No</value></smbconfoption> must be set. </para> <sect3> <title>Example Configuration</title> -<programlisting> - [global] - domain logons = Yes - domain master = (Yes on PDC, No on BDCs) +<smbconfexample> + <title>smb.conf for being a PDC</title> + <smbconfsection>[global]</smbconfsection> +<smbconfoption><name>domain logons</name><value>Yes</value></smbconfoption> +<smbconfoption><name>domain master</name><value>(Yes on PDC, No on BDCs)</value></smbconfoption> - [netlogon] - comment = Network Logon Service - path = /var/lib/samba/netlogon - guest ok = Yes - browseable = No -</programlisting> +<smbconfsection>[netlogon]</smbconfsection> +<smbconfoption><name>comment</name><value>Network Logon Service</value></smbconfoption> +<smbconfoption><name>path</name><value>/var/lib/samba/netlogon</value></smbconfoption> +<smbconfoption><name>guest ok</name><value>Yes</value></smbconfoption> +<smbconfoption><name>browseable</name><value>No</value></smbconfoption> +</smbconfexample> </sect3> <sect3> @@ -600,6 +598,8 @@ MS Windows XP Professional. <para> Now that this has been said, please do NOT ask the mailing list, or email any of the Samba-Team members with your questions asking how to make this work. It can't be done. +If it can be done, then to do so would violate your software license agreement with +Microsoft, and we recommend that you do not do that. </para> </sect3> @@ -608,7 +608,7 @@ Samba-Team members with your questions asking how to make this work. It can't be <title>The Special Case of Windows 9x / Me</title> <para> -A domain and a workgroup are exactly the same thing in terms of network +A domain and a workgroup are exactly the same in terms of network browsing. The difference is that a distributable authentication database is associated with a domain, for secure login access to a network. Also, different access rights can be granted to users if they @@ -635,7 +635,7 @@ which are the focus of this section. When an SMB client in a domain wishes to logon, it broadcasts 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 +It is possible (but ill advised ) to create a domain where the user 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 @@ -727,7 +727,7 @@ The main difference between a PDC and a Windows 9x logon server configuration is <listitem><para> Password encryption is not required for a Windows 9x logon server. But note that beginning with MS Windows 98 the default setting is that plain-text - password support has been disabled. It can be re-enabled with the registry + password support is disabled. It can be re-enabled with the registry changes that are documented in the chapter on Policies. </para></listitem> @@ -741,6 +741,11 @@ A Samba PDC will act as a Windows 9x logon server; after all, it does provide th network logon services that MS Windows 9x / Me expect to find. </para> +<note><para> +Use of plain-text passwords is strongly discouraged. Where used they are easily detected +using a sniffer tool to examine network traffic. +</para></note> + </sect3> </sect2> @@ -766,17 +771,18 @@ are two distinctly different functions), it is not a good idea to do 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. +A DMB is a Domain Master Browser - see <link linkend="DMB">Domain Master Browser</link>. For this reason, it is very wise to configure the Samba DC as the DMB. </para> <para> Now back to the issue of configuring a Samba DC to use a mode other -than <parameter>security = user</parameter>. If a Samba host is configured to use +than <smbconfoption><name>security</name><value>user</value></smbconfoption>. If a Samba host is configured to use another SMB server or DC in order to validate user connection requests, then it is a fact that some other machine on the network -(the <parameter>password server</parameter>) knows more about the user than the Samba host. +(the <smbconfoption><name>password server</name></smbconfoption>) knows more about the user than the Samba host. 99% of the time, this other host is a domain controller. Now -in order to operate in domain mode security, the <parameter>workgroup</parameter> parameter +in order to operate in domain mode security, the <smbconfoption><name>workgroup</name></smbconfoption> parameter must be set to the name of the Windows NT domain (which already has a domain controller). If the domain does NOT already have a Domain Controller then you do not yet have a Domain! @@ -785,7 +791,7 @@ then you do not yet have a Domain! <para> Configuring a Samba box as a DC for a domain that already by definition has a PDC is asking for trouble. Therefore, you should always configure the Samba DC -to be the DMB for its domain and set <parameter>security = user</parameter>. +to be the DMB for its domain and set <smbconfoption><name>security</name><value>user</value></smbconfoption>. This is the only officially supported mode of operation. </para> @@ -794,10 +800,10 @@ This is the only officially supported mode of operation. </sect1> <sect1> -<title>Common Problems and Errors</title> +<title>Common Errors</title> <sect2> -<title>I cannot include a '$' in a machine name</title> + <title>'$' cannot be included in machine name</title> <para> A 'machine account', (typically) stored in <filename>/etc/passwd</filename>, takes the form of the machine name with a '$' appended. FreeBSD (and other BSD @@ -809,12 +815,19 @@ The problem is only in the program used to make the entry. Once made, it works p Create a user without the '$'. Then use <command>vipw</command> to edit the entry, adding the '$'. Or create the whole entry with vipw if you like; make sure you use a unique User ID! </para> + +<note><para> +The UNIX tool <command>vipw</command> is a common tool for directly editting the <filename>/etc/passwd</filename> file. +</para></note> + </sect2> <sect2> -<title>I get told "You already have a connection to the Domain...." + <title>Joining domain fails because of existing machine account</title> + +<para><quote>I get told "You already have a connection to the Domain...." or "Cannot join domain, the credentials supplied conflict with an -existing set.." when creating a machine trust account.</title> +existing set.." when creating a machine trust account.</quote></para> <para> This happens if you try to create a machine trust account from the @@ -824,7 +837,7 @@ will remove all network drive connections: </para> <screen> - <prompt>C:\WINNT\></prompt> <userinput>net use * /d</userinput> +&dosprompt;<userinput>net use * /d</userinput> </screen> <para> @@ -838,10 +851,10 @@ does not matter what, reboot, and try again. <sect2> <title>The system can not log you on (C000019B)....</title> -<para>I joined the domain successfully but after upgrading +<para><quote>I joined the domain successfully but after upgrading to a newer version of the Samba code I get the message, <errorname>The system can not log you on (C000019B), Please try again or consult your -system administrator</errorname> when attempting to logon. +system administrator</errorname> when attempting to logon.</quote> </para> <para> @@ -862,21 +875,27 @@ The reset or change the domain SID you can use the net command as follows: </screen> </para> +<para> +Workstation machine trust accounts work only with the Domain (or network) SID. If this SID changes +then domain members (workstations) will not be able to log onto the domain. The original Domain SID +can be recovered from the secrets.tdb file. The alternative is to visit each workstation to re-join +it to the domain. +</para> + </sect2> <sect2> -<title>The machine trust account for this computer either does not -exist or is not accessible.</title> + <title>The machine trust account not accessible</title> <para> -When I try to join the domain I get the message <errorname>The machine account + <quote>When I try to join the domain I get the message <errorname>The machine account for this computer either does not exist or is not accessible</errorname>. What's -wrong? +wrong?</quote> </para> <para> This problem is caused by the PDC not having a suitable machine trust account. -If you are using the <parameter>add machine script</parameter> method to create +If you are using the <smbconfoption><name>add machine script</name></smbconfoption> method to create accounts then this would indicate that it has not worked. Ensure the domain admin user system is working. </para> @@ -900,8 +919,10 @@ for both client and server. </sect2> <sect2> -<title>When I attempt to login to a Samba Domain from a NT4/W2K workstation, -I get a message about my account being disabled.</title> + <title>Account disabled</title> + + <para><quote>When I attempt to login to a Samba Domain from a NT4/W2K workstation, + I get a message about my account being disabled.</quote></para> <para> Enable the user accounts with <userinput>smbpasswd -e <replaceable>username</replaceable> @@ -911,11 +932,41 @@ Enable the user accounts with <userinput>smbpasswd -e <replaceable>username</rep </sect2> <sect2> - <title>Until a few minutes after Samba has started, clients get the error "Domain Controller Unavailable"</title> + <title>Domain Controller Unavailable</title> + + <para><quote>Until a few minutes after Samba has started, clients get the error "Domain Controller Unavailable"</quote></para> + <para> A domain controller has to announce on the network who it is. This usually takes a while. </para> </sect2> +<sect2> + <title>Can not log onto domain member workstation after joining domain</title> + + <para>After successfully joining the domain user logons fail with one of two messages:</para> + + <para>One to the effect that the domain controller can not be found, the other claiming that the + account does not exist in the domain or that the password is incorrect.</para> + + <para>This may be due to incompatible settings between + the Windows client and the Samba-3 server for <emphasis>schannel</emphasis> (secure channel) settings + or <emphasis>smb signing</emphasis> settings. Check your samba settings for <emphasis> + client schannel, server schannel, client signing, server signing</emphasis> by executing: + <command>testparm -v | more</command> and looking for the value of these parameters. + </para> + + <para> + Also use the Microsoft Management Console - Local Security Settings. This tool is available from the + Control Panel. The Policy settings are found in the Local Policies / Securty Options area and are prefixed by + <emphasis>Secure Channel: ..., and Digitally sign ...</emphasis>. + </para> + + <para> + It is important that these be set consistently with the Samba-3 server settings. + </para> + +</sect2> + </sect1> </chapter> diff --git a/docs/docbook/projdoc/ServerType.xml b/docs/docbook/projdoc/ServerType.xml index c740fbefb1..32a5103150 100644 --- a/docs/docbook/projdoc/ServerType.xml +++ b/docs/docbook/projdoc/ServerType.xml @@ -21,9 +21,10 @@ and how these relate to MS Windows servers and clients. </para> <para> -Firstly we should recognise the question so often asked, "Why would I want to use Samba?" -So, in those chapters where the answer may be important you will see a section that highlights -features and benefits. These may be for or against Samba. +A question often asked is, "Why would I want to use Samba?" Most chapters contain a section +that highlights features and benefits. We hope that the information provided will help to +answer this question. Be warned though, we want to be fair and reasonable, so not all +features are positive towards Samba so the benefit may be on the side of our competition. </para> <sect1> @@ -45,7 +46,7 @@ a source of discomfort. <para> Samba started out as a project that sought to provide interoperability for MS Windows 3.x -clients with a Unix server. It has grown up a lot since its humble beginnings and now provides +clients with a UNIX server. It has grown up a lot since its humble beginnings and now provides features and functionality fit for large scale deployment. It also has some warts. In sections like this one we will tell of both. </para> @@ -97,24 +98,24 @@ different type of servers:</para> <itemizedlist> <listitem><para>Domain Controller</para> - <simplelist> - <member>Primary Domain Controller</member> - <member>Backup Domain Controller</member> - <member>ADS Domain Controller</member> - </simplelist> + <itemizedlist> + <listitem><para>Primary Domain Controller</para></listitem> + <listitem><para>Backup Domain Controller</para></listitem> + <listitem><para>ADS Domain Controller</para></listitem> + </itemizedlist> </listitem> <listitem><para>Domain Member Server</para> - <simplelist> - <member>Active Directory Member Server</member> - <member>NT4 Style Domain Member Server</member> - </simplelist> + <itemizedlist> + <listitem><para>Active Directory Domain Server</para></listitem> + <listitem><para>NT4 Style Domain Domain Server</para></listitem> + </itemizedlist> </listitem> <listitem><para>Stand Alone Server</para></listitem> </itemizedlist> <para> The chapters covering Domain Control, Backup Domain Control and Domain Membership provide -pertinent information regarding Samba-3 configuration for each of these server roles. +pertinent information regarding Samba configuration for each of these server roles. The reader is strongly encouraged to become intimately familiar with the information presented. </para> @@ -125,7 +126,7 @@ presented. <title>Samba Security Modes</title> <para> -In this section the function and purpose of Samba's <parameter>security</parameter> +In this section the function and purpose of Samba's <smbconfoption><name>security</name></smbconfoption> modes are described. An accurate understanding of how Samba implements each security mode as well as how to configure MS Windows clients for each mode will significantly reduce user complaints and administrator heartache. @@ -144,7 +145,7 @@ modes. They are documented in this chapter. </para> <para> -A SMB server tells the client at startup what <parameter>security level</parameter> + A SMB server tells the client at startup what <emphasis>security level</emphasis> it is running. There are two options: <emphasis>share level</emphasis> and <emphasis>user level</emphasis>. Which of these two the client receives affects the way the client then tries to authenticate itself. It does not directly affect @@ -158,7 +159,7 @@ available and whether an action is allowed. <title>User Level Security</title> <para> -We will describe <parameter>user level</parameter> security first, as it's simpler. +We will describe <emphasis>user level</emphasis> security first, as it's simpler. In <emphasis>user level</emphasis> security, the client will send a <emphasis>session setup</emphasis> command directly after the protocol negotiation. This contains a username and password. The server can either accept or reject that @@ -193,9 +194,9 @@ authentication contexts in this way (WinDD is an example of an application that The &smb.conf; parameter that sets <emphasis>User Level Security</emphasis> is: </para> -<para><programlisting> - security = user -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>security</name><value>user</value></smbconfoption> +</smbconfblock></para> <para> This is the default setting since samba-2.2.x. @@ -231,7 +232,7 @@ level security. They normally send a valid username but no password. Samba recor this username in a list of <emphasis>possible usernames</emphasis>. When the client then does a <emphasis>tree connection</emphasis> it also adds to this list the name of the share they try to connect to (useful for home directories) and any users -listed in the <parameter>user =</parameter> &smb.conf; line. The password is then checked +listed in the <smbconfoption><name>user</name></smbconfoption> &smb.conf; line. The password is then checked in turn against these <emphasis>possible usernames</emphasis>. If a match is found then the client is authenticated as that user. </para> @@ -243,9 +244,9 @@ then the client is authenticated as that user. The &smb.conf; parameter that sets <emphasis>Share Level Security</emphasis> is: </para> -<para><programlisting> - security = share -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>security</name><value>share</value></smbconfoption> +</smbconfblock></para> <para> Please note that there are reports that recent MS Windows clients do not like to work @@ -259,7 +260,7 @@ with share mode security servers. You are strongly discouraged from using share <title>Domain Security Mode (User Level Security)</title> <para> -When Samba is operating in <parameter>security = domain</parameter> mode, +When Samba is operating in <smbconfoption><name>security</name><value>domain</value></smbconfoption> mode, the Samba server has a domain security trust account (a machine account) and will cause all authentication requests to be passed through to the domain controllers. </para> @@ -274,10 +275,10 @@ Samba as a Domain Member Server This method involves addition of the following parameters in the &smb.conf; file: </para> -<para><programlisting> - security = domain - workgroup = "name_of_NT_domain" -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>security</name><value>domain</value></smbconfoption> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +</smbconfblock></para> <para> In order for this method to work, the Samba server needs to join the MS Windows NT @@ -289,31 +290,29 @@ security domain. This is done as follows: the Server Manager, add a machine account for the Samba server. </para></step> - <step><para>Next, on the Unix/Linux system execute:</para> + <step><para>Next, on the UNIX/Linux system execute:</para> - <para>&rootprompt;<userinput>smbpasswd -j DOMAIN_NAME -r PDC_NAME</userinput> (samba-2.x)</para> - - <para>&rootprompt;<userinput>net join -U administrator%password</userinput> (samba-3)</para> + <para><screen>&rootprompt;<userinput>net rpc join -U administrator%password</userinput></screen></para> </step> </procedure> <note><para> -As of Samba-2.2.4 the Samba 2.2.x series can auto-join a Windows NT4 style Domain just -by executing: +Samba-2.2.4 and later can auto-join a Windows NT4 style Domain just by executing: <screen> -&rootprompt;<userinput>smbpasswd -j <replaceable>DOMAIN_NAME</replaceable> -r <replaceable>PDC_NAME</replaceable> -U Administrator%<replaceable>password</replaceable></userinput> +&rootprompt;<userinput>smbpasswd -j <replaceable>DOMAIN_NAME</replaceable> -r <replaceable>PDC_NAME</replaceable> \ + -U Administrator%<replaceable>password</replaceable></userinput> </screen> -As of Samba-3 the same can be done by executing: +Samba-3 can do the same by executing: <screen> -&rootprompt;<userinput>net join -U Administrator%<replaceable>password</replaceable></userinput> +&rootprompt;<userinput>net rpc join -U Administrator%<replaceable>password</replaceable></userinput> </screen> -It is not necessary with Samba-3 to specify the <replaceable>DOMAIN_NAME</replaceable> or the <replaceable>PDC_NAME</replaceable> as it -figures this out from the &smb.conf; file settings. +It is not necessary with Samba-3 to specify the <replaceable>DOMAIN_NAME</replaceable> or the +<replaceable>PDC_NAME</replaceable> as it figures this out from the &smb.conf; file settings. </para></note> <para> -Use of this mode of authentication does require there to be a standard Unix account +Use of this mode of authentication does require there to be a standard UNIX account for each 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 clients other than MS Windows through means such as setting an invalid shell in the @@ -322,13 +321,11 @@ MS Windows through means such as setting an invalid shell in the <para> An alternative to assigning UIDs to Windows users on a Samba member server is -presented in the <link linkend="winbind">Winbind Overview</link> chapter -in this HOWTO collection. +presented in <link linkend="winbind">the chapter about winbind</link>. </para> <para> -For more information of being a domain member, see the <link linkend="domain-member">Domain -Member</link> section of this Howto. + For more information of being a domain member, see <link linkend="domain-member">the chapter about domain membership</link>. </para> </sect3> @@ -339,41 +336,41 @@ Member</link> section of this Howto. <para> Both Samba 2.2 and 3.0 can join an Active Directory domain. This is -possible even if the domain is run in native mode. Active Directory in -native mode perfectly allows NT4-style domain members, contrary to +possible if the domain is run in native mode. Active Directory in +native mode perfectly allows NT4-style domain members. This is contrary to popular belief. The only thing that Active Directory in native mode prohibits is Backup Domain Controllers running NT4. </para> <para> -If you are running Active Directory starting with Samba 3.0 you can -however join as a native AD member. Why would you want to do that? +If you are using Active Directory, starting with Samba-3 you can +join as a native AD member. Why would you want to do that? Your security policy might prohibit the use of NT-compatible authentication protocols. All your machines are running Windows 2000 -and above and all use full Kerberos. In this case Samba as a NT4-style +and above and all use Kerberos. In this case Samba as a NT4-style domain would still require NT-compatible authentication data. Samba in -AD-member mode can accept Kerberos. +AD-member mode can accept Kerberos tickets. </para> <sect3> <title>Example Configuration</title> -<para><programlisting> - realm = your.kerberos.REALM - security = ADS -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>realm</name><value>your.kerberos.REALM</value></smbconfoption> +<smbconfoption><name>security</name><value>ADS</value></smbconfoption> +</smbconfblock></para> <para> - The following parameter may be required: +The following parameter may be required: </para> -<para><programlisting> - ads server = your.kerberos.server -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>ads server</name><value>your.kerberos.server</value></smbconfoption> +</smbconfblock></para> <para> -Please refer to the <link linkend="domain-member">Domain Membership</link> and <link linkend="ads-member">Active Directory -Membership</link> sections for more information regarding this configuration option. +Please refer to <link linkend="domain-member">the chapter on domain membership</link> +for more information regarding this configuration option. </para> </sect3> @@ -388,23 +385,23 @@ as a domain member server. It is highly recommended NOT to use this feature. Ser security mode has many draw backs. The draw backs include: </para> -<simplelist> - <member>Potential Account Lockout on MS Windows NT4/200x password servers</member> - <member>Lack of assurance that the password server is the one specified</member> - <member>Does not work with Winbind, particularly needed when storing profiles remotely</member> - <member>This mode may open connections to the password server, and keep them open for extended periods.</member> - <member>Security on the Samba server breaks badly when the remote password server suddenly shuts down</member> - <member>With this mode there is NO security account in the domain that the password server belongs to for the Samba server.</member> -</simplelist> +<itemizedlist> + <listitem><para>Potential Account Lockout on MS Windows NT4/200x password servers</para></listitem> + <listitem><para>Lack of assurance that the password server is the one specified</para></listitem> + <listitem><para>Does not work with Winbind, particularly needed when storing profiles remotely</para></listitem> + <listitem><para>This mode may open connections to the password server, and keep them open for extended periods.</para></listitem> + <listitem><para>Security on the Samba server breaks badly when the remote password server suddenly shuts down</para></listitem> + <listitem><para>With this mode there is NO security account in the domain that the password server belongs to for the Samba server.</para></listitem> +</itemizedlist> <para> In server security mode the Samba server reports to the client that it is in user level security. The client then does a <emphasis>session setup</emphasis> as described earlier. The Samba server takes the username/password that the client sends and attempts to login to the -<parameter>password server</parameter> by sending exactly the same username/password that +<smbconfoption><name>password server</name></smbconfoption> by sending exactly the same username/password that it got from the client. If that server is in user level security and accepts the password, then Samba accepts the clients connection. This allows the Samba server to use another SMB -server as the <parameter>password server</parameter>. +server as the <smbconfoption><name>password server</name></smbconfoption>. </para> <para> @@ -415,10 +412,10 @@ passwords in encrypted form. Samba supports this type of encryption by default. </para> <para> -The parameter <parameter>security = server</parameter> means that Samba reports to clients that +The parameter <smbconfoption><name>security</name><value>server</value></smbconfoption> means that Samba reports to clients that it is running in <emphasis>user mode</emphasis> but actually passes off all authentication requests to another <emphasis>user mode</emphasis> server. This requires an additional -parameter <parameter>password server</parameter> that points to the real authentication server. +parameter <smbconfoption><name>password server</name></smbconfoption> that points to the real authentication server. That real authentication server can be another Samba server or can be a Windows NT server, the later natively capable of encrypted password support. </para> @@ -443,11 +440,11 @@ Using MS Windows NT as an authentication server 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_a_DC" -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>encrypt passwords</name><value>Yes</value></smbconfoption> +<smbconfoption><name>security</name><value>server</value></smbconfoption> +<smbconfoption><name>password server</name><value>"NetBIOS_name_of_a_DC"</value></smbconfoption> +</smbconfblock></para> <para> @@ -465,7 +462,7 @@ certain number of failed authentication attempts this will result in user lockou </para> <para> -Use of this mode of authentication does require there to be a standard Unix account +Use of this mode of authentication does require there to be a standard UNIX account for the user, though this account can be blocked to prevent logons by non-SMB/CIFS clients. </para> @@ -475,7 +472,7 @@ for the user, though this account can be blocked to prevent logons by non-SMB/CI </sect1> <sect1> -<title>Seamless Windows Network Integration</title> +<title>Password checking</title> <para> MS Windows clients may use encrypted passwords as part of a challenge/response @@ -532,25 +529,25 @@ 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">password level</ulink> = <replaceable>integer</replaceable> - <ulink url="smb.conf.5.html#USERNAMELEVEL">username level</ulink> = <replaceable>integer</replaceable> -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>password level</name><value><replaceable>integer</replaceable></value></smbconfoption> +<smbconfoption><name>username level</name><value><replaceable>integer</replaceable></value></smbconfoption> +</smbconfblock></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 characters, the <parameter>username level</parameter> parameter +only contain lower-case character, the <smbconfoption><name>username level</name></smbconfoption> parameter is rarely needed. </para> <para> However, passwords 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> +server using clear text authentication, the <smbconfoption><name>password level</name></smbconfoption> must be set to the maximum number of upper case letters which <emphasis>could</emphasis> -appear in a password. Note that the server OS uses the traditional DES version -of crypt(), a <parameter>password level</parameter> of 8 will result in case +appear in a password. Note that if the server OS uses the traditional DES version +of crypt(), a <smbconfoption><name>password level</name></smbconfoption> of 8 will result in case insensitive passwords as seen from Windows users. This will also result in longer login times as Samba has to compute the permutations of the password string and try them one by one until a match is located (or all combinations fail). @@ -586,7 +583,7 @@ to those for whom English is not their native tongue. <para> To some the nature of the Samba <emphasis>security</emphasis> mode is very obvious, but entirely -wrong all the same. It is assumed that <parameter>security = server</parameter> means that Samba +wrong all the same. It is assumed that <smbconfoption><name>security</name><value>server</value></smbconfoption> means that Samba will act as a server. Not so! See above - this setting means that Samba will <emphasis>try</emphasis> to use another SMB server as its source of user authentication alone. </para> @@ -597,7 +594,7 @@ to use another SMB server as its source of user authentication alone. <title>What makes Samba a Domain Controller?</title> <para> -The &smb.conf; parameter <parameter>security = domain</parameter> does NOT really make Samba behave +The &smb.conf; parameter <smbconfoption><name>security</name><value>domain</value></smbconfoption> does NOT really make Samba behave as a Domain Controller! This setting means we want Samba to be a domain member! </para> @@ -607,9 +604,9 @@ as a Domain Controller! This setting means we want Samba to be a domain member! <title>What makes Samba a Domain Member?</title> <para> -Guess! So many others do. But whatever you do, do NOT think that <parameter>security = user</parameter> +Guess! So many others do. But whatever you do, do NOT think that <smbconfoption><name>security</name><value>user</value></smbconfoption> makes Samba act as a domain member. Read the manufacturers manual before the warranty expires! See -the <link linkend="domain-member">Domain Member</link> section of this Howto for more information. +<link linkend="domain-member">the chapter about domain membership</link> for more information. </para> </sect2> @@ -619,16 +616,17 @@ the <link linkend="domain-member">Domain Member</link> section of this Howto for <title>Constantly Losing Connections to Password Server</title> <para> + <quote> Why does server_validate() simply give up rather than re-establishing its connection to the password server? Though I am not fluent in the SMB protocol, perhaps the cluster server process passes along to its client workstation the session key it receives from the password server, which means the password hashes submitted by the client would not work on a subsequent -connection, whose session key would be different. So server_validate() must give up. +connection, whose session key would be different. So server_validate() must give up.</quote> </para> <para> -Indeed. That's why security = server is at best a nasty hack. Please use security = domain. -<parameter>security = server</parameter> mode is also known as pass-through authentication. + Indeed. That's why <smbconfoption><name>security</name><value>server</value></smbconfoption> is at best a nasty hack. Please use <smbconfoption><name>security</name><value>domain</value></smbconfoption>. +<smbconfoption><name>security</name><value>server</value></smbconfoption> mode is also known as pass-through authentication. </para> </sect2> diff --git a/docs/docbook/projdoc/Speed.xml b/docs/docbook/projdoc/Speed.xml index 659cd6e31b..f462bb8a8a 100644 --- a/docs/docbook/projdoc/Speed.xml +++ b/docs/docbook/projdoc/Speed.xml @@ -63,7 +63,7 @@ line with the <option>-O</option> option, or in the &smb.conf; file. </para> <para> -The <parameter>socket options</parameter> section of the &smb.conf; manual page describes how +The <smbconfoption><name>socket options</name></smbconfoption> section of the &smb.conf; manual page describes how to set these and gives recommendations. </para> @@ -76,7 +76,7 @@ much. The correct settings are very dependent on your local network. <para> The socket option TCP_NODELAY is the one that seems to make the biggest single difference for most networks. Many people report that -adding <parameter>socket options = TCP_NODELAY</parameter> doubles the read +adding <smbconfoption><name>socket options</name><value>TCP_NODELAY</value></smbconfoption> doubles the read performance of a Samba drive. The best explanation I have seen for this is that the Microsoft TCP/IP stack is slow in sending tcp ACKs. </para> @@ -87,7 +87,7 @@ that the Microsoft TCP/IP stack is slow in sending tcp ACKs. <title>Read size</title> <para> -The option <parameter>read size</parameter> affects the overlap of disk +The option <smbconfoption><name>read size</name></smbconfoption> affects the overlap of disk reads/writes with network reads/writes. If the amount of data being transferred in several of the SMB commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger than this value then the server begins writing @@ -115,9 +115,9 @@ pointless and will cause you to allocate memory unnecessarily. <title>Max xmit</title> <para> -At startup the client and server negotiate a <parameter>maximum transmit</parameter> size, + At startup the client and server negotiate a <parameter>maximum transmit</parameter> size, which limits the size of nearly all SMB commands. You can set the -maximum size that Samba will negotiate using the <parameter>max xmit = </parameter> option +maximum size that Samba will negotiate using the <smbconfoption><name>max xmit</name></smbconfoption> option in &smb.conf;. Note that this is the maximum size of SMB requests that Samba will accept, but not the maximum size that the *client* will accept. The client maximum receive size is sent to Samba by the client and Samba @@ -140,7 +140,7 @@ In most cases the default is the best option. <title>Log level</title> <para> -If you set the log level (also known as <parameter>debug level</parameter>) higher than 2 +If you set the log level (also known as <smbconfoption><name>debug level</name></smbconfoption>) higher than 2 then you may suffer a large drop in performance. This is because the server flushes the log file after each operation, which can be very expensive. @@ -151,20 +151,20 @@ expensive. <title>Read raw</title> <para> -The <parameter>read raw</parameter> operation is designed to be an optimised, low-latency +The <smbconfoption><name>read raw</name></smbconfoption> operation is designed to be an optimised, low-latency file read operation. A server may choose to not support it, -however. and Samba makes support for <parameter>read raw</parameter> optional, with it +however. and Samba makes support for <smbconfoption><name>read raw</name></smbconfoption> optional, with it being enabled by default. </para> <para> -In some cases clients don't handle <parameter>read raw</parameter> very well and actually +In some cases clients don't handle <smbconfoption><name>read raw</name></smbconfoption> very well and actually get lower performance using it than they get using the conventional read operations. </para> <para> -So you might like to try <parameter>read raw = no</parameter> and see what happens on your +So you might like to try <smbconfoption><name>read raw</name><value>no</value></smbconfoption> and see what happens on your network. It might lower, raise or not affect your performance. Only testing can really tell. </para> @@ -175,14 +175,14 @@ testing can really tell. <title>Write raw</title> <para> -The <parameter>write raw</parameter> operation is designed to be an optimised, low-latency +The <smbconfoption><name>write raw</name></smbconfoption> operation is designed to be an optimised, low-latency file write operation. A server may choose to not support it, -however. and Samba makes support for <parameter>write raw</parameter> optional, with it +however. and Samba makes support for <smbconfoption><name>write raw</name></smbconfoption> optional, with it being enabled by default. </para> <para> -Some machines may find <parameter>write raw</parameter> slower than normal write, in which +Some machines may find <smbconfoption><name>write raw</name></smbconfoption> slower than normal write, in which case you may wish to change this option. </para> @@ -193,7 +193,7 @@ case you may wish to change this option. <para> Slow logins are almost always due to the password checking time. Using -the lowest practical <parameter>password level</parameter> will improve things. +the lowest practical <smbconfoption><name>password level</name></smbconfoption> will improve things. </para> </sect1> diff --git a/docs/docbook/projdoc/StandAloneServer.xml b/docs/docbook/projdoc/StandAloneServer.xml index 206b2f88ce..ec4f9f2693 100644 --- a/docs/docbook/projdoc/StandAloneServer.xml +++ b/docs/docbook/projdoc/StandAloneServer.xml @@ -69,9 +69,9 @@ the Samba server is NOT a member of a domain security context. <para> Through the use of PAM (Pluggable Authentication Modules) and nsswitch -(the name service switcher) the source of authentication may reside on +(the name service switcher, which maintains the unix user database) the source of authentication may reside on another server. We would be inclined to call this the authentication server. -This means that the Samba server may use the local Unix/Linux system password database +This means that the Samba server may use the local UNIX/Linux system password database (<filename>/etc/passwd</filename> or <filename>/etc/shadow</filename>), may use a local smbpasswd file, or may use an LDAP back end, or even via PAM and Winbind another CIFS/SMB server @@ -89,7 +89,7 @@ attempt a high level of creativity and to introduce too much complexity in server and network design. </para> -<sect2> +<sect2 id="RefDocServer"> <title>Reference Documentation Server</title> <para> @@ -97,23 +97,23 @@ Configuration of a read-only data server that EVERYONE can access is very simple Here is the smb.conf file that will do this. Assume that all the reference documents are stored in the directory /export, that the documents are owned by a user other than nobody. No home directories are shared, that are no users in the <filename>/etc/passwd</filename> -Unix system database. This is a very simple system to administer. +UNIX system database. This is a very simple system to administer. </para> -<programlisting> - # Global parameters - [global] - workgroup = MYGROUP - netbios name = REFDOCS - security = SHARE - passdb backend = guest - wins server = 192.168.1.1 - - [data] - comment = Data - path = /export - guest only = Yes -</programlisting> +<smbconfexample> +<title>smb.conf for Reference Documentation Server</title> +<smbconfcomment> Global parameters</smbconfcomment> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +<smbconfoption><name>netbios name</name><value>&example.server.samba;</value></smbconfoption> +<smbconfoption><name>security</name><value>SHARE</value></smbconfoption> +<smbconfoption><name>passdb backend</name><value>guest</value></smbconfoption> +<smbconfoption><name>wins server</name><value>192.168.1.1</value></smbconfoption> +<smbconfsection>[data]</smbconfsection> +<smbconfoption><name>comment</name><value>Data</value></smbconfoption> +<smbconfoption><name>path</name><value>/export</value></smbconfoption> +<smbconfoption><name>guest only</name><value>Yes</value></smbconfoption> +</smbconfexample> <para> In the above example the machine name is set to REFDOCS, the workgroup is set to the name @@ -125,7 +125,7 @@ we do use it. </sect2> -<sect2> +<sect2 id="SimplePrintServer"> <title>Central Print Serving</title> <para> @@ -141,7 +141,7 @@ on your system. <listitem><para> The print spooling and processing system on our print server will be CUPS. - (Please refer to the <link linkend="CUPS-printing">CUPS Printing</link> chapter for more information). + (Please refer to <link linkend="CUPS-printing">the chapter about CUPS</link> for more information). </para></listitem> <listitem><para> @@ -166,13 +166,13 @@ the anonymous (guest) user, two things will be required: <itemizedlist> <title>Enabling Anonymous Printing</title> <listitem><para> - The Unix/Linux system must have a <command>guest</command> account. + The UNIX/Linux system must have a <command>guest</command> account. The default for this is usually the account <command>nobody</command>. To find the correct name to use for your version of Samba do the following: - <screen> -<prompt>$ </prompt><userinput>testparm -s -v | grep "guest account"</userinput> - </screen> +<screen> +&prompt;<userinput>testparm -s -v | grep "guest account"</userinput> +</screen> Then make sure that this account exists in your system password database (<filename>/etc/passwd</filename>). </para></listitem> @@ -181,34 +181,36 @@ the anonymous (guest) user, two things will be required: The directory into which Samba will spool the file must have write access for the guest account. The following commands will ensure that this directory is available for use: - <screen> +<screen> &rootprompt;<userinput>mkdir /var/spool/samba</userinput> &rootprompt;<userinput>chown nobody.nobody /var/spool/samba</userinput> &rootprompt;<userinput>chmod a+rwt /var/spool/samba</userinput> - </screen> +</screen> </para></listitem> </itemizedlist> <para> -<programlisting> - # Global parameters - [global] - workgroup = MYGROUP - netbios name = PTRSVR1 - security = SHARE - passdb backend = guest - wins server = 192.168.1.1 - - [printers] - comment = All Printers - path = /var/spool/samba - printer admin = root - guest ok = Yes - printable = Yes - printing = cups - use client driver = Yes - browseable = No -</programlisting> + <smbconfexample> + <title>smb.conf for anonymous printing</title> +<smbconfcomment> Global parameters</smbconfcomment> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +<smbconfoption><name>netbios name</name><value>&example.server.samba;</value></smbconfoption> +<smbconfoption><name>security</name><value>SHARE</value></smbconfoption> +<smbconfoption><name>passdb backend</name><value>guest</value></smbconfoption> +<smbconfoption><name>wins server</name><value>&example.server.wins;</value></smbconfoption> +<smbconfoption><name>printing</name><value>cups</value></smbconfoption> +<smbconfoption><name>printcap name</name><value>cups</value></smbconfoption> + +<smbconfsection>[printers]</smbconfsection> +<smbconfoption><name>comment</name><value>All Printers</value></smbconfoption> +<smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> +<smbconfoption><name>printer admin</name><value>root</value></smbconfoption> +<smbconfoption><name>guest ok</name><value>Yes</value></smbconfoption> +<smbconfoption><name>printable</name><value>Yes</value></smbconfoption> +<smbconfoption><name>use client driver</name><value>Yes</value></smbconfoption> +<smbconfoption><name>browseable</name><value>No</value></smbconfoption> +</smbconfexample> </para> </sect2> diff --git a/docs/docbook/projdoc/UNIX_INSTALL.xml b/docs/docbook/projdoc/UNIX_INSTALL.xml index e919ff8c57..6a38e60c0e 100644 --- a/docs/docbook/projdoc/UNIX_INSTALL.xml +++ b/docs/docbook/projdoc/UNIX_INSTALL.xml @@ -15,12 +15,12 @@ <para> Binary packages of samba are included in almost any Linux or - Unix distribution. There are also some packages available at + UNIX distribution. There are also some packages available at <ulink url="http://samba.org/">the samba homepage</ulink>. </para> - <para>If you need to compile samba from source, check the - <link linkend="compiling">appropriate appendix chapter</link>.</para> + <para>If you need to compile samba from source, check + <link linkend="compiling">the chapter about compiling samba from scratch</link>.</para> <para>If you have already installed samba, or if your operating system was pre-installed with samba, then you may not need to bother with this @@ -55,39 +55,39 @@ </para> <para> - <programlisting> - [global] - workgroup = MYGROUP - - [homes] - guest ok = no - read only = no - </programlisting> + <smbconfexample> + <title>Simplest possible smb.conf file</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> + +<smbconfsection>[homes]</smbconfsection> +<smbconfoption><name>guest ok</name><value>no</value></smbconfoption> +<smbconfoption><name>read only</name><value>no</value></smbconfoption> + </smbconfexample> </para> <para> This will allow connections by anyone with an account on the server, using either - their login name or "<parameter>homes</parameter>" as the service name. + their login name or <smbconfsection>homes</smbconfsection>" as the service name. (Note that the workgroup that Samba must also be set.) </para> <para> - Make sure you put the <filename>smb.conf</filename> file in the same place - you specified in the <filename>Makefile</filename> (the default is to - look for it in <filename>/usr/local/samba/lib/</filename>). + Make sure you put the &smb.conf; file in the correct place + (usually in <filename>/etc/samba</filename>). </para> <para> For more information about security settings for the - <parameter>[homes]</parameter> share please refer to the chapter - <link linkend="securing-samba">Securing Samba</link>. + <smbconfsection>[homes]</smbconfsection> share please refer to + <link linkend="securing-samba">"Securing Samba"</link>. </para> <sect3> <title>Test your config file with <command>testparm</command></title> <para> - It's important that you test the validity of your <filename>smb.conf</filename> + It's important that you test the validity of your &smb.conf; file using the &testparm; program. If testparm runs OK then it will list the loaded services. If not it will give an error message. </para> @@ -115,7 +115,7 @@ <para> To launch SWAT just run your favorite web browser and - point it at <ulink url="http://localhost:901/">http://localhost:901/</ulink>. Replace + point it at <ulink url="http://localhost:901/" noescape="1">http://localhost:901/</ulink>. Replace <replaceable>localhost</replaceable> with the name of the computer you are running samba on if you are running samba on a different computer than your browser. @@ -134,8 +134,9 @@ <title>Try listing the shares available on your server</title> - <para><prompt>$ </prompt><userinput>smbclient -L - <replaceable>yourhostname</replaceable></userinput></para> +<para><screen> +&prompt;<userinput>smbclient -L <replaceable>yourhostname</replaceable></userinput> +</screen></para> <para>You should get back a list of shares available on your server. If you don't then something is incorrectly setup. @@ -153,51 +154,55 @@ <sect1> <title>Try connecting with the unix client</title> - <para><prompt>$ </prompt><userinput>smbclient <replaceable> - //yourhostname/aservice</replaceable></userinput></para> + <para> +<screen> +&prompt;<userinput>smbclient <replaceable> //yourhostname/aservice</replaceable></userinput> +</screen></para> <para>Typically the <replaceable>yourhostname</replaceable> would be the name of the host where you installed &smbd;. The <replaceable>aservice</replaceable> is any service you have defined in the &smb.conf; - file. Try your user name if you just have a <parameter>[homes]</parameter> + file. Try your user name if you just have a <smbconfsection>[homes]</smbconfsection> section in &smb.conf;.</para> <para>For example if your unix host is <replaceable>bambi</replaceable> and your login name is <replaceable>fred</replaceable> you would type:</para> - <para><prompt>$ </prompt><userinput>smbclient //<replaceable>bambi</replaceable>/<replaceable>fred</replaceable> - </userinput></para> +<para><screen> +&prompt;<userinput>smbclient //<replaceable>bambi</replaceable>/<replaceable>fred</replaceable></userinput> +</screen></para> </sect1> <sect1> - <title>Try connecting from a DOS, WfWg, Win9x, WinNT, - Win2k, OS/2, etc... client</title> - - <para>Try mounting disks. eg:</para> + <title>Try connecting from another SMB client</title> - <para><prompt>C:\WINDOWS\> </prompt><userinput>net use d: \\servername\service - </userinput></para> + <para>Try mounting disks. from a DOS, Windows or OS/2 client, eg:</para> + + <para><screen> +&dosprompt;<userinput>net use d: \\servername\service</userinput> +</screen></para> <para>Try printing. eg:</para> - <para><prompt>C:\WINDOWS\> </prompt><userinput>net use lpt1: - \\servername\spoolservice</userinput></para> + <para> +<screen> +&dosprompt;<userinput>net use lpt1: \\servername\spoolservice</userinput> +</screen></para> - <para><prompt>C:\WINDOWS\> </prompt><userinput>print filename - </userinput></para> +<para> +<screen>&dosprompt;<userinput>print filename</userinput> +</screen></para> </sect1> <sect1> <title>What If Things Don't Work?</title> - <para>Then you might read the file chapter - <link linkend="diagnosis">Diagnosis</link> and the - FAQ. If you are still stuck then try to follow - the <link linkend="problems">Analysing and Solving Problems chapter</link> + <para>Then you might read the file chapter <link linkend="diagnosis">diagnosis</link> + and the FAQ. If you are still stuck then refer to <link linkend="problems">"Analysing and solving problems"</link>. Samba has been successfully installed at thousands of sites worldwide, - so maybe someone else has hit your problem and has overcome it. </para> + so maybe someone else has hit your problem and has overcome it.</para> </sect1> @@ -209,55 +214,7 @@ The following questions and issues get raised on the samba mailing list over and </para> <sect2> -<title>Why are so many smbd processes eating memory?</title> - -<para> -<quote> -Site that is running Samba on an AIX box. They are sharing out about 2 terabytes using samba. -Samba was installed using smitty and the binaries. We seem to be experiencing a memory problem -with this box. When I do a <command>svmon -Pu</command> the monitoring program shows that &smbd; has several -processes of smbd running: -</quote> -</para> - -<para> - <quote> -Is samba suppose to start this many different smbd processes? Or does it run as one smbd process? Also -is it normal for it to be taking up this much memory? -</quote> -</para> - -<para> -<screen> -Inuse * 4096 = amount of memory being used by this process - - Pid Command Inuse Pin Pgsp Virtual 64-bit Mthrd - 20950 smbd 33098 1906 181 5017 N N - 22262 smbd 9104 1906 5410 - 21060 smbd 9048 1906 181 5479 N N - 25972 smbd 8678 1906 181 5109 N N - 24524 smbd 8674 1906 181 5105 N N - 19262 smbd 8582 1906 181 5013 N N - 20722 smbd 8572 1906 181 5003 N N - 21454 smbd 8572 1906 181 5003 N N - 28946 smbd 8567 1906 181 4996 N N - 24076 smbd 8566 1906 181 4996 N N - 20138 smbd 8566 1906 181 4996 N N - 17608 smbd 8565 1906 181 4996 N N - 21820 smbd 8565 1906 181 4996 N N - 26940 smbd 8565 1906 181 4996 N N - 19884 smbd 8565 1906 181 4996 N N - 9912 smbd 8565 1906 181 4996 N N - 25800 smbd 8564 1906 181 4995 N N - 20452 smbd 8564 1906 181 4995 N N - 18592 smbd 8562 1906 181 4993 N N - 28216 smbd 8521 1906 181 4954 N N - 19110 smbd 8404 1906 181 4862 N N - - Total memory used: 841,592,832 bytes -</screen> -</para> - + <title>Large number of smbd processes</title> <para> Samba consists on three core programs: @@ -285,10 +242,27 @@ run in "split mode" (in which case there will be two instances). </sect2> <sect2> - <title>I'm getting "open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested" in the logs</title> - <para>Your loopback device isn't working correctly. Make sure it's running. </para> + <title>"open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested"</title> + <para>Your loopback device isn't working correctly. Make sure it's configured properly. The loopback device is an internal (virtual) network device with + the ip address 127.0.0.1. Read your OS documentation for details + on how to configure the loopback on your system.</para> </sect2> + <sect2> + <title>"<errorname>The network name cannot be found</errorname>"</title> + + <para> + This error can be caused by one of these misconfigurations: + </para> + + <itemizedlist> + <listitem><para>You specified an nonexisting <smbconfoption><name>path</name></smbconfoption> for the share in &smb.conf; </para></listitem> + <listitem><para>The user you are trying to access the share with does not + have sufficient permissions to access the <smbconfoption><name>path</name></smbconfoption> for the share. Both read (r) and access (x) should be possible.</para></listitem> + <listitem><para>The share you are trying to access does not exist.</para></listitem> + </itemizedlist> + + </sect2> </sect1> </chapter> diff --git a/docs/docbook/projdoc/VFS.xml b/docs/docbook/projdoc/VFS.xml index 67f1b39a99..c949055371 100644 --- a/docs/docbook/projdoc/VFS.xml +++ b/docs/docbook/projdoc/VFS.xml @@ -33,18 +33,19 @@ on different systems. They currently have been tested against GNU/Linux and IRI <para> To use the VFS modules, create a share similar to the one below. The -important parameter is the <command>vfs objects</command> parameter where +important parameter is the <smbconfoption><name>vfs objects</name></smbconfoption> parameter where you can list one or more VFS modules by name. For example, to log all access to files and put deleted files in a recycle bin: -<programlisting> -[audit] - comment = Audited /data directory - path = /data - vfs objects = audit recycle - writeable = yes - browseable = yes -</programlisting> +<smbconfexample> + <title>smb.conf with VFS modules</title> + <smbconfsection>[audit]</smbconfsection> +<smbconfoption><name>comment</name><value>Audited /data directory</value></smbconfoption> +<smbconfoption><name>path</name><value>/data</value></smbconfoption> +<smbconfoption><name>vfs objects</name><value>audit recycle</value></smbconfoption> +<smbconfoption><name>writeable</name><value>yes</value></smbconfoption> +<smbconfoption><name>browseable</name><value>yes</value></smbconfoption> + </smbconfexample> </para> <para> @@ -62,17 +63,18 @@ directory in the root directory of the samba installation (usually Some modules can be used twice for the same share. This can be done using a configuration similar to the one below. -<programlisting> -[test] - comment = VFS TEST - path = /data - writeable = yes - browseable = yes - vfs objects = example:example1 example example:test - example1: parameter = 1 - example: parameter = 5 - test: parameter = 7 -</programlisting> +<smbconfexample> + <title>smb.conf with multiple VFS modules</title> +<smbconfsection>[test]</smbconfsection> +<smbconfoption><name>comment</name><value>VFS TEST</value></smbconfoption> +<smbconfoption><name>path</name><value>/data</value></smbconfoption> +<smbconfoption><name>writeable</name><value>yes</value></smbconfoption> +<smbconfoption><name>browseable</name><value>yes</value></smbconfoption> +<smbconfoption><name>vfs objects</name><value>example:example1 example example:test</value></smbconfoption> +<smbconfoption><name>example1: parameter</name><value>1</value></smbconfoption> +<smbconfoption><name>example: parameter</name><value>5</value></smbconfoption> +<smbconfoption><name>test: parameter</name><value>7</value></smbconfoption> +</smbconfexample> </para> </sect1> @@ -86,12 +88,12 @@ This can be done using a configuration similar to the one below. <para> A simple module to audit file access to the syslog facility. The following operations are logged: - <simplelist> - <member>share</member> - <member>connect/disconnect</member> - <member>directory opens/create/remove</member> - <member>file open/close/rename/unlink/chmod</member> - </simplelist> + <itemizedlist> + <listitem><para>share</para></listitem> + <listitem><para>connect/disconnect</para></listitem> + <listitem><para>directory opens/create/remove</para></listitem> + <listitem><para>file open/close/rename/unlink/chmod</para></listitem> + </itemizedlist> </para> </sect2> @@ -107,7 +109,7 @@ This can be done using a configuration similar to the one below. <para> The logging information that will be written to the smbd log file is controlled by - the <parameter>log level</parameter> parameter in <filename>smb.conf</filename>. The + the <smbconfoption><name>log level</name></smbconfoption> parameter in &smb.conf;. The following information will be recorded: </para> @@ -144,49 +146,65 @@ This can be done using a configuration similar to the one below. <para> A recycle-bin like module. When used any unlink call will be intercepted and files moved to the recycle - directory instead of being deleted. + directory instead of being deleted. This gives the same + effect as the "Recycle Bin" on Windows computers. </para> <para>Supported options: <variablelist> <varlistentry> <term>recycle:repository</term> - <listitem><para>FIXME</para></listitem> + <listitem><para>Relative path of the directory where deleted files should be moved to</para></listitem> </varlistentry> <varlistentry> <term>recycle:keeptree</term> - <listitem><para>FIXME</para></listitem> + <listitem><para>Specifies whether the directory structure should + be kept or if the files in the directory that is being + deleted should be kept seperately in the recycle bin. + </para></listitem> </varlistentry> <varlistentry> <term>recycle:versions</term> - <listitem><para>FIXME</para></listitem> + <listitem><para>If this option is set, two files + with the same name that are deleted will both + be kept in the recycle bin. Newer deleted versions + of a file will be called "Copy #x of <replaceable>filename</replaceable>".</para></listitem> </varlistentry> <varlistentry> <term>recycle:touch</term> - <listitem><para>FIXME</para></listitem> + <listitem><para>Specifies whether a file's access + date should be touched when the file is moved to + the recycle bin.</para></listitem> </varlistentry> <varlistentry> <term>recycle:maxsize</term> - <listitem><para>FIXME</para></listitem> + <listitem><para>Files that are larger than the number + of bytes specified by this parameter will + not be put into the recycle bin.</para></listitem> </varlistentry> <varlistentry> <term>recycle:exclude</term> - <listitem><para>FIXME</para></listitem> + <listitem><para>List of files that should not + be put into the recycle bin when deleted, but deleted + in the regular way.</para></listitem> </varlistentry> <varlistentry> <term>recycle:exclude_dir</term> - <listitem><para>FIXME</para></listitem> + <listitem><para>Contains a list of directories. When files from + these directories are deleted, they are not put into the + recycle bin, but deleted in the regular way. + </para></listitem> </varlistentry> <varlistentry> <term>recycle:noversions</term> - <listitem><para>FIXME</para></listitem> + <listitem><para>Opposite of <parameter>recycle:versions</parameter>. If both options are specified, this one takes precedence.</para></listitem> </varlistentry> </variablelist> </para> @@ -202,10 +220,10 @@ This can be done using a configuration similar to the one below. </para> <para>Advantages compared to the old netatalk module: - <simplelist> - <member>it doesn't care about creating of .AppleDouble forks, just keeps them in sync</member> - <member>if a share in &smb.conf; doesn't contain .AppleDouble item in hide or veto list, it will be added automatically</member> - </simplelist> + <itemizedlist> + <listitem><para>it doesn't care about creating of .AppleDouble forks, just keeps them in sync</para></listitem> + <listitem><para>if a share in &smb.conf; doesn't contain .AppleDouble item in hide or veto list, it will be added automatically</para></listitem> + </itemizedlist> </para> </sect2> @@ -231,7 +249,7 @@ should be implied due to its presence here. <title>DatabaseFS</title> <para> - URL: <ulink url="http://www.css.tayloru.edu/~elorimer/databasefs/index.php">http://www.css.tayloru.edu/~elorimer/databasefs/index.php</ulink> + URL: <ulink noescape="1" url="http://www.css.tayloru.edu/~elorimer/databasefs/index.php">http://www.css.tayloru.edu/~elorimer/databasefs/index.php</ulink> </para> <para>By <ulink url="mailto:elorimer@css.tayloru.edu">Eric Lorimer</ulink>.</para> @@ -258,7 +276,7 @@ should be implied due to its presence here. <sect2> <title>vscan</title> - <para>URL: <ulink url="http://www.openantivirus.org/">http://www.openantivirus.org/</ulink></para> + <para>URL: <ulink noescape="1" url="http://www.openantivirus.org/">http://www.openantivirus.org/</ulink></para> <para> samba-vscan is a proof-of-concept module for Samba, which @@ -271,12 +289,4 @@ should be implied due to its presence here. </sect2> </sect1> -<sect1> -<title>Common Errors</title> - -<para> -There must be some gotchas we should record here! Jelmer??? -</para> - -</sect1> </chapter> diff --git a/docs/docbook/projdoc/locking.xml b/docs/docbook/projdoc/locking.xml index 0e508f682a..17dc518226 100644 --- a/docs/docbook/projdoc/locking.xml +++ b/docs/docbook/projdoc/locking.xml @@ -62,7 +62,7 @@ that are specified when a file is open. </para> <para> -Record locking semantics under Unix are very different from record locking under +Record locking semantics under UNIX are very different from record locking under Windows. Versions of Samba before 2.2 have tried to use the native fcntl() unix system call to implement proper record locking between different Samba clients. This can not be fully correct due to several reasons. The simplest is the fact @@ -75,29 +75,29 @@ many more differences, too many to be listed here. <para> Samba 2.2 and above implements record locking completely independent of the underlying unix system. If a byte range lock that the client requests happens -to fall into the range 0-2^31, Samba hands this request down to the Unix system. +to fall into the range 0-2^31, Samba hands this request down to the UNIX system. All other locks can not be seen by unix anyway. </para> <para> -Strictly a SMB server should check for locks before every read and write call on -a file. Unfortunately with the way fcntl() works this can be slow and may overstress +Strictly an SMB server should check for locks before every read and write call on +a file. Unfortunately with the way fcntl() works this can be slow and may over-stress the <command>rpc.lockd</command>. It is also almost always unnecessary as clients are supposed to independently make locking calls before reads and writes anyway if locking is important to them. By default Samba only makes locking calls when explicitly asked -to by a client, but if you set <parameter>strict locking = yes</parameter> then it +to by a client, but if you set <smbconfoption><name>strict locking</name><value>yes</value></smbconfoption> then it will make lock checking calls on every read and write. </para> <para> -You can also disable byte range locking completely using <parameter>locking = no</parameter>. +You can also disable byte range locking completely using <smbconfoption><name>locking</name><value>no</value></smbconfoption>. This is useful for those shares that don't support locking or don't need it (such as cdroms). In this case Samba fakes the return codes of locking calls to tell clients that everything is OK. </para> <para> -The second class of locking is the <parameter>deny modes</parameter>. These +The second class of locking is the <emphasis>deny modes</emphasis>. These 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 <constant>DENY_NONE</constant>, <constant>DENY_READ</constant>, @@ -328,19 +328,19 @@ in a performance bottleneck. </sect3> <sect3> -<title>Unix or NFS Client Accessed Files</title> +<title>UNIX or NFS Client Accessed Files</title> <para> -Local Unix and NFS clients access files without a mandatory +Local UNIX and NFS clients access files without a mandatory file locking mechanism. Thus, these client platforms are incapable of initiating an oplock break request from the server to a Windows client -that has a file cached. Local Unix or NFS file access can therefore +that has a file cached. Local UNIX or NFS file access can therefore write to a file that has been cached by a Windows client, which exposes the file to likely data corruption. </para> <para> -If files are shared between Windows clients, and either local Unix +If files are shared between Windows clients, and either local UNIX or NFS users, then turn opportunistic locking off. </para> @@ -409,7 +409,7 @@ the share. <title>Beware of Force User</title> <para> -Samba includes an &smb.conf; parameter called <parameter>force user</parameter> that changes +Samba includes an &smb.conf; parameter called <smbconfoption><name>force user</name></smbconfoption> that changes the user accessing a share from the incoming user to whatever user is defined by the smb.conf variable. If opportunistic locking is enabled on a share, the change in user access causes an oplock break to be sent @@ -426,7 +426,7 @@ Avoid the combination of the following: <itemizedlist> <listitem><para> - <parameter>force user</parameter> in the &smb.conf; share configuration. + <smbconfoption><name>force user</name></smbconfoption> in the &smb.conf; share configuration. </para></listitem> <listitem><para> @@ -449,8 +449,8 @@ administrator to adjust various properties of the oplock mechanism to account for timing and usage levels. These parameters provide good versatility for implementing oplocks in environments where they would likely cause problems. The parameters are: -<parameter>oplock break wait time</parameter>, -<parameter>oplock contention limit</parameter>. +<smbconfoption><name>oplock break wait time</name></smbconfoption>, +<smbconfoption><name>oplock contention limit</name></smbconfoption>. </para> <para> @@ -514,7 +514,7 @@ enabled and disabled. <para> Opportunistic Locking is a unique Windows file locking feature. It is not really file locking, but is included in most discussions of Windows -file locking, so is considered a defacto locking feature. +file locking, so is considered a de facto locking feature. Opportunistic Locking is actually part of the Windows client file caching mechanism. It is not a particularly robust or reliable feature when implemented on the variety of customized networks that exist in @@ -557,7 +557,7 @@ oplock aware at this time. <para> Unless your system supports kernel oplocks, you should disable oplocks if you are -accessing the same files from both Unix/Linux and SMB clients. Regardless, oplocks should +accessing the same files from both UNIX/Linux and SMB clients. Regardless, oplocks should always be disabled if you are sharing a database file (e.g., Microsoft Access) between multiple clients, as any break the first client receives will affect synchronisation of the entire file (not just the single record), which will result in a noticeable performance @@ -594,11 +594,11 @@ You can disable oplocks on a per-share basis with the following: </para> <para> -<programlisting> -[acctdata] - oplocks = False - level2 oplocks = False -</programlisting> +<smbconfblock> +<smbconfsection>[acctdata]</smbconfsection> +<smbconfoption><name>oplocks</name><value>False</value></smbconfoption> +<smbconfoption><name>level2 oplocks</name><value>False</value></smbconfoption> +</smbconfblock> </para> <para> @@ -611,9 +611,9 @@ Alternately, you could disable oplocks on a per-file basis within the share: </para> <para> -<programlisting> - veto oplock files = /*.mdb/*.MDB/*.dbf/*.DBF/ -</programlisting> + <smbconfblock> +<smbconfoption><name>veto oplock files</name><value>/*.mdb/*.MDB/*.dbf/*.DBF/</value></smbconfoption> +</smbconfblock> </para> <para> @@ -641,10 +641,9 @@ basis in the &smb.conf; file. </para> <para> -<programlisting> -[global] -kernel oplocks = yes -</programlisting> + <smbconfblock> +<smbconfoption><name>kernel oplocks</name><value>yes</value></smbconfoption> +</smbconfblock> The default is "no". </para> @@ -663,17 +662,18 @@ enabled on a per-share basis, or globally for the entire server, in the </para> <para> -<programlisting><title>Example Veto OpLock Settings</title> -[global] - veto oplock files = /filename.htm/*.txt/ +<smbconfexample> + <title>Share with some files oplocked</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>veto oplock files</name><value>/filename.htm/*.txt/</value></smbconfoption> -[share_name] - veto oplock files = /*.exe/filename.ext/ -</programlisting> +<smbconfsection>[share_name]</smbconfsection> +<smbconfoption><name>veto oplock files</name><value>/*.exe/filename.ext/</value></smbconfoption> +</smbconfexample> </para> <para> -<emphasis>Oplock break wait time</emphasis> is an &smb.conf; parameter that adjusts the time + <smbconfoption><name>oplock break wait time</name></smbconfoption> is an &smb.conf; parameter that adjusts the time interval for Samba to reply to an oplock break request. Samba recommends "DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE." Oplock Break Wait Time can only be @@ -681,10 +681,9 @@ configured globally in the &smb.conf; file: </para> <para> -<programlisting> -[global] - oplock break wait time = 0 (default) -</programlisting> + <smbconfblock> +<smbconfoption><name>oplock break wait time</name><value> 0 (default)</value></smbconfoption> +</smbconfblock> </para> <para> @@ -698,13 +697,13 @@ the entire server, in the &smb.conf; file: </para> <para> -<programlisting> -[global] - oplock break contention limit = 2 (default) + <smbconfexample> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>oplock break contention limit</name><value> 2 (default)</value></smbconfoption> -[share_name] - oplock break contention limit = 2 (default) -</programlisting> +<smbconfsection>[share_name]</smbconfsection> +<smbconfoption><name>oplock break contention limit</name><value> 2 (default)</value></smbconfoption> +</smbconfexample> </para> </sect3> @@ -919,7 +918,7 @@ potentially cause loss of cached data. <title>Persistent Data Corruption</title> <para> -If you have applied all of the settings discussed in this paper but data corruption problems +If you have applied all of the settings discussed in this chapter but data corruption problems and other symptoms persist, here are some additional things to check out: </para> @@ -984,14 +983,16 @@ so far: <title>locking.tdb error messages</title> <para> - <screen> - > We are seeing lots of errors in the samba logs like: - > - > tdb(/usr/local/samba_2.2.7/var/locks/locking.tdb): rec_read bad magic - > 0x4d6f4b61 at offset=36116 - > - > What do these mean? - </screen> + <quote> + We are seeing lots of errors in the samba logs like: +</quote> +<programlisting> +tdb(/usr/local/samba_2.2.7/var/locks/locking.tdb): rec_read bad magic + 0x4d6f4b61 at offset=36116 +</programlisting> +<quote> + What do these mean? + </quote> </para> <para> @@ -1000,6 +1001,25 @@ so far: </sect2> + <sect2> + <title>Problems saving files in MS Office on Windows XP</title> + + <para>This is a bug in Windows XP. More information can be + found in <ulink url="http://support.microsoft.com/?id=812937">Microsoft Knowledge Base article 812937</ulink>.</para> + + </sect2> + + <sect2> + + <title>Long delays deleting files over network with XP SP1</title> + + <para><quote>It sometimes takes approximately 35 seconds to delete files over the network after XP SP1 has been applied</quote></para> + + <para>This is a bug in Windows XP. More information can be + found in <ulink url="http://support.microsoft.com/?id=811492"> + Microsoft Knowledge Base article 811492</ulink>.</para> + </sect2> + </sect1> <sect1> @@ -1019,22 +1039,22 @@ Section of the Microsoft MSDN Library on opportunistic locking: Opportunistic Locks, Microsoft Developer Network (MSDN), Windows Development > Windows Base Services > Files and I/O > SDK Documentation > File Storage > File Systems > About File Systems > Opportunistic Locks, Microsoft Corporation. -<ulink url="http://msdn.microsoft.com/library/en-us/fileio/storage_5yk3.asp">http://msdn.microsoft.com/library/en-us/fileio/storage_5yk3.asp</ulink> +<ulink noescape="1" url="http://msdn.microsoft.com/library/en-us/fileio/storage_5yk3.asp">http://msdn.microsoft.com/library/en-us/fileio/storage_5yk3.asp</ulink> </para> <para> Microsoft Knowledge Base Article Q224992 "Maintaining Transactional Integrity with OPLOCKS", -Microsoft Corporation, April 1999, <ulink url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992</ulink>. +Microsoft Corporation, April 1999, <ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992</ulink>. </para> <para> Microsoft Knowledge Base Article Q296264 "Configuring Opportunistic Locking in Windows 2000", -Microsoft Corporation, April 2001, <ulink url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264</ulink>. +Microsoft Corporation, April 2001, <ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264</ulink>. </para> <para> Microsoft Knowledge Base Article Q129202 "PC Ext: Explanation of Opportunistic Locking on Windows NT", - Microsoft Corporation, April 1995, <ulink url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202</ulink>. + Microsoft Corporation, April 1995, <ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202</ulink>. </para> </sect1> diff --git a/docs/docbook/projdoc/msdfs_setup.xml b/docs/docbook/projdoc/msdfs_setup.xml index c21c9ec6bf..90259f6a51 100644 --- a/docs/docbook/projdoc/msdfs_setup.xml +++ b/docs/docbook/projdoc/msdfs_setup.xml @@ -27,23 +27,21 @@ </para> <para> - For information about DFS, refer to - <ulink url="http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp"> - Microsoft documentation at http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp</ulink>. + For information about DFS, refer to the +<ulink url="http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp">Microsoft documentation</ulink>. </para> <para> - This document explains how to host a DFS tree on a Unix machine (for DFS-aware + This document explains how to host a DFS tree on a UNIX machine (for DFS-aware clients to browse) using Samba. </para> <para> - To enable SMB-based DFS for Samba, configure it with the <parameter>--with-msdfs</parameter> + To enable SMB-based DFS for Samba, configure it with the <option>--with-msdfs</option> option. Once built, a Samba server can be made a DFS server by setting the global - boolean <ulink url="smb.conf.5.html#HOSTMSDFS"><parameter> host msdfs</parameter></ulink> - parameter in the <filename>smb.conf </filename> file. You designate a share as a DFS - root using the share level boolean <ulink url="smb.conf.5.html#MSDFSROOT"><parameter> - msdfs root</parameter></ulink> parameter. A DFS root directory on Samba hosts DFS + boolean <smbconfoption><name>host msdfs</name></smbconfoption> + parameter in the &smb.conf; file. You designate a share as a DFS + root using the share level boolean <smbconfoption><name>msdfs root</name></smbconfoption> parameter. A DFS root directory on Samba hosts DFS links in the form of symbolic links that point to other servers. For example, a symbolic link <filename>junction->msdfs:storage1\share1</filename> in the share directory acts as the DFS junction. When DFS-aware clients attempt to access the junction link, @@ -58,28 +56,28 @@ Here's an example of setting up a DFS tree on a Samba server. </para> - <para><programlisting> -# The smb.conf file: -[global] - netbios name = SMOKEY - host msdfs = yes + <para><smbconfexample> + <title>smb.conf with DFS configured</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>netbios name</name><value>&example.server.samba;</value></smbconfoption> +<smbconfoption><name>host msdfs </name><value>yes</value></smbconfoption> -[dfs] - path = /export/dfsroot - msdfs root = yes - </programlisting></para> +<smbconfsection>[dfs]</smbconfsection> +<smbconfoption><name>path</name><value>/export/dfsroot</value></smbconfoption> +<smbconfoption><name>msdfs root</name><value>yes</value></smbconfoption> + </smbconfexample></para> - <para>In the /export/dfsroot directory we set up our dfs links to + <para>In the /export/dfsroot directory we set up our DFS links to other servers on the network.</para> - <screen> - &rootprompt;<userinput>cd /export/dfsroot</userinput> - &rootprompt;<userinput>chown root /export/dfsroot</userinput> - &rootprompt;<userinput>chmod 755 /export/dfsroot</userinput> - &rootprompt;<userinput>ln -s msdfs:storageA\\shareA linka</userinput> - &rootprompt;<userinput>ln -s msdfs:serverB\\share,serverC\\share linkb</userinput> - </screen> +<screen> +&rootprompt;<userinput>cd /export/dfsroot</userinput> +&rootprompt;<userinput>chown root /export/dfsroot</userinput> +&rootprompt;<userinput>chmod 755 /export/dfsroot</userinput> +&rootprompt;<userinput>ln -s msdfs:storageA\\shareA linka</userinput> +&rootprompt;<userinput>ln -s msdfs:serverB\\share,serverC\\share linkb</userinput> +</screen> <para>You should set up the permissions and ownership of the directory acting as the DFS root such that only designated @@ -99,9 +97,9 @@ <title>Common Errors</title> <itemizedlist> <listitem><para>Windows clients need to be rebooted - if a previously mounted non-dfs share is made a dfs + if a previously mounted non-dfs share is made a DFS root or vice versa. A better way is to introduce a - new share and make it the dfs root.</para> + new share and make it the DFS root.</para> </listitem> <listitem><para>Currently there's a restriction that msdfs diff --git a/docs/docbook/projdoc/passdb.xml b/docs/docbook/projdoc/passdb.xml index 3a33e9f1e7..0ee3fa709e 100644 --- a/docs/docbook/projdoc/passdb.xml +++ b/docs/docbook/projdoc/passdb.xml @@ -17,8 +17,8 @@ <title>Account Information Databases</title> <para> -Samba-3 implements a new capability to work concurrently with multiple account backends. -The possible new combinations of password backends allows Samba-3 a degree of flexibility +Samba 3 implements a new capability to work concurrently with multiple account backends. +The possible new combinations of password backends allows Samba 3 a degree of flexibility and scalability that previously could be achieved only with MS Windows Active Directory. This chapter describes the new functionality and how to get the most out of it. </para> @@ -26,10 +26,10 @@ This chapter describes the new functionality and how to get the most out of it. <para> In the course of development of Samba-3, a number of requests were received to provide the ability to migrate MS Windows NT4 SAM accounts to Samba-3 without the need to provide -matching Unix/Linux accounts. We called this the <emphasis>Non Unix Accounts (NUA)</emphasis> +matching UNIX/Linux accounts. We called this the <emphasis>Non UNIX Accounts (NUA)</emphasis> capability. The intent was that an administrator could decide to use the <emphasis>tdbsam</emphasis> -backend and by simply specifying <emphasis>"passdb backend = tdbsam_nua, guest"</emphasis> -this would allow Samba-3 to implement a solution that did not use Unix accounts per se. Late +backend and by simply specifying <smbconfoption><name>passdb backend</name><value>tdbsam_nua</value></smbconfoption> +this would allow Samba-3 to implement a solution that did not use UNIX accounts per se. Late in the development cycle, the team doing this work hit upon some obstacles that prevents this solution from being used. Given the delays with Samba-3 release a decision was made to NOT deliver this functionality until a better method of recognising NT Group SIDs from NT User @@ -37,7 +37,8 @@ SIDs could be found. This feature may thus return during the life cycle for the </para> <note><para> -Samba-3.0.0 does NOT support Non-Unix Account (NUA) operation. +Samba-3 does NOT support Non-UNIX Account (NUA) operation for user accounts. +Samba-3 does support NUA operation for machine accounts. </para></note> <sect1> @@ -48,12 +49,14 @@ Samba-3 provides for complete backwards compatibility with Samba-2.2.x functiona as follows: </para> +<sect2> + <title>Backwards Compatibility Backends</title> + <variablelist> -<title>Backwards Compatibility Backends</title> <varlistentry><term>Plain Text:</term> <listitem> <para> - This option uses nothing but the Unix/Linux <filename>/etc/passwd</filename> + This option uses nothing but the UNIX/Linux <filename>/etc/passwd</filename> style back end. On systems that have PAM (Pluggable Authentication Modules) support all PAM modules are supported. The behaviour is just as it was with Samba-2.2.x, and the protocol limitations imposed by MS Windows clients @@ -94,22 +97,18 @@ as follows: </varlistentry> </variablelist> +</sect2> + +<sect2> + <title>New Backends</title> + <para> Samba-3 introduces the following new password backend capabilities: </para> -<variablelist> -<title>New Backends</title> - <varlistentry><term>guest:</term> - <listitem> - <para> - This is <emphasis>always</emphasis> required as the last backend specified. - It provides the ability to handle guest account requirements for access to - resources like <parameter>IPC$</parameter> which is used for browsing. - </para> - </listitem> - </varlistentry> + +<variablelist> <varlistentry><term>tdbsam:</term> <listitem> <para> @@ -186,17 +185,10 @@ Samba-3 introduces the following new password backend capabilities: </listitem> </varlistentry> - <varlistentry><term>nisplussam:</term> - <listitem> - <para> - The NIS+ based passdb backend. Takes name NIS domain as an - optional argument. Only works with Sun NIS+ servers. - </para> - </listitem> - </varlistentry> - </variablelist> +</sect2> + </sect1> <sect1> @@ -223,11 +215,19 @@ Samba-3 introduces the following new password backend capabilities: In addition to differently encrypted passwords, windows also stores certain data for each user that is not stored in a unix user database. e.g: workstations the user may logon from, the location where the users' profile is stored, and so on. Samba retrieves and stores this - information using a <parameter>passdb backend</parameter>. Commonly available backends are LDAP, plain text + information using a <smbconfoption><name>passdb backend</name></smbconfoption>. Commonly available backends are LDAP, plain text file, MySQL and nisplus. For more information, see the man page for &smb.conf; regarding the - <parameter>passdb backend</parameter> parameter. + <smbconfoption><name>passdb backend</name></smbconfoption> parameter. </para> + + <figure id="idmap-diag"><title>IDMAP</title> + <mediaobject> + <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap" scale="50" scalefit="1"/></imageobject> + <imageobject><imagedata fileref="projdoc/imagefiles/idmap.png" scale="50" scalefit="1"/></imageobject> + </mediaobject> + </figure> + <sect2> <title>Important Notes About Security</title> @@ -263,12 +263,12 @@ Samba-3 introduces the following new password backend capabilities: although they may log onto a domain environment: </para> - <simplelist> - <member>MS DOS Network client 3.0 with the basic network redirector installed</member> - <member>Windows 95 with the network redirector update installed</member> - <member>Windows 98 [se]</member> - <member>Windows Me</member> - </simplelist> + <itemizedlist> + <listitem><para>MS DOS Network client 3.0 with the basic network redirector installed</para></listitem> + <listitem><para>Windows 95 with the network redirector update installed</para></listitem> + <listitem><para>Windows 98 [se]</para></listitem> + <listitem><para>Windows Me</para></listitem> + </itemizedlist> <note> <para> @@ -281,13 +281,13 @@ Samba-3 introduces the following new password backend capabilities: The following versions of MS Windows fully support domain security protocols. </para> - <simplelist> - <member>Windows NT 3.5x</member> - <member>Windows NT 4.0</member> - <member>Windows 2000 Professional</member> - <member>Windows 200x Server/Advanced Server</member> - <member>Windows XP Professional</member> - </simplelist> + <itemizedlist> + <listitem><para>Windows NT 3.5x</para></listitem> + <listitem><para>Windows NT 4.0</para></listitem> + <listitem><para>Windows 2000 Professional</para></listitem> + <listitem><para>Windows 200x Server/Advanced Server</para></listitem> + <listitem><para>Windows XP Professional</para></listitem> + </itemizedlist> <para> All current release of Microsoft SMB/CIFS clients support authentication via the @@ -352,37 +352,63 @@ Samba-3 introduces the following new password backend capabilities: </sect2> <sect2> - <title>Mapping User Identifiers between MS Windows and Unix</title> + <title>Mapping User Identifiers between MS Windows and UNIX</title> <para> - Every operation in Unix/Linux requires a user identifier (UID), just as in + Every operation in UNIX/Linux requires a user identifier (UID), just as in MS Windows NT4 / 200x this requires a Security Identifier (SID). Samba provides - two means for mapping an MS Windows user to a Unix/Linux UID. + two means for mapping an MS Windows user to a UNIX/Linux UID. </para> <para> Firstly, all Samba SAM (Security Account Manager database) accounts require - a Unix/Linux UID that the account will map to. As users are added to the account - information database, Samba-3 will call the <parameter>add user script</parameter> - interface to add the account to the Samba host OS. In essence, all accounts in + a UNIX/Linux UID that the account will map to. As users are added to the account + information database, Samba will call the <smbconfoption><name>add user script</name></smbconfoption> + interface to add the account to the Samba host OS. In essence all accounts in the local SAM require a local user account. </para> <para> - The second way to affect Windows SID to Unix UID mapping is via the + The second way to affect Windows SID to UNIX UID mapping is via the <emphasis>idmap uid, idmap gid</emphasis> parameters in &smb.conf;. Please refer to the man page for information about these parameters. These parameters are essential when mapping users from a remote SAM server. </para> </sect2> + + <sect2 id="idmapbackend"> + <title>Mapping Common UIDs/GIDs on Distributed Machines</title> + + <para> + Samba-3 has a special facility that makes it possible to maintain identical UIDs and GIDs + on all servers in a distributed network. A distributed network is one where there exists + a PDC, one or more BDCs and/or one or more domain member servers. Why is this important? + This is important if files are being shared over more than one protocol (eg: NFS) and where + users are copying files across UNIX/Linux systems using tools such as <command>rsync</command>. + </para> + + <para> + The special facility is enabled using a parameter called <parameter>idmap backend</parameter>. + The default setting for this parameter is an empty string. Administrators should NOT set this + parameter except when an LDAP based passdb backend is in use. An example of use is: + </para> + + <para> +<smbconfexample id="idmapbackendexample"> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>idmap backend</name><value>ldapsam://ldap-server.quenya.org:636</value></smbconfoption> +</smbconfexample> + </para> + + </sect2> </sect1> -<sect1> +<sect1 id="acctmgmttools"> <title>Account Management Tools</title> <para> -Samba-3 provides two (2) tools for management of User and machine accounts. These tools are +Samba provides two (2) tools for management of User and machine accounts. These tools are called <command>smbpasswd</command> and <command>pdbedit</command>. A third tool is under development but is NOT expected to ship in time for Samba-3.0.0. The new tool will be a TCL/TK GUI tool that looks much like the MS Windows NT4 Domain User Manager - hopefully this will @@ -413,30 +439,30 @@ be announced in time for the Samba-3.0.1 release. <command>smbpasswd</command> can be used to: </para> - <simplelist> - <member><emphasis>add</emphasis> user or machine accounts</member> - <member><emphasis>delete</emphasis> user or machine accounts</member> - <member><emphasis>enable</emphasis> user or machine accounts</member> - <member><emphasis>disable</emphasis> user or machine accounts</member> - <member><emphasis>set to NULL</emphasis> user passwords</member> - <member><emphasis>manage interdomain trust accounts</emphasis></member> - </simplelist> + <itemizedlist> + <listitem><para><emphasis>add</emphasis> user or machine accounts</para></listitem> + <listitem><para><emphasis>delete</emphasis> user or machine accounts</para></listitem> + <listitem><para><emphasis>enable</emphasis> user or machine accounts</para></listitem> + <listitem><para><emphasis>disable</emphasis> user or machine accounts</para></listitem> + <listitem><para><emphasis>set to NULL</emphasis> user passwords</para></listitem> + <listitem><para><emphasis>manage interdomain trust accounts</emphasis></para></listitem> + </itemizedlist> <para> To run smbpasswd as a normal user just type: </para> <para> - <screen> - <prompt>$ </prompt><userinput>smbpasswd</userinput> - <prompt>Old SMB password: </prompt><userinput><replaceable>secret</replaceable></userinput> - </screen> +<screen> +&prompt;<userinput>smbpasswd</userinput> +<prompt>Old SMB password: </prompt><userinput><replaceable>secret</replaceable></userinput> +</screen> For <replaceable>secret</replaceable> type old value here - or hit return if there was no old password - <screen> - <prompt>New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput> - <prompt>Repeat New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput> - </screen> +<screen> +<prompt>New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput> +<prompt>Repeat New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput> +</screen> </para> <para> @@ -477,11 +503,11 @@ be announced in time for the Samba-3.0.1 release. manage the passdb backend. <command>pdbedit</command> can be used to: </para> - <simplelist> - <member>add, remove or modify user accounts</member> - <member>listing user accounts</member> - <member>migrate user accounts</member> - </simplelist> + <itemizedlist> + <listitem><para>add, remove or modify user accounts</para></listitem> + <listitem><para>listing user accounts</para></listitem> + <listitem><para>migrate user accounts</para></listitem> + </itemizedlist> <para> The <command>pdbedit</command> tool is the only one that can manage the account @@ -500,31 +526,54 @@ be announced in time for the Samba-3.0.1 release. a tdbsam password backend. This listing was produced by running: </para> - <screen> - <prompt>$ </prompt><userinput>pdbedit -Lv met</userinput> - Unix username: met - NT username: - Account Flags: [UX ] - User SID: S-1-5-21-1449123459-1407424037-3116680435-2004 - Primary Group SID: S-1-5-21-1449123459-1407424037-3116680435-1201 - Full Name: Melissa E Terpstra - Home Directory: \\frodo\met\Win9Profile - HomeDir Drive: H: - Logon Script: scripts\logon.bat - Profile Path: \\frodo\Profiles\met - Domain: MIDEARTH - Account desc: - Workstations: melbelle - Munged dial: - Logon time: 0 - Logoff time: Mon, 18 Jan 2038 20:14:07 GMT - Kickoff time: Mon, 18 Jan 2038 20:14:07 GMT - Password last set: Sat, 14 Dec 2002 14:37:03 GMT - Password can change: Sat, 14 Dec 2002 14:37:03 GMT - Password must change: Mon, 18 Jan 2038 20:14:07 GMT - </screen> - - <!-- FIXME: Add note about migrating user accounts --> +<screen> +&prompt;<userinput>pdbedit -Lv met</userinput> +UNIX username: met +NT username: +Account Flags: [UX ] +User SID: S-1-5-21-1449123459-1407424037-3116680435-2004 +Primary Group SID: S-1-5-21-1449123459-1407424037-3116680435-1201 +Full Name: Melissa E Terpstra +Home Directory: \\frodo\met\Win9Profile +HomeDir Drive: H: +Logon Script: scripts\logon.bat +Profile Path: \\frodo\Profiles\met +Domain: &example.workgroup; +Account desc: +Workstations: melbelle +Munged dial: +Logon time: 0 +Logoff time: Mon, 18 Jan 2038 20:14:07 GMT +Kickoff time: Mon, 18 Jan 2038 20:14:07 GMT +Password last set: Sat, 14 Dec 2002 14:37:03 GMT +Password can change: Sat, 14 Dec 2002 14:37:03 GMT +Password must change: Mon, 18 Jan 2038 20:14:07 GMT +</screen> + + <para> + The <command>pdbedit</command> tool allows migration of authentication (account) + databases from one backend to another. For example: To migrate accounts from an + old <filename>smbpasswd</filename> database to a <parameter>tdbsam</parameter> + backend: + </para> + + <procedure> + <step><para> + Set the <smbconfoption><name>passdb backend</name><value>tdbsam, smbpasswd</value></smbconfoption>. + </para></step> + + <step><para> + Execute: +<screen> +&rootprompt;<userinput>pdbedit -i smbpassed -e tdbsam</userinput> +</screen> + </para></step> + + <step><para> + Now remove the <parameter>smbpasswd</parameter> from the passdb backend + configuration in &smb.conf;. + </para></step> + </procedure> </sect2> </sect1> @@ -533,7 +582,7 @@ be announced in time for the Samba-3.0.1 release. <title>Password Backends</title> <para> -Samba-3 offers the greatest flexibility in backend account database design of any SMB/CIFS server +Samba offers the greatest flexibility in backend account database design of any SMB/CIFS server technology available today. The flexibility is immediately obvious as one begins to explore this capability. </para> @@ -544,11 +593,9 @@ backends of the same type. For example, to use two different tdbsam databases: </para> <para> -<programlisting> -[globals] - passdb backend = tdbsam:/etc/samba/passdb.tdb, \ - tdbsam:/etc/samba/old-passdb.tdb, guest -</programlisting> +<smbconfblock> +<smbconfoption><name>passdb backend</name><value>tdbsam:/etc/samba/passdb.tdb, tdbsam:/etc/samba/old-passdb.tdb</value></smbconfoption> +</smbconfblock> </para> @@ -570,8 +617,7 @@ backends of the same type. For example, to use two different tdbsam databases: <title>smbpasswd - Encrypted Password Database</title> <para> - Traditionally, when configuring <ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt - passwords = yes</ulink> in Samba's <filename>smb.conf</filename> file, user account + Traditionally, when configuring <smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption> in Samba's &smb.conf; file, user account information such as username, LM/NT password hashes, password change times, and account flags have been stored in the <filename>smbpasswd(5)</filename> file. There are several disadvantages to this approach for sites with very large numbers of users (counted @@ -609,7 +655,7 @@ backends of the same type. For example, to use two different tdbsam databases: </para> <para> - Samba-3 provides an enhanced set of passdb backends that overcome the deficiencies + Samba provides an enhanced set of passdb backends that overcome the deficiencies of the smbpasswd plain text database. These are tdbsam, ldapsam, and xmlsam. Of these ldapsam will be of most interest to large corporate or enterprise sites. </para> @@ -650,21 +696,14 @@ backends of the same type. For example, to use two different tdbsam databases: <para> The second item can be accomplished by using LDAP NSS and PAM modules. LGPL versions of these libraries can be obtained from PADL Software - (<ulink url="http://www.padl.com/">http://www.padl.com/</ulink>). More + (<ulink noescape="1" url="http://www.padl.com/">http://www.padl.com/</ulink>). More information about the configuration of these packages may be found at "LDAP, System Administration; Gerald Carter, O'Reilly; Chapter 6: Replacing NIS". - Refer to <ulink url="http://safari.oreilly.com/?XmlId=1-56592-491-6"> + Refer to <ulink noescape="1" url="http://safari.oreilly.com/?XmlId=1-56592-491-6"> http://safari.oreilly.com/?XmlId=1-56592-491-6</ulink> for those who might wish to know more about configuration and administration of an OpenLDAP server. </para> - <note> - <para> - This section is outdated for Samba-3 schema. Samba-3 introduces a new schema - that has not been documented at the time of this publication. - </para> - </note> - <para> This document describes how to use an LDAP directory for storing Samba user account information traditionally stored in the smbpasswd(5) file. It is @@ -674,9 +713,9 @@ backends of the same type. For example, to use two different tdbsam databases: </para> <itemizedlist> - <listitem><para>OpenLDAP - <ulink url="http://www.openldap.org/">http://www.openldap.org/</ulink></para></listitem> + <listitem><para>OpenLDAP - <ulink noescape="1" url="http://www.openldap.org/">http://www.openldap.org/</ulink></para></listitem> <listitem><para>iPlanet Directory Server - - <ulink url="http://iplanet.netscape.com/directory">http://iplanet.netscape.com/directory</ulink></para></listitem> + <ulink noescape="1" url="http://iplanet.netscape.com/directory">http://iplanet.netscape.com/directory</ulink></para></listitem> </itemizedlist> <para> @@ -715,13 +754,15 @@ backends of the same type. For example, to use two different tdbsam databases: <para> <programlisting> -objectclass ( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaSamAccount' SUP top AUXILIARY - DESC 'Samba Auxiliary Account' - MUST ( uid $ rid ) - MAY ( cn $ lmPassword $ ntPassword $ pwdLastSet $ logonTime $ - logoffTime $ kickoffTime $ pwdCanChange $ pwdMustChange $ acctFlags $ - displayName $ smbHome $ homeDrive $ scriptPath $ profilePath $ - description $ userWorkstations $ primaryGroupID $ domain )) +objectclass ( 1.3.6.1.4.1.7165.2.2.6 NAME 'sambaSamAccount' SUP top AUXILIARY + DESC 'Samba 3.0 Auxiliary SAM Account' + MUST ( uid $ sambaSID ) + MAY ( cn $ sambaLMPassword $ sambaNTPassword $ sambaPwdLastSet $ + sambaLogonTime $ sambaLogoffTime $ sambaKickoffTime $ + sambaPwdCanChange $ sambaPwdMustChange $ sambaAcctFlags $ + displayName $ sambaHomePath $ sambaHomeDrive $ sambaLogonScript $ + sambaProfilePath $ description $ sambaUserWorkstations $ + sambaPrimaryGroupSID $ sambaDomainName )) </programlisting> </para> @@ -730,7 +771,7 @@ objectclass ( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaSamAccount' SUP top AUXILIARY The OID's are owned by the Samba Team and as such is legal to be openly published. If you translate the schema to be used with Netscape DS, please submit the modified schema file as a patch to - <ulink url="mailto:jerry@samba.org">jerry@samba.org</ulink>. + <ulink noescape="1" url="mailto:jerry@samba.org">jerry@samba.org</ulink>. </para> <para> @@ -804,7 +845,7 @@ include /etc/openldap/schema/nis.schema </para> <para> -<screen> +<programlisting> # Indices to maintain ## required by OpenLDAP index objectclass eq @@ -826,7 +867,7 @@ index sambaSID eq index sambaPrimaryGroupSID eq index sambaDomainName eq index default sub -</screen> +</programlisting> </para> <para> @@ -835,7 +876,7 @@ index default sub <para> <screen> -./sbin/slapindex -f slapd.conf +&rootprompt;./sbin/slapindex -f slapd.conf </screen> </para> @@ -861,35 +902,35 @@ index default sub </para> <para> -<screen> +<programlisting> # Organization for Samba Base -dn: dc=plainjoe,dc=org +dn: dc=quenya,dc=org objectclass: dcObject objectclass: organization -dc: plainjoe -o: Terpstra Org Network +dc: quenya +o: Quenya Org Network description: The Samba-3 Network LDAP Example # Organizational Role for Directory Management -dn: cn=Manager,dc=plainjoe,dc=org +dn: cn=Manager,dc=quenya,dc=org objectclass: organizationalRole cn: Manager description: Directory Manager # Setting up container for users -dn: ou=People,dc=plainjoe,dc=org +dn: ou=People,dc=quenya,dc=org objectclass: top objectclass: organizationalUnit ou: People # Setting up admin handle for People OU -dn: cn=admin,ou=People,dc=plainjoe,dc=org +dn: cn=admin,ou=People,dc=quenya,dc=org cn: admin objectclass: top objectclass: organizationalRole objectclass: simpleSecurityObject userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz -</screen> +</programlisting> </para> <para> @@ -903,7 +944,7 @@ userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz <para> <screen> -<prompt>$ </prompt><userinput>slapadd -v -l initldap.dif</userinput> +&prompt;<userinput>slapadd -v -l initldap.dif</userinput> </screen> </para> @@ -916,9 +957,9 @@ userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz <para> Before Samba can access the LDAP server you need to store the LDAP admin password into the Samba-3 <filename>secrets.tdb</filename> database by: - <screen> -&rootprompt; <userinput>smbpasswd -w <replaceable>secret</replaceable></userinput> - </screen> +<screen> +&rootprompt;<userinput>smbpasswd -w <replaceable>secret</replaceable></userinput> +</screen> </para> </note> @@ -933,19 +974,18 @@ userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz LDAP libraries are found. </para> - <itemizedlist> - <listitem><para><ulink url="smb.conf.5.html#PASSDBBACKEND">passdb backend = ldapsam:url</ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#LDAPSSL">ldap ssl</ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#LDAPADMINDN">ldap admin dn</ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#LDAPSUFFIX">ldap suffix</ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#LDAPFILTER">ldap filter</ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#LDAPMACHINSUFFIX">ldap machine suffix</ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#LDAPUSERSUFFIX">ldap user suffix</ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#LDAPDELETEDN">ldap delete dn</ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#LDAPPASSWDSYNC">ldap passwd sync</ulink></para></listitem> - <listitem><para><ulink url="smb.conf.5.html#LDAPTRUSTIDS">ldap trust ids</ulink></para></listitem> - - </itemizedlist> + <para>LDAP related smb.conf options: + <smbconfoption><name>passdb backend</name><value>ldapsam:url</value></smbconfoption>, + <smbconfoption><name>ldap ssl</name></smbconfoption>, + <smbconfoption><name>ldap admin dn</name></smbconfoption>, + <smbconfoption><name>ldap suffix</name></smbconfoption>, + <smbconfoption><name>ldap filter</name></smbconfoption>, + <smbconfoption><name>ldap machine suffix</name></smbconfoption>, + <smbconfoption><name>ldap user suffix</name></smbconfoption>, + <smbconfoption><name>ldap delete dn</name></smbconfoption>, + <smbconfoption><name>ldap passwd sync</name></smbconfoption>, + <smbconfoption><name>ldap trust ids</name></smbconfoption>. + </para> <para> These are described in the &smb.conf; man @@ -954,49 +994,48 @@ userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz </para> <para> -<programlisting> -## /usr/local/samba/lib/smb.conf -[global] - security = user - encrypt passwords = yes - - netbios name = TASHTEGO - workgroup = NARNIA - - # ldap related parameters - - # define the DN to use when binding to the directory servers - # The password for this DN is not stored in smb.conf. Rather it - # must be set by using 'smbpasswd -w <replaceable>secretpw</replaceable>' to store the - # passphrase in the secrets.tdb file. If the "ldap admin dn" values - # change, this password will need to be reset. - ldap admin dn = "cn=Samba Manager,ou=people,dc=samba,dc=org" - - # Define the SSL option when connecting to the directory - # ('off', 'start tls', or 'on' (default)) - ldap ssl = start tls - - # syntax: passdb backend = ldapsam:ldap://server-name[:port] - passdb backend = ldapsam:ldap://funball.samba.org, guest - - # smbpasswd -x delete the entire dn-entry - ldap delete dn = no - - # the machine and user suffix added to the base suffix - # wrote WITHOUT quotes. NULL suffixes by default - ldap user suffix = ou=People - ldap machine suffix = ou=Systems - - # Trust unix account information in LDAP - # (see the smb.conf manpage for details) - ldap trust ids = Yes - - # specify the base DN to use when searching the directory - ldap suffix = "ou=people,dc=samba,dc=org" - - # generally the default ldap search filter is ok - # ldap filter = "(&(uid=%u)(objectclass=sambaSamAccount))" -</programlisting> +<smbconfexample> + <title>Configuration with LDAP</title> + <smbconfsection>[global]</smbconfsection> +<smbconfoption><name>security</name><value>user</value></smbconfoption> +<smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption> +<smbconfoption><name>netbios name</name><value>TASHTEGO</value></smbconfoption> +<smbconfoption><name>workgroup</name><value>NARNIA</value></smbconfoption> + +<smbconfcomment>ldap related parameters</smbconfcomment> + +<smbconfcomment>define the DN to use when binding to the directory servers</smbconfcomment> +<smbconfcomment>The password for this DN is not stored in smb.conf. Rather it</smbconfcomment> +<smbconfcomment>must be set by using 'smbpasswd -w <replaceable>secretpw</replaceable>' to store the</smbconfcomment> +<smbconfcomment>passphrase in the secrets.tdb file. If the "ldap admin dn" values</smbconfcomment> +<smbconfcomment>change, this password will need to be reset.</smbconfcomment> +<smbconfoption><name>ldap admin dn</name><value>"cn=Samba Manager,ou=people,dc=samba,dc=org"</value></smbconfoption> + +<smbconfcomment>Define the SSL option when connecting to the directory</smbconfcomment> +<smbconfcomment>('off', 'start tls', or 'on' (default))</smbconfcomment> +<smbconfoption><name>ldap ssl</name><value>start tls</value></smbconfoption> + +<smbconfcomment>syntax: passdb backend = ldapsam:ldap://server-name[:port]</smbconfcomment> +<smbconfoption><name>passdb backend</name><value>ldapsam:ldap://funball.samba.org</value></smbconfoption> + +<smbconfcomment>smbpasswd -x delete the entire dn-entry</smbconfcomment> +<smbconfoption><name>ldap delete dn</name><value>no</value></smbconfoption> + +<smbconfcomment>the machine and user suffix added to the base suffix</smbconfcomment> +<smbconfcomment>wrote WITHOUT quotes. NULL suffixes by default</smbconfcomment> +<smbconfoption><name>ldap user suffix</name><value>ou=People</value></smbconfoption> +<smbconfoption><name>ldap machine suffix</name><value>ou=Systems</value></smbconfoption> + +<smbconfcomment>Trust unix account information in LDAP</smbconfcomment> +<smbconfcomment> (see the smb.conf manpage for details)</smbconfcomment> +<smbconfoption><name>ldap trust ids</name><value>Yes</value></smbconfoption> + +<smbconfcomment> specify the base DN to use when searching the directory</smbconfcomment> +<smbconfoption><name>ldap suffix</name><value>"ou=people,dc=samba,dc=org"</value></smbconfoption> + +<smbconfcomment> generally the default ldap search filter is ok</smbconfcomment> +<smbconfoption><name>ldap filter</name><value>"(&(uid=%u)(objectclass=sambaSamAccount))"</value></smbconfoption> +</smbconfexample> </para> </sect3> @@ -1013,8 +1052,8 @@ userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz Machines accounts are managed with the sambaSamAccount objectclass, just like users accounts. However, it's up to you to store those accounts in a different tree of your LDAP namespace: you should use - "ou=Groups,dc=plainjoe,dc=org" to store groups and - "ou=People,dc=plainjoe,dc=org" to store users. Just configure your + "ou=Groups,dc=quenya,dc=org" to store groups and + "ou=People,dc=quenya,dc=org" to store users. Just configure your NSS and PAM accordingly (usually, in the /etc/ldap.conf configuration file). </para> @@ -1052,13 +1091,13 @@ userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz </para> <para> - To remedy the first security issue, the <parameter>ldap ssl</parameter> &smb.conf; parameter defaults - to require an encrypted session (<parameter>ldap ssl = on</parameter>) using + To remedy the first security issue, the <smbconfoption><name>ldap ssl</name></smbconfoption> &smb.conf; parameter defaults + to require an encrypted session (<smbconfoption><name>ldap ssl</name><value>on</value></smbconfoption>) using the default port of <constant>636</constant> when contacting the directory server. When using an OpenLDAP server, it is possible to use the use the StartTLS LDAP extended operation in the place of LDAPS. In either case, you are strongly discouraged to disable this security - (<parameter>ldap ssl = off</parameter>). + (<smbconfoption><name>ldap ssl</name><value>off</value></smbconfoption>). </para> <para> @@ -1077,7 +1116,7 @@ userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz <programlisting> ## allow the "ldap admin dn" access, but deny everyone else access to attrs=lmPassword,ntPassword - by dn="cn=Samba Admin,ou=people,dc=plainjoe,dc=org" write + by dn="cn=Samba Admin,ou=people,dc=quenya,dc=org" write by * none </programlisting> </para> @@ -1094,62 +1133,63 @@ access to attrs=lmPassword,ntPassword <para> <table frame="all"> <title>Attributes in the sambaSamAccount objectclass (LDAP)</title> - <tgroup cols="2" align="left"> + <tgroup cols="2" align="justify"> + <colspec align="left"/> + <colspec align="justify"/> <tbody> - <row><entry><constant>lmPassword</constant></entry><entry>the LANMAN password 16-byte hash stored as a character - representation of a hexadecimal string.</entry></row> - <row><entry><constant>ntPassword</constant></entry><entry>the NT password hash 16-byte stored as a character + <row><entry><constant>sambaLMPassword</constant></entry><entry>the LANMAN password 16-byte hash stored as a character +representation of a hexadecimal string.</entry></row> + <row><entry><constant>sambaNTPassword</constant></entry><entry>the NT password hash 16-byte stored as a character representation of a hexadecimal string.</entry></row> - <row><entry><constant>pwdLastSet</constant></entry><entry>The integer time in seconds since 1970 when the - <constant>lmPassword</constant> and <constant>ntPassword</constant> attributes were last set. + <row><entry><constant>sambaPwdLastSet</constant></entry><entry>The integer time in seconds since 1970 when the + <constant>sambaLMPassword</constant> and <constant>sambaNTPassword</constant> attributes were last set. </entry></row> - <row><entry><constant>acctFlags</constant></entry><entry>string of 11 characters surrounded by square brackets [] + <row><entry><constant>sambaAcctFlags</constant></entry><entry>string of 11 characters surrounded by square brackets [] representing account flags such as U (user), W(workstation), X(no password expiration), I(Domain trust account), H(Home dir required), S(Server trust account), and D(disabled).</entry></row> - <row><entry><constant>logonTime</constant></entry><entry>Integer value currently unused</entry></row> + <row><entry><constant>sambaLogonTime</constant></entry><entry>Integer value currently unused</entry></row> - <row><entry><constant>logoffTime</constant></entry><entry>Integer value currently unused</entry></row> + <row><entry><constant>sambaLogoffTime</constant></entry><entry>Integer value currently unused</entry></row> - <row><entry><constant>kickoffTime</constant></entry><entry>Integer value currently unused</entry></row> + <row><entry><constant>sambaKickoffTime</constant></entry><entry>Integer value currently unused</entry></row> - <row><entry><constant>pwdCanChange</constant></entry><entry>Integer value currently unused</entry></row> + <row><entry><constant>sambaPwdCanChange</constant></entry><entry>Integer value currently unused</entry></row> - <row><entry><constant>pwdMustChange</constant></entry><entry>Integer value currently unused</entry></row> + <row><entry><constant>sambaPwdMustChange</constant></entry><entry>Integer value currently unused</entry></row> - <row><entry><constant>homeDrive</constant></entry><entry>specifies the drive letter to which to map the - UNC path specified by homeDirectory. The drive letter must be specified in the form "X:" + <row><entry><constant>sambaHomeDrive</constant></entry><entry>specifies the drive letter to which to map the + UNC path specified by sambaHomePath. The drive letter must be specified in the form "X:" where X is the letter of the drive to map. Refer to the "logon drive" parameter in the smb.conf(5) man page for more information.</entry></row> - <row><entry><constant>scriptPath</constant></entry><entry>The scriptPath property specifies the path of + <row><entry><constant>sambaLogonScript</constant></entry><entry>The sambaLogonScript property specifies the path of the user's logon script, .CMD, .EXE, or .BAT file. The string can be null. The path - is relative to the netlogon share. Refer to the "logon script" parameter in the - smb.conf(5) man page for more information.</entry></row> + is relative to the netlogon share. Refer to the <smbconfoption><name>logon script</name></smbconfoption> parameter in the + &smb.conf; man page for more information.</entry></row> - <row><entry><constant>profilePath</constant></entry><entry>specifies a path to the user's profile. + <row><entry><constant>sambaProfilePath</constant></entry><entry>specifies a path to the user's profile. This value can be a null string, a local absolute path, or a UNC path. Refer to the - "logon path" parameter in the smb.conf(5) man page for more information.</entry></row> + <smbconfoption><name>logon path</name></smbconfoption> parameter in the &smb.conf; man page for more information.</entry></row> - <row><entry><constant>smbHome</constant></entry><entry>The homeDirectory property specifies the path of - the home directory for the user. The string can be null. If homeDrive is set and specifies - a drive letter, homeDirectory should be a UNC path. The path must be a network - UNC path of the form <filename>\\server\share\directory</filename>. This value can be a null string. - Refer to the <command>logon home</command> parameter in the &smb.conf; man page for more information. + <row><entry><constant>sambaHomePath</constant></entry><entry>The sambaHomePath property specifies the path of +the home directory for the user. The string can be null. If sambaHomeDrive is set and specifies +a drive letter, sambaHomePath should be a UNC path. The path must be a network +UNC path of the form <filename>\\server\share\directory</filename>. This value can be a null string. +Refer to the <command>logon home</command> parameter in the &smb.conf; man page for more information. </entry></row> - <row><entry><constant>userWorkstation</constant></entry><entry>character string value currently unused. + <row><entry><constant>sambaUserWorkstations</constant></entry><entry>character string value currently unused. </entry></row> - <row><entry><constant>rid</constant></entry><entry>the integer representation of the user's relative identifier - (RID).</entry></row> + <row><entry><constant>sambaSID</constant></entry><entry>The security identifier(SID) of the user. The windows equivalent of unix uid's.</entry></row> - <row><entry><constant>primaryGroupID</constant></entry><entry>the relative identifier (RID) of the primary group + <row><entry><constant>sambaPrimaryGroupSID</constant></entry><entry>the relative identifier (RID) of the primary group of the user.</entry></row> - <row><entry><constant>domain</constant></entry><entry>domain the user is part of.</entry></row> + <row><entry><constant>sambaDomainName</constant></entry><entry>domain the user is part of.</entry></row> </tbody> </tgroup></table> </para> @@ -1161,22 +1201,22 @@ access to attrs=lmPassword,ntPassword are only stored with the sambaSamAccount entry if the values are non-default values: </para> - <simplelist> - <member>smbHome</member> - <member>scriptPath</member> - <member>logonPath</member> - <member>homeDrive</member> - </simplelist> + <itemizedlist> + <listitem><para>sambaHomePath</para></listitem> + <listitem><para>sambaLogonScript</para></listitem> + <listitem><para>sambaProfilePath</para></listitem> + <listitem><para>sambaHomeDrive</para></listitem> + </itemizedlist> <para> These attributes are only stored with the sambaSamAccount entry if the values are non-default values. For example, assume TASHTEGO has now been - configured as a PDC and that <parameter>logon home = \\%L\%u</parameter> was defined in + configured as a PDC and that <smbconfoption><name>logon home</name><value>\\%L\%u</value></smbconfoption> was defined in its &smb.conf; file. When a user named "becky" logons to the domain, - the <parameter>logon home</parameter> string is expanded to \\TASHTEGO\becky. + the <smbconfoption><name>logon home</name></smbconfoption> string is expanded to \\TASHTEGO\becky. If the smbHome attribute exists in the entry "uid=becky,ou=people,dc=samba,dc=org", this value is used. However, if this attribute does not exist, then the value - of the <parameter>logon home</parameter> parameter is used in its place. Samba + of the <smbconfoption><name>logon home</name></smbconfoption> parameter is used in its place. Samba will only write the attribute value to the directory entry if the value is something other than the default (e.g. <filename>\\MOBY\becky</filename>). </para> @@ -1192,20 +1232,20 @@ access to attrs=lmPassword,ntPassword <para> <programlisting> - dn: uid=guest2, ou=people,dc=plainjoe,dc=org - ntPassword: 878D8014606CDA29677A44EFA1353FC7 - pwdMustChange: 2147483647 - primaryGroupID: 1201 - lmPassword: 552902031BEDE9EFAAD3B435B51404EE - pwdLastSet: 1010179124 - logonTime: 0 + dn: uid=guest2, ou=people,dc=quenya,dc=org + sambaNTPassword: 878D8014606CDA29677A44EFA1353FC7 + sambaPwdMustChange: 2147483647 + sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-513 + sambaNTPassword: 552902031BEDE9EFAAD3B435B51404EE + sambaPwdLastSet: 1010179124 + sambaLogonTime: 0 objectClass: sambaSamAccount uid: guest2 - kickoffTime: 2147483647 - acctFlags: [UX ] - logoffTime: 2147483647 - rid: 19006 - pwdCanChange: 0 + sambaKickoffTime: 2147483647 + sambaAcctFlags: [UX ] + sambaLogoffTime: 2147483647 + sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5006 + sambaPwdCanChange: 0 </programlisting> </para> @@ -1216,14 +1256,14 @@ access to attrs=lmPassword,ntPassword <para> <programlisting> - dn: uid=gcarter, ou=people,dc=plainjoe,dc=org - logonTime: 0 + dn: uid=gcarter, ou=people,dc=quenya,dc=org + sambaLogonTime: 0 displayName: Gerald Carter - lmPassword: 552902031BEDE9EFAAD3B435B51404EE - primaryGroupID: 1201 + sambaLMPassword: 552902031BEDE9EFAAD3B435B51404EE + sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-1201 objectClass: posixAccount objectClass: sambaSamAccount - acctFlags: [UX ] + sambaAcctFlags: [UX ] userPassword: {crypt}BpM2ej8Rkzogo uid: gcarter uidNumber: 9000 @@ -1231,13 +1271,13 @@ access to attrs=lmPassword,ntPassword loginShell: /bin/bash logoffTime: 2147483647 gidNumber: 100 - kickoffTime: 2147483647 - pwdLastSet: 1010179230 - rid: 19000 + sambaKickoffTime: 2147483647 + sambaPwdLastSet: 1010179230 + sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5004 homeDirectory: /home/tashtego/gcarter - pwdCanChange: 0 - pwdMustChange: 2147483647 - ntPassword: 878D8014606CDA29677A44EFA1353FC7 + sambaPwdCanChange: 0 + sambaPwdMustChange: 2147483647 + sambaNTPassword: 878D8014606CDA29677A44EFA1353FC7 </programlisting> </para> @@ -1251,7 +1291,7 @@ access to attrs=lmPassword,ntPassword using pam_ldap, this allows changing both unix and windows passwords at once. </para> - <para>The <parameter>ldap passwd sync</parameter> options can have the following values:</para> + <para>The <smbconfoption><name>ldap passwd sync</name></smbconfoption> options can have the following values:</para> <variablelist> <varlistentry> @@ -1268,12 +1308,11 @@ access to attrs=lmPassword,ntPassword <varlistentry> <term>only</term> - <listitem><para>Only update the LDAP password and let the LDAP server worry - about the other fields. This option is only available when the LDAP server supports LDAP_EXOP_X_MODIFY_PASSWD. </para></listitem> + <listitem><para>Only update the LDAP password and let the LDAP server worry about the other fields. This option is only available on some LDAP servers. <footnote><para>Only when the LDAP server supports LDAP_EXOP_X_MODIFY_PASSWD</para></footnote></para></listitem> </varlistentry> </variablelist> - <para>More information can be found in the <ulink url="smb.conf.5.html#LDAPPASSWDSYNC">smb.conf</ulink> manpage. + <para>More information can be found in the smb.conf manpage. </para> </sect3> @@ -1300,8 +1339,10 @@ access to attrs=lmPassword,ntPassword for the column names) or use the default table. The file <filename>examples/pdb/mysql/mysql.dump</filename> contains the correct queries to create the required tables. Use the command : - <screen><prompt>$ </prompt><userinput>mysql -u<replaceable>username</replaceable> -h<replaceable>hostname</replaceable> -p<replaceable>password</replaceable> \ -<replaceable>databasename</replaceable> < <filename>/path/to/samba/examples/pdb/mysql/mysql.dump</filename></userinput></screen> +<screen> +&prompt;<userinput>mysql -u<replaceable>username</replaceable> -h<replaceable>hostname</replaceable> -p<replaceable>password</replaceable> \ +<replaceable>databasename</replaceable> < <filename>/path/to/samba/examples/pdb/mysql/mysql.dump</filename></userinput> +</screen> </para> </sect3> @@ -1310,36 +1351,38 @@ access to attrs=lmPassword,ntPassword <para>This plugin lacks some good documentation, but here is some short info:</para> - <para>Add a the following to the <parameter>passdb backend</parameter> variable in your &smb.conf;: - <programlisting> - passdb backend = [other-plugins] mysql:identifier [other-plugins] - </programlisting> + <para>Add a the following to the <smbconfoption><name>passdb backend</name></smbconfoption> variable in your &smb.conf;: + <smbconfblock> +<smbconfoption><name>passdb backend</name><value>[other-plugins] mysql:identifier [other-plugins]</value></smbconfoption> + </smbconfblock> </para> <para>The identifier can be any string you like, as long as it doesn't collide with the identifiers of other plugins or other instances of pdb_mysql. If you - specify multiple pdb_mysql.so entries in <parameter>passdb backend</parameter>, you also need to + specify multiple pdb_mysql.so entries in <smbconfoption><name>passdb backend</name></smbconfoption>, you also need to use different identifiers! </para> <para> - Additional options can be given through the &smb.conf; file in the <parameter>[global]</parameter> section. + Additional options can be given through the &smb.conf; file in the <smbconfsection>[global]</smbconfsection> section. </para> <para> <table frame="all"> <title>Basic smb.conf options for MySQL passdb backend</title> - <tgroup cols="2" align="left"> + <tgroup cols="2"> + <colspec align="left"/> + <colspec align="justify"/> <thead> <row><entry>Field</entry><entry>Contents</entry></row> </thead> <tbody> - <row><entry>identifier:mysql host</entry><entry>host name, defaults to 'localhost'</entry></row> - <row><entry>identifier:mysql password</entry><entry></entry></row> - <row><entry>identifier:mysql user</entry><entry>defaults to 'samba'</entry></row> - <row><entry>identifier:mysql database</entry><entry>defaults to 'samba'</entry></row> - <row><entry>identifier:mysql port</entry><entry>defaults to 3306</entry></row> - <row><entry>identifier:table</entry><entry>Name of the table containing users</entry></row> + <row><entry>mysql host</entry><entry>host name, defaults to 'localhost'</entry></row> + <row><entry>mysql password</entry><entry></entry></row> + <row><entry>mysql user</entry><entry>defaults to 'samba'</entry></row> + <row><entry>mysql database</entry><entry>defaults to 'samba'</entry></row> + <row><entry>mysql port</entry><entry>defaults to 3306</entry></row> + <row><entry>table</entry><entry>Name of the table containing users</entry></row> </tbody> </tgroup> </table> @@ -1348,7 +1391,7 @@ access to attrs=lmPassword,ntPassword <warning> <para> Since the password for the MySQL user is stored in the - &smb.conf; file, you should make the the &smb.conf; file + &smb.conf; file, you should make the &smb.conf; file readable only to the user that runs Samba This is considered a security bug and will be fixed soon. </para> @@ -1359,40 +1402,43 @@ access to attrs=lmPassword,ntPassword <para> <table frame="all"> <title>MySQL field names for MySQL passdb backend</title> - <tgroup cols="3" align="left"> + <tgroup cols="3" align="justify"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="justify"/> <thead> <row><entry>Field</entry><entry>Type</entry><entry>Contents</entry></row> </thead> <tbody> - <row><entry>identifier:logon time column</entry><entry>int(9)</entry><entry></entry></row> - <row><entry>identifier:logoff time column</entry><entry>int(9)</entry><entry></entry></row> - <row><entry>identifier:kickoff time column</entry><entry>int(9)</entry><entry></entry></row> - <row><entry>identifier:pass last set time column</entry><entry>int(9)</entry><entry></entry></row> - <row><entry>identifier:pass can change time column</entry><entry>int(9)</entry><entry></entry></row> - <row><entry>identifier:pass must change time column</entry><entry>int(9)</entry><entry></entry></row> - <row><entry>identifier:username column</entry><entry>varchar(255)</entry><entry>unix username</entry></row> - <row><entry>identifier:domain column</entry><entry>varchar(255)</entry><entry>NT domain user is part of</entry></row> - <row><entry>identifier:nt username column</entry><entry>varchar(255)</entry><entry>NT username</entry></row> - <row><entry>identifier:fullname column</entry><entry>varchar(255)</entry><entry>Full name of user</entry></row> - <row><entry>identifier:home dir column</entry><entry>varchar(255)</entry><entry>Unix homedir path</entry></row> - <row><entry>identifier:dir drive column</entry><entry>varchar(2)</entry><entry>Directory drive path (eg: 'H:')</entry></row> - <row><entry>identifier:logon script column</entry><entry>varchar(255)</entry><entry>Batch file to run on client side when logging on</entry></row> - <row><entry>identifier:profile path column</entry><entry>varchar(255)</entry><entry>Path of profile</entry></row> - <row><entry>identifier:acct desc column</entry><entry>varchar(255)</entry><entry>Some ASCII NT user data</entry></row> - <row><entry>identifier:workstations column</entry><entry>varchar(255)</entry><entry>Workstations user can logon to (or NULL for all)</entry></row> - <row><entry>identifier:unknown string column</entry><entry>varchar(255)</entry><entry>unknown string</entry></row> - <row><entry>identifier:munged dial column</entry><entry>varchar(255)</entry><entry>?</entry></row> - <row><entry>identifier:user sid column</entry><entry>varchar(255)</entry><entry>NT user SID</entry></row> - <row><entry>identifier:group sid column</entry><entry>varchar(255)</entry><entry>NT group ID</entry></row> - <row><entry>identifier:lanman pass column</entry><entry>varchar(255)</entry><entry>encrypted lanman password</entry></row> - <row><entry>identifier:nt pass column</entry><entry>varchar(255)</entry><entry>encrypted nt passwd</entry></row> - <row><entry>identifier:plain pass column</entry><entry>varchar(255)</entry><entry>plaintext password</entry></row> - <row><entry>identifier:acct control column</entry><entry>int(9)</entry><entry>nt user data</entry></row> - <row><entry>identifier:unknown 3 column</entry><entry>int(9)</entry><entry>unknown</entry></row> - <row><entry>identifier:logon divs column</entry><entry>int(9)</entry><entry>?</entry></row> - <row><entry>identifier:hours len column</entry><entry>int(9)</entry><entry>?</entry></row> - <row><entry>identifier:unknown 5 column</entry><entry>int(9)</entry><entry>unknown</entry></row> - <row><entry>identifier:unknown 6 column</entry><entry>int(9)</entry><entry>unknown</entry></row> + <row><entry>logon time column</entry><entry>int(9)</entry><entry></entry></row> + <row><entry>logoff time column</entry><entry>int(9)</entry><entry></entry></row> + <row><entry>kickoff time column</entry><entry>int(9)</entry><entry></entry></row> + <row><entry>pass last set time column</entry><entry>int(9)</entry><entry></entry></row> + <row><entry>pass can change time column</entry><entry>int(9)</entry><entry></entry></row> + <row><entry>pass must change time column</entry><entry>int(9)</entry><entry></entry></row> + <row><entry>username column</entry><entry>varchar(255)</entry><entry>unix username</entry></row> + <row><entry>domain column</entry><entry>varchar(255)</entry><entry>NT domain user is part of</entry></row> + <row><entry>nt username column</entry><entry>varchar(255)</entry><entry>NT username</entry></row> + <row><entry>fullname column</entry><entry>varchar(255)</entry><entry>Full name of user</entry></row> + <row><entry>home dir column</entry><entry>varchar(255)</entry><entry>UNIX homedir path</entry></row> + <row><entry>dir drive column</entry><entry>varchar(2)</entry><entry>Directory drive path (eg: 'H:')</entry></row> + <row><entry>logon script column</entry><entry>varchar(255)</entry><entry>Batch file to run on client side when logging on</entry></row> + <row><entry>profile path column</entry><entry>varchar(255)</entry><entry>Path of profile</entry></row> + <row><entry>acct desc column</entry><entry>varchar(255)</entry><entry>Some ASCII NT user data</entry></row> + <row><entry>workstations column</entry><entry>varchar(255)</entry><entry>Workstations user can logon to (or NULL for all)</entry></row> + <row><entry>unknown string column</entry><entry>varchar(255)</entry><entry>unknown string</entry></row> + <row><entry>munged dial column</entry><entry>varchar(255)</entry><entry>?</entry></row> + <row><entry>user sid column</entry><entry>varchar(255)</entry><entry>NT user SID</entry></row> + <row><entry>group sid column</entry><entry>varchar(255)</entry><entry>NT group ID</entry></row> + <row><entry>lanman pass column</entry><entry>varchar(255)</entry><entry>encrypted lanman password</entry></row> + <row><entry>nt pass column</entry><entry>varchar(255)</entry><entry>encrypted nt passwd</entry></row> + <row><entry>plain pass column</entry><entry>varchar(255)</entry><entry>plaintext password</entry></row> + <row><entry>acct control column</entry><entry>int(9)</entry><entry>nt user data</entry></row> + <row><entry>unknown 3 column</entry><entry>int(9)</entry><entry>unknown</entry></row> + <row><entry>logon divs column</entry><entry>int(9)</entry><entry>?</entry></row> + <row><entry>hours len column</entry><entry>int(9)</entry><entry>?</entry></row> + <row><entry>unknown 5 column</entry><entry>int(9)</entry><entry>unknown</entry></row> + <row><entry>unknown 6 column</entry><entry>int(9)</entry><entry>unknown</entry></row> </tbody></tgroup> </table> </para> @@ -1475,16 +1521,16 @@ access to attrs=lmPassword,ntPassword <title>Common Errors</title> <sect2> - <title>Users can not logon - Users not in Samba SAM</title> + <title>Users can not logon</title> - <para> - People forget to put their users in their backend and then complain Samba won't authorize them. - </para> + <para><quote>I've installed samba, but now I can't log on with my unix account!</quote></para> + + <para>Make sure your user has been added to the current samba <smbconfoption><name>passdb backend</name></smbconfoption>. Read the section <link linkend="acctmgmttools">Account Management Tools</link> for details.</para> </sect2> <sect2> - <title>Users are being added to the wrong backend database</title> + <title>Users being added to wrong backend database</title> <para> A few complaints have been received from users that just moved to Samba-3. The following @@ -1493,12 +1539,12 @@ access to attrs=lmPassword,ntPassword </para> <para> - <programlisting> - [globals] - ... - passdb backend = smbpasswd, tdbsam, guest - ... - </programlisting> + <smbconfblock> + <smbconfsection>[global]</smbconfsection> + <member>...</member> +<smbconfoption><name>passdb backend</name><value>smbpasswd, tdbsam</value></smbconfoption> +<member>...</member> + </smbconfblock> </para> <para> @@ -1507,12 +1553,12 @@ access to attrs=lmPassword,ntPassword </para> <para> - <programlisting> - [globals] - ... - passdb backend = tdbsam, smbpasswd, guest - ... - </programlisting> + <smbconfblock> + <smbconfsection>[globals]</smbconfsection> + <member>...</member> +<smbconfoption><name>passdb backend</name><value>tdbsam, smbpasswd</value></smbconfoption> + <member>...</member> + </smbconfblock> </para> </sect2> @@ -1521,12 +1567,12 @@ access to attrs=lmPassword,ntPassword <title>auth methods does not work</title> <para> - If you explicitly set an 'auth methods' parameter, guest must be specified as the first - entry on the line. Eg: <parameter>auth methods = guest sam</parameter>. + If you explicitly set an <smbconfoption><name>auth methods</name></smbconfoption> parameter, guest must be specified as the first + entry on the line. Eg: <smbconfoption><name>auth methods</name><value>guest sam</value></smbconfoption>. </para> <para> - This is the exact opposite of the requirement for the <parameter>passdb backed</parameter> + This is the exact opposite of the requirement for the <smbconfoption><name>passdb backend</name></smbconfoption> option, where it must be the <emphasis>LAST</emphasis> parameter on the line. </para> diff --git a/docs/docbook/projdoc/printer_driver2.xml b/docs/docbook/projdoc/printer_driver2.xml index 11231e6c9a..0d0dbb0188 100644 --- a/docs/docbook/projdoc/printer_driver2.xml +++ b/docs/docbook/projdoc/printer_driver2.xml @@ -9,7 +9,7 @@ </affiliation> </author> &author.jerry; - <pubdate>May 32, 2003</pubdate> + <pubdate>May 31, 2003</pubdate> </chapterinfo> <title>Classical Printing Support</title> @@ -24,7 +24,7 @@ consisting of Windows workstations. </para> <para> -A Samba-3.0 print service may be run on a Standalone or a Domain +A Samba print service may be run on a Standalone or a Domain member server, side by side with file serving functions, or on a dedicated print server. It can be made as tight or as loosely secured as needs dictate. Configurations may be simple or complex. Available @@ -50,7 +50,7 @@ implemented by the more traditional UNIX (BSD- and System V-style) printing systems. Many things apply to CUPS, the newer Common UNIX Printing System, too; so if you use CUPS, you might be tempted to jump to the next chapter -- but you will certainly miss a few things if you -do so. Better read this chapter too. +do so. Better to read this chapter too. </para> <note> @@ -70,15 +70,15 @@ again. <para> Samba's printing support always relies on the installed print -subsystem of the Unix OS it runs on. Samba is a "middleman". It takes +subsystem of the UNIX OS it runs on. Samba is a "middleman". It takes printfiles from Windows (or other SMB) clients and passes them to the real printing system for further processing. Therefore it needs to -"talk" to two sides: to the Windows print clients and to the Unix +"talk" to two sides: to the Windows print clients and to the UNIX printing system. Hence we must differentiate between the various client OS types each of which behave differently, as well as the various UNIX print subsystems, which themselves have different features and are accessed differently. This part of the Samba HOWTO -Collection deals with the "traditional" way of Unix printing first; +Collection deals with the "traditional" way of UNIX printing first; the next chapter covers in great detail the more modern <emphasis>Common UNIX Printing System</emphasis> (CUPS). @@ -98,7 +98,7 @@ stages: </para> <orderedlist> -<listitem><para>Windows opens a connection to the printershare</para></listitem> +<listitem><para>Windows opens a connection to the printer share</para></listitem> <listitem><para>Samba must authenticate the user</para></listitem> @@ -110,7 +110,7 @@ into Samba's spooling area</para></listitem> <listitem><para>Samba invokes the print command to hand the file over to the UNIX print subsystem's spooling area</para></listitem> -<listitem><para>The Unix print subsystem processes the print +<listitem><para>The UNIX print subsystem processes the print job</para></listitem> <listitem><para>The printfile may need to be explicitly deleted @@ -134,8 +134,8 @@ Service Level ("<emphasis>S</emphasis>") parameters. <variablelist> <varlistentry><term>Service Level Parameters</term> <listitem><para>These <emphasis>may</emphasis> go into the -<parameter>[global]</parameter> section of -. In this case they define the default +<smbconfsection>[global]</smbconfsection> section of &smb.conf;. +In this case they define the default behaviour of all individual or service level shares (provided those don't have a different setting defined for the same parameter, thus overriding the global default).</para></listitem> @@ -153,47 +153,40 @@ this (if you run it) and tell you so.</para></listitem> <title>Parameters Recommended for Use</title> <para>The following &smb.conf; parameters directly -related to printing are used in Samba-3. See also the +related to printing are used in Samba. See also the &smb.conf; man page for detailed explanations: </para> -<formalpara> - <title>List of printing related parameters in Samba-3</title> -<para> -<itemizedlist><title>Global level parameters:</title> -<listitem><para><parameter>addprinter command (G)</parameter></para></listitem> -<listitem><para><parameter>deleteprinter command (G)</parameter></para></listitem> -<listitem><para><parameter>disable spoolss (G)</parameter></para></listitem> -<listitem><para><parameter>enumports command (G)</parameter></para></listitem> -<listitem><para><parameter>load printers (G)</parameter></para></listitem> -<listitem><para><parameter>lpq cache time (G)</parameter></para></listitem> -<listitem><para><parameter>os2 driver map (G)</parameter></para></listitem> -<listitem><para><parameter>printcap name (G), printcap (G)</parameter></para></listitem> -<listitem><para><parameter>show add printer wizard (G)</parameter></para></listitem> -<listitem><para><parameter>total print jobs (G)</parameter></para></listitem> -<listitem><para><parameter>use client driver (G)</parameter></para></listitem> -</itemizedlist> - -<itemizedlist><title>Service level parameters:</title> -<listitem><para><parameter>hosts allow (S)</parameter></para></listitem> -<listitem><para><parameter>hosts deny (S)</parameter></para></listitem> -<listitem><para><parameter>lppause command (S)</parameter></para></listitem> -<listitem><para><parameter>lpq command (S)</parameter></para></listitem> -<listitem><para><parameter>lpresume command (S)</parameter></para></listitem> -<listitem><para><parameter>lprm command (S)</parameter></para></listitem> -<listitem><para><parameter>max print jobs (S)</parameter></para></listitem> -<listitem><para><parameter>min print space (S)</parameter></para></listitem> -<listitem><para><parameter>print command (S)</parameter></para></listitem> -<listitem><para><parameter>printable (S), print ok (S)</parameter></para></listitem> -<listitem><para><parameter>printer name (S), printer (S)</parameter></para></listitem> -<listitem><para><parameter>printer admin (S)</parameter></para></listitem> -<listitem><para><parameter>printing = [cups|bsd|lprng...] (S)</parameter></para></listitem> -<listitem><para><parameter>queuepause command (S)</parameter></para></listitem> -<listitem><para><parameter>queueresume command (S)</parameter></para></listitem> -<listitem><para><parameter>total print jobs (S)</parameter></para></listitem> -</itemizedlist> +<para>Global level parameters: <smbconfoption><name>addprinter command</name></smbconfoption>, +<smbconfoption><name>deleteprinter command</name></smbconfoption>, +<smbconfoption><name>disable spoolss</name></smbconfoption>, +<smbconfoption><name>enumports command</name></smbconfoption>, +<smbconfoption><name>load printers</name></smbconfoption>, +<smbconfoption><name>lpq cache time</name></smbconfoption>, +<smbconfoption><name>os2 driver map</name></smbconfoption>, +<smbconfoption><name>printcap name</name></smbconfoption>, <smbconfoption><name>printcap</name></smbconfoption>, +<smbconfoption><name>show add printer wizard</name></smbconfoption>, +<smbconfoption><name>total print jobs</name></smbconfoption>, +<smbconfoption><name>use client driver</name></smbconfoption>. +</para> + +<para>Service level parameters: <smbconfoption><name>hosts allow</name></smbconfoption>, +<smbconfoption><name>hosts deny</name></smbconfoption>, +<smbconfoption><name>lppause command</name></smbconfoption>, +<smbconfoption><name>lpq command</name></smbconfoption>, +<smbconfoption><name>lpresume command</name></smbconfoption>, +<smbconfoption><name>lprm command</name></smbconfoption>, +<smbconfoption><name>max print jobs</name></smbconfoption>, +<smbconfoption><name>min print space</name></smbconfoption>, +<smbconfoption><name>print command</name></smbconfoption>, +<smbconfoption><name>printable</name></smbconfoption>, <smbconfoption><name>print ok </name></smbconfoption>, +<smbconfoption><name>printer name</name></smbconfoption>, <smbconfoption><name>printer</name></smbconfoption>, +<smbconfoption><name>printer admin</name></smbconfoption>, +<smbconfoption><name>printing</name><value>[cups|bsd|lprng...]</value></smbconfoption>, +<smbconfoption><name>queuepause command</name></smbconfoption>, +<smbconfoption><name>queueresume command</name></smbconfoption>, +<smbconfoption><name>total print jobs</name></smbconfoption>. </para> -</formalpara> <para> Samba's printing support implements the Microsoft Remote Procedure @@ -204,110 +197,43 @@ follow further beneath. </para> </sect2> -<sect2> -<title>Parameters for Backwards Compatibility</title> - -<para> -Two new parameters that were added in Samba 2.2.2, are still present -in Samba-3.0. Both of these options are described in the -&smb.conf; man page and are disabled by -default. <emphasis>Use them with caution!</emphasis> -</para> - -<variablelist> -<varlistentry><term><parameter>disable spoolss(G)</parameter></term> -<listitem><para> This is -provided for better support of Samba 2.0.x backwards capability. It -will disable Samba's support for MS-RPC printing and yield identical -printing behaviour to Samba 2.0.x.</para></listitem> -</varlistentry> - -<varlistentry><term><parameter>use client driver (G)</parameter></term> -<listitem><para> was provided -for using local printer drivers on Windows NT/2000 clients. It does -not apply to Windows 95/98/ME clients.</para></listitem> -</varlistentry> -</variablelist> - -<formalpara> -<title>Parameters "for backward compatibility only", use with caution</title> - -<para> -<itemizedlist> -<listitem><para><parameter>disable spoolss (G)</parameter></para></listitem> - -<listitem><para><parameter>use client driver (S)</parameter></para></listitem> -</itemizedlist> -</para> -</formalpara> - -</sect2> - -<sect2> -<title>Parameters no longer in use</title> - -<para> -Samba users upgrading from 2.2.x to 3.0 need to be aware that some -previously available settings are no longer supported (as was -announced some time ago). Here is a list of them: -</para> - -<formalpara> -<title>"old" parameters, removed in Samba-3</title> - -<para> -The following &smb.conf; parameters have been -deprecated already in Samba 2.2 and are now completely removed from -Samba-3. You cannot use them in new 3.0 installations: - -<itemizedlist> -<listitem><para><parameter>printer driver file (G)</parameter></para></listitem> -<listitem><para><parameter>total print jobs (G)</parameter></para></listitem> -<listitem><para><parameter>postscript (S)</parameter></para></listitem> -<listitem><para><parameter>printer driver (S)</parameter></para></listitem> -<listitem><para><parameter>printer driver location (S)</parameter></para></listitem> -</itemizedlist> -</para> - -</formalpara> - -</sect2> </sect1> <sect1> -<title>A simple Configuration to Print with Samba-3</title> +<title>A simple Configuration to Print</title> <para> Here is a very simple example configuration for print related settings -in the file. If you compare it with your -own system's , you probably find some +in the file. If you compare it with your own system's , you probably find some additional parameters included there (as pre-configured by your OS vendor). Further below is a discussion and explanation of the parameters. Note, that this example doesn't use many parameters. However, in many environments these are enough to provide a valid - which enables all clients to print. +&smb.conf; file which enables all clients to print. </para> -<para><programlisting> - [global] - printing = bsd - load printers = yes +<para><smbconfexample> + <title>Simple configuration with BSD printing</title> +<smbconfsection>[global]</smbconfsection> +<smbconfoption><name>printing</name><value>bsd</value></smbconfoption> +<smbconfoption><name>load printers</name><value>yes</value></smbconfoption> - [printers] - path = /var/spool/samba - printable = yes - public = yes - writable = no -</programlisting></para> +<smbconfsection>[printers]</smbconfsection> +<smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> +<smbconfoption><name>printable</name><value>yes</value></smbconfoption> +<smbconfoption><name>public</name><value>yes</value></smbconfoption> +<smbconfoption><name>writable</name><value>no</value></smbconfoption> +</smbconfexample></para> <para> -This is only an example configuration. Many settings, if not -explicitly set to a specific value, are used and set by Samba -implicitly to its own default, because these have been compiled in. -To see all settings, let root use the <command>testparm</command> -utility. <command>testparm</command> also gives warnings if you have -mis-configured certain things. Its complete output is easily 340 lines -and more. You may want to pipe it through a pager program. +This is only an example configuration. Samba assigns default values to all +configuration parameters. On the whole the defaults are conservative and +sensible. When a parameter is specified in the &smb.conf; file this overwrites +the default value. The <command>testparm</command> utility when run as root +is capable of reporting all setting, both default as well as &smb.conf; file +settings. <command>Testparm</command> gives warnings for all mis-configured +settings. The complete output is easily 340 lines and more, so you may want +to pipe it through a pager program. </para> <para> @@ -380,7 +306,7 @@ default behaviour. <emphasis>Don't forget about this point: it may be important in your future dealings with Samba.</emphasis> </para> -<note><para> testparm in Samba-3.0 behaves differently from 2.2.x: used +<note><para> testparm in samba 3 behaves differently from 2.2.x: used without the "-v" switch it only shows you the settings actually written into ! To see the complete configuration used, add the "-v" parameter to testparm.</para></note> @@ -394,15 +320,15 @@ configuration used, add the "-v" parameter to testparm.</para></note> Should you need to troubleshoot at any stage, please always come back to this point first and verify if "testparm" shows the parameters you expect! To give you an example from personal experience as a warning, -try to just "comment out" the <parameter>load printers</parameter>" +try to just "comment out" the <smbconfoption><name>load printers</name></smbconfoption>" parameter. If your 2.2.x system behaves like mine, you'll see this: </para> <para><screen> &rootprompt;grep "load printers" /etc/samba/smb.conf # load printers = Yes - # This setting is commented ooouuuuut!! - + # This setting is commented ooouuuuut!! + &rootprompt;testparm -v /etc/samba/smb.conf | egrep "(load printers)" load printers = Yes @@ -429,7 +355,7 @@ any more... at least not by this ;-) <para> Only when setting the parameter explicitly to -"<parameter>load printers = No</parameter>" +"<smbconfoption><name>load printers</name><value>No</value></smbconfoption>" would Samba recognize my intentions. So my strong advice is: </para> @@ -472,7 +398,7 @@ would be, if you used this minimalistic file as your real </para> <para><screen> -&rootprompt;<userinput> testparm -v /etc/samba/smb.conf-minimal | egrep "(print|lpq|spool|driver|ports|[)"</userinput> +&rootprompt;<userinput>testparm -v smb.conf-minimal | egrep "(print|lpq|spool|driver|ports|[)"</userinput> Processing section "[printers]" WARNING: [printers] service MUST be printable! No path in service printers - using /tmp @@ -507,7 +433,7 @@ testparm issued 2 warnings: <itemizedlist> <listitem><para>because we didn't specify the -<parameter>[printers]</parameter> section as printable, +<smbconfsection>[printers]</smbconfsection> section as printable, and</para></listitem> <listitem><para>because we didn't tell it which spool directory to @@ -516,8 +442,8 @@ use.</para></listitem> </itemizedlist> <para> -However, this was not fatal, and Samba-3.0 will default to values that -will work here. But, please!, don't rely on this and don't use this +However, this was not fatal, and samba will default to values that +will work here. Please, don't rely on this and don't use this example! This was only meant to make you careful to design and specify your setup to be what you really want it to be. The outcome on your system may vary for some parameters, since you may have a Samba built @@ -531,9 +457,10 @@ in a parameter value is retained verbatim.</quote> This means that a line consisting of, for example, </para> -<para><screen> -printing = lprng #This defines LPRng as the printing system" -</screen></para> +<para><smbconfblock> +<smbconfcomment>This defines LPRng as the printing system"</smbconfcomment> +<smbconfoption><name>printing</name><value>lprng</value></smbconfoption> +</smbconfblock></para> <para> will regard the whole of the string after the "=" @@ -544,61 +471,52 @@ that will be ignored, and a default value used instead.] </sect1> <sect1> -<title>Extended Sample Configuration to Print with Samba-3</title> +<title>Extended Sample Configuration to Print</title> <para> -Here we show a more verbose example configuration for print related -settings in an . Below is a discussion + In <link linkend="extbsdpr">the extended BSD configuration example</link> we show a more verbose example configuration for print related + settings in BSD-printing style environment . Below is a discussion and explanation of the various parameters. We chose to use BSD-style printing here, because we guess it is still the most commonly used system on legacy Linux installations (new installs now predominantly have CUPS, which is discussed entirely in the next chapter of this document). Note, that this example explicitly names many parameters -which don't need to be stated because they are set by default. You -might be able to do with a leaner .</para> - -<tip><para> -if you read access it with the Samba Web Administration Tool (SWAT), -and then write it to disk again, it will be optimized in a way such -that it doesn't contain any superfluous parameters and comments. SWAT -organizes the file for best performance. Remember that each smbd -re-reads the Samba configuration once a minute, and that each -connection spawns an smbd process of its own, so it is not a bad idea -to optimize the in environments with -hundreds or thousands of clients.</para></tip> - -<para><programlisting> - [global] - printing = bsd - load printers = yes - show add printer wizard = yes - printcap name = /etc/printcap - printer admin = @ntadmin, root - total print jobs = 100 - lpq cache time = 20 - use client driver = no - - [printers] - comment = All Printers - printable = yes - path = /var/spool/samba - browseable = no - guest ok = yes - public = yes - read only = yes - writable = no - - [my_printer_name] - comment = Printer with Restricted Access - path = /var/spool/samba_my_printer - printer admin = kurt - browseable = yes - printable = yes - writeable = no - hosts allow = 0.0.0.0 - hosts deny = turbo_xp, 10.160.50.23, 10.160.51.60 - guest ok = no -</programlisting></para> +which don't need to be specified because they are set by default. You +might be able to do with a leaner &smb.conf; file.</para> + +<para><smbconfexample id="extbsdpr"> + <title>Extended configuration with BSD printing</title> + <smbconfsection>[global]</smbconfsection> +<smbconfoption><name>printing</name><value>bsd</value></smbconfoption> +<smbconfoption><name>load printers</name><value>yes</value></smbconfoption> +<smbconfoption><name>show add printer wizard</name><value>yes</value></smbconfoption> +<smbconfoption><name>printcap name</name><value>/etc/printcap</value></smbconfoption> +<smbconfoption><name>printer admin</name><value>@ntadmin, root</value></smbconfoption> +<smbconfoption><name>total print jobs</name><value>100</value></smbconfoption> +<smbconfoption><name>lpq cache time</name><value>20</value></smbconfoption> +<smbconfoption><name>use client driver</name><value>no</value></smbconfoption> + +<smbconfsection>[printers]</smbconfsection> +<smbconfoption><name>comment</name><value>All Printers</value></smbconfoption> +<smbconfoption><name>printable</name><value>yes</value></smbconfoption> +<smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> +<smbconfoption><name>browseable</name><value>no</value></smbconfoption> +<smbconfoption><name>guest ok</name><value>yes</value></smbconfoption> +<smbconfoption><name>public</name><value>yes</value></smbconfoption> +<smbconfoption><name>read only</name><value>yes</value></smbconfoption> +<smbconfoption><name>writable</name><value>no </value></smbconfoption> + +<smbconfsection>[my_printer_name]</smbconfsection> +<smbconfoption><name>comment</name><value>Printer with Restricted Access</value></smbconfoption> +<smbconfoption><name>path</name><value>/var/spool/samba_my_printer</value></smbconfoption> +<smbconfoption><name>printer admin</name><value>kurt</value></smbconfoption> +<smbconfoption><name>browseable</name><value>yes</value></smbconfoption> +<smbconfoption><name>printable</name><value>yes</value></smbconfoption> +<smbconfoption><name>writeable</name><value>no</value></smbconfoption> +<smbconfoption><name>hosts allow</name><value>0.0.0.0</value></smbconfoption> +<smbconfoption><name>hosts deny</name><value>turbo_xp, 10.160.50.23, 10.160.51.60</value></smbconfoption> +<smbconfoption><name>guest ok</name><value>no</value></smbconfoption> +</smbconfexample></para> <para> This <emphasis>also</emphasis> is only an example configuration. You @@ -624,13 +542,13 @@ Following is a discussion of the settings from above shown example. <title>The [global] Section</title> <para> -The <parameter>[global]</parameter> section is one of 4 special -sections (along with [<parameter>[homes]</parameter>, -<parameter>[printers]</parameter> and -<parameter>[print$]</parameter>...) It contains all parameters which +The <smbconfsection>[global]</smbconfsection> section is one of 4 special +sections (along with [<smbconfsection>[homes]</smbconfsection>, +<smbconfsection>[printers]</smbconfsection> and +<smbconfsection>[print$]</smbconfsection>...) It contains all parameters which apply to the server as a whole. It is the place for parameters which -have only a "global" meaning (G). It may also contain service level -parameters (S) which then define default settings for all other +have only a "global" meaning. It may also contain service level +parameters which then define default settings for all other sections and shares. This way you can simplify the configuration and avoid setting the same value repeatedly. (Within each individual section or share you may however override these globally set "share @@ -638,35 +556,34 @@ level" settings and specify other values). </para> <variablelist> -<varlistentry><term><parameter>printing = bsd</parameter></term> +<varlistentry><term><smbconfoption><name>printing</name><value>bsd</value></smbconfoption></term> <listitem><para> this causes Samba to use default print commands applicable for the BSD (a.k.a. RFC 1179 style or LPR/LPD) printing system. In general, the "printing" parameter informs Samba about the print subsystem it should expect. Samba supports CUPS, LPD, LPRNG, SYSV, HPUX, AIX, QNX and PLP. Each of these systems defaults to a -different <parameter>print command</parameter> (and other queue control +different <smbconfoption><name>print command</name></smbconfoption> (and other queue control commands).</para> -<caution><para>The <parameter>printing</parameter> parameter is +<caution><para>The <smbconfoption><name>printing</name></smbconfoption> parameter is normally a service level parameter. Since it is included here in the -<parameter>[global]</parameter> section, it will take effect for all -printer shares that are not defined differently. Samba-3.0 no longer +<smbconfsection>[global]</smbconfsection> section, it will take effect for all +printer shares that are not defined differently. Samba 3 no longer supports the SOFTQ printing system.</para></caution> </listitem></varlistentry> -<varlistentry><term><parameter>load printers = yes</parameter></term> +<varlistentry><term><smbconfoption><name>load printers</name><value>yes</value></smbconfoption></term> <listitem><para> this tells Samba to create automatically all available printer shares. "Available" printer shares are discovered by scanning the printcap file. All created printer shares are also loaded for browsing. If you use this parameter, you do not need to specify separate shares for each printer. Each automatically created printer share will clone the configuration options found in the -<parameter>[printers]</parameter> section. (A <parameter>load printers +<smbconfsection>[printers]</smbconfsection> section. (A <parameter>load printers = no</parameter> setting will allow you to specify each UNIX printer you want to share separately, leaving out some you don't want to be publicly visible and available). </para></listitem></varlistentry> -<varlistentry><term><parameter>show add printer wizard = -yes</parameter></term> <listitem><para> this setting is normally +<varlistentry><term><smbconfoption><name>show add printer wizard</name><value>yes</value></smbconfoption> </term><listitem><para> this setting is normally enabled by default (even if the parameter is not written into the ). It makes the <guiicon>Add Printer Wizard</guiicon> icon show up in the <guiicon>Printers</guiicon> folder of the Samba host's @@ -674,12 +591,12 @@ share listing (as shown in <guiicon>Network Neighbourhood</guiicon> or by the <command>net view</command> command). To disable it, you need to explicitly set it to <constant>no</constant> (commenting it out will not suffice!). The Add Printer Wizard lets you upload printer -drivers to the <parameter>[print$]</parameter> share and associate it +drivers to the <smbconfsection>[print$]</smbconfsection> share and associate it with a printer (if the respective queue exists there before the action), or exchange a printer's driver against any other previously uploaded driver. </para></listitem></varlistentry> -<varlistentry><term><parameter>total print jobs = 100</parameter></term> +<varlistentry><term><smbconfoption><name>total print jobs</name><value>100</value></smbconfoption></term> <listitem><para> this setting sets the upper limit to 100 print jobs being active on the Samba server at any one time. Should a client submit a job which exceeds this number, a <quote>no more space @@ -688,7 +605,7 @@ Samba to the client. A setting of "0" (the default) means there is <emphasis>no</emphasis> limit at all! </para></listitem></varlistentry> -<varlistentry><term><parameter>printcap name = /etc/printcap</parameter></term> +<varlistentry><term><smbconfoption><name>printcap name</name><value>/etc/printcap</value></smbconfoption></term> <listitem><para> this tells Samba where to look for a list of available printer names. (If you use CUPS, make sure that a printcap @@ -696,27 +613,27 @@ file is written: this is controlled by the "Printcap" directive of <filename>cupsd.conf</filename>). </para></listitem></varlistentry> -<varlistentry><term><parameter>printer admin = @ntadmin</parameter></term> +<varlistentry><term><smbconfoption><name>printer admin</name><value>@ntadmin</value></smbconfoption></term> <listitem><para> members of the ntadmin group should be able to add drivers and set printer properties ("ntadmin" is only an example name, it needs to be a valid UNIX group name); root is implicitly always a -<parameter>printer admin</parameter>. The "@" sign precedes group names in +<smbconfoption><name>printer admin</name></smbconfoption>. The "@" sign precedes group names in . A printer admin can do anything to printers via the remote administration interfaces offered by MS-RPC -(see below). Note that the <parameter>printer admin</parameter> +(see below). Note that the <smbconfoption><name>printer admin</name></smbconfoption> parameter is normally a share level parameter, so you may associate different groups to different printer shares in larger installations, -if you use the <parameter>printer admin</parameter> parameter on the +if you use the <smbconfoption><name>printer admin</name></smbconfoption> parameter on the share levels). </para></listitem></varlistentry> -<varlistentry><term><parameter>lpq cache time = 20</parameter></term> +<varlistentry><term><smbconfoption><name>lpq cache time</name><value>20</value></smbconfoption></term> <listitem><para> this controls the cache time for the results of the lpq command. It prevents the lpq command being called too often and reduces load on a heavily used print server. </para></listitem></varlistentry> -<varlistentry><term><parameter>use client driver = no</parameter></term> +<varlistentry><term><smbconfoption><name>use client driver</name><value>no</value></smbconfoption></term> <listitem><para> if set to <constant>yes</constant>, this setting only takes effect for Win NT/2k/XP clients (and not for Win 95/98/ME). Its default value is <constant>No</constant> (or <constant>False</constant>). @@ -742,28 +659,28 @@ section as a general convenience shortcut to share all printers with minimal configuration. It is also a container for settings which should apply as default to all printers. (For more details see the &smb.conf; man page.) Settings inside this -container must be share level parameters (S). +container must be share level parameters. </para> <variablelist> -<varlistentry><term><parameter>comment = All printers</parameter></term> -<listitem><para> the <parameter>comment</parameter> is shown next to +<varlistentry><term><smbconfoption><name>comment</name><value>All printers</value></smbconfoption></term> +<listitem><para> the <smbconfoption><name>comment</name></smbconfoption> is shown next to the share if a client queries the server, either via <guiicon>Network Neighbourhood</guiicon> or with the <command>net view</command> command to list available shares. </para></listitem></varlistentry> -<varlistentry><term><parameter>printable = yes</parameter></term> +<varlistentry><term><smbconfoption><name>printable</name><value>yes</value></smbconfoption></term> <listitem><para> please note well, that the -<parameter>[printers]</parameter> service <emphasis>must</emphasis> be +<smbconfsection>[printers]</smbconfsection> service <emphasis>must</emphasis> be declared as printable. If you specify otherwise, smbd will refuse to load at startup. This parameter allows connected clients to open, write to and submit spool files into the -directory specified with the <parameter>path</parameter> parameter for +directory specified with the <smbconfoption><name>path</name></smbconfoption> parameter for this service. It is used by Samba to differentiate printer shares from file shares. </para></listitem></varlistentry> -<varlistentry><term><parameter>path = /var/spool/samba</parameter></term> +<varlistentry><term><smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption></term> <listitem><para>this must point to a directory used by Samba to spool incoming print files. <emphasis>It must not be the same as the spool directory specified in the configuration of your UNIX print @@ -771,21 +688,21 @@ subsystem!</emphasis> The path would typically point to a directory which is world writeable, with the "sticky" bit set to it. </para></listitem></varlistentry> -<varlistentry><term><parameter>browseable = no</parameter></term> +<varlistentry><term><smbconfoption><name>browseable</name><value>no</value></smbconfoption></term> <listitem><para> this is always set to <constant>no</constant> if -<parameter>printable = yes</parameter>. It makes the -<parameter>[printer]</parameter> share itself invisible in the +<smbconfoption><name>printable</name><value>yes</value></smbconfoption>. It makes the +<smbconfsection>[printer]</smbconfsection> share itself invisible in the list of available shares in a <command>net view</command> command or in the Explorer browse list. (Note that you will of course see the individual printers). </para></listitem></varlistentry> -<varlistentry><term><parameter>guest ok = yes</parameter></term> +<varlistentry><term><smbconfoption><name>guest ok</name><value>yes</value></smbconfoption></term> <listitem><para> if set to <constant>yes</constant>, then no password is required to connect to the printers service. Access will be granted with the -privileges of the <parameter>guest account</parameter>. On many systems the +privileges of the <smbconfoption><name>guest account</name></smbconfoption>. On many systems the guest account will map to a user named "nobody". This user is in the UNIX passwd file with an empty password, but with no valid UNIX login. (Note: on some systems the guest account might not have the @@ -798,9 +715,8 @@ command like </listitem></varlistentry> -<varlistentry><term><parameter>public = yes</parameter></term> -<listitem><para> this is a synonym for <parameter>guest ok = -yes</parameter>. Since we have <parameter>guest ok = yes</parameter>, +<varlistentry><term><smbconfoption><name>public</name><value>yes</value></smbconfoption></term> + <listitem><para> this is a synonym for <smbconfoption><name>guest ok</name><value>yes</value></smbconfoption>. Since we have <smbconfoption><name>guest ok</name><value>yes</value></smbconfoption>, it really doesn't need to be here! (This leads to the interesting question: <quote>What, if I by accident have to contradictory settings for the same share?</quote> The answer is: the last one encountered by @@ -811,7 +727,7 @@ account" parameter with different usernames, and then run testparm to see which one is actually used by Samba.) </para></listitem></varlistentry> -<varlistentry><term><parameter>read only = yes</parameter></term> +<varlistentry><term><smbconfoption><name>read only</name><value>yes</value></smbconfoption></term> <listitem><para>this normally (for other types of shares) prevents users creating or modifying files in the service's directory. However, in a "printable" service, it is <emphasis>always</emphasis> allowed to @@ -819,9 +735,9 @@ write to the directory (if user privileges allow the connection), but only via print spooling operations. "Normal" write operations are not allowed. </para></listitem></varlistentry> -<varlistentry><term><parameter>writeable = no</parameter></term> +<varlistentry><term><smbconfoption><name>writeable</name><value>no</value></smbconfoption></term> <listitem><para> -synonym for <parameter>read only = yes</parameter> +synonym for <smbconfoption><name>read only</name><value>yes</value></smbconfoption> </para></listitem></varlistentry> </variablelist> </sect2> @@ -831,7 +747,7 @@ synonym for <parameter>read only = yes</parameter> <para> If a section appears in the , which is -tagged as <parameter>printable = yes</parameter>, Samba presents it as +tagged as <smbconfoption><name>printable</name><value>yes</value></smbconfoption>, Samba presents it as a printer share to its clients. Note, that Win95/98/ME clients may have problems with connecting or loading printer drivers if the share name has more than 8 characters! Also be very careful if you give a @@ -843,54 +759,53 @@ the same name! </para> <variablelist> -<varlistentry><term><parameter>comment = Printer with Restricted Access</parameter></term> +<varlistentry><term><smbconfoption><name>comment</name><value>Printer with Restricted Access</value></smbconfoption></term> <listitem><para> the comment says it all. </para></listitem></varlistentry> -<varlistentry><term><parameter>path = /var/spool/samba_my_printer</parameter></term> +<varlistentry><term><smbconfoption><name>path</name><value>/var/spool/samba_my_printer</value></smbconfoption></term> <listitem><para> here we set the spooling area for this printer to another directory than the default. It is not a requirement to set it differently, but the option is available. </para></listitem></varlistentry> -<varlistentry><term><parameter>printer admin = kurt</parameter></term> +<varlistentry><term><smbconfoption><name>printer admin</name><value>kurt</value></smbconfoption></term> <listitem><para> the printer admin definition is different for this explicitly defined printer share from the general -<parameter>[printers]</parameter> share. It is not a requirement; we +<smbconfsection>[printers]</smbconfsection> share. It is not a requirement; we did it to show that it is possible if you want it. </para></listitem></varlistentry> -<varlistentry><term><parameter>browseable = yes</parameter></term> +<varlistentry><term><smbconfoption><name>browseable</name><value>yes</value></smbconfoption></term> <listitem><para> we also made this printer browseable (so that the clients may conveniently find it when browsing the <guiicon>Network Neighbourhood</guiicon>). </para></listitem></varlistentry> -<varlistentry><term><parameter>printable = yes</parameter></term> +<varlistentry><term><smbconfoption><name>printable</name><value>yes</value></smbconfoption></term> <listitem><para>see explanation in last subsection. </para></listitem></varlistentry> -<varlistentry><term><parameter>writeable = no</parameter></term> +<varlistentry><term><smbconfoption><name>writeable</name><value>no</value></smbconfoption></term> <listitem><para>see explanation in last subsection. </para></listitem></varlistentry> -<varlistentry><term><parameter>hosts allow = 10.160.50.,10.160.51.</parameter></term> +<varlistentry><term><smbconfoption><name>hosts allow</name><value>10.160.50.,10.160.51.</value></smbconfoption></term> <listitem><para>here we exercise a certain degree of access control -by using the <parameter>hosts allow</parameter> and <parameter>hosts deny</parameter> parameters. Note, that +by using the <smbconfoption><name>hosts allow</name></smbconfoption> and <smbconfoption><name>hosts deny</name></smbconfoption> parameters. Note, that this is not by any means a safe bet. It is not a way to secure your printers. This line accepts all clients from a certain subnet in a first evaluation of access control </para></listitem></varlistentry> -<varlistentry><term><parameter>hosts deny = turbo_xp,10.160.50.23,10.160.51.60 -</parameter></term> +<varlistentry><term><smbconfoption><name>hosts deny</name><value>turbo_xp,10.160.50.23,10.160.51.60</value></smbconfoption></term> <listitem><para>all listed hosts are not allowed here (even if they belong to the "allowed subnets"). As you can see, you could name IP addresses as well as NetBIOS hostnames here. </para></listitem></varlistentry> -<varlistentry><term><parameter>guest ok = no</parameter></term> +<varlistentry><term><smbconfoption><name>guest ok</name><value>no</value></smbconfoption></term> <listitem><para>this printer is not open for the guest account! </para></listitem></varlistentry> @@ -902,11 +817,11 @@ here. <para> In each section defining a printer (or in the -<parameter>[printers]</parameter> section), a <parameter>print +<smbconfsection>[printers]</smbconfsection> section), a <parameter>print command</parameter> parameter may be defined. It sets a command to process the files which have been placed into the Samba print spool directory for that printer. (That spool directory was, if you -remember, set up with the <parameter>path</parameter> +remember, set up with the <smbconfoption><name>path</name></smbconfoption> parameter). Typically, this command will submit the spool file to the Samba host's print subsystem, using the suitable system print command. But there is no requirement that this needs to be the @@ -922,14 +837,14 @@ shortage of free space. </sect2> <sect2> -<title>Default Print Commands for various Unix Print Subsystems</title> +<title>Default Print Commands for various UNIX Print Subsystems</title> <para> You learned earlier on, that Samba in most cases uses its built-in settings for many parameters if it can not find an explicitly stated one in its configuration file. The same is true for the -<parameter>print command</parameter>. The default print command varies -depending on the <parameter>printing =...</parameter> parameter +<smbconfoption><name>print command</name></smbconfoption>. The default print command varies +depending on the <smbconfoption><name>printing</name></smbconfoption> parameter setting. In the commands listed below, you will notice some parameters of the form <emphasis>%X</emphasis> where <emphasis>X</emphasis> is <emphasis>p, s, J</emphasis> etc. These letters stand for @@ -948,63 +863,63 @@ the special case of CUPS, which is discussed in the next chapter): </thead> <tbody> <row> -<entry><parameter>printing = bsd|aix|lprng|plp</parameter></entry> +<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> <entry>print command is <command>lpr -r -P%p %s</command></entry> </row> <row> -<entry><parameter>printing = sysv|hpux</parameter></entry> +<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> <entry>print command is <command>lp -c -P%p %s; rm %s</command></entry> </row> <row> -<entry> <parameter>printing = qnx</parameter></entry> +<entry> <smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> <entry>print command is <command>lp -r -P%p -s %s</command></entry> </row> <row> -<entry><parameter>printing = bsd|aix|lprng|plp</parameter></entry> +<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> <entry>lpq command is <command>lpq -P%p</command></entry> </row> <row> -<entry><parameter>printing = sysv|hpux</parameter></entry> +<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> <entry>lpq command is <command>lpstat -o%p</command></entry> </row> <row> -<entry><parameter>printing = qnx</parameter></entry> +<entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> <entry>lpq command is <command>lpq -P%p</command></entry> </row> <row> -<entry><parameter>printing = bsd|aix|lprng|plp</parameter></entry> +<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> <entry>lprm command is <command>lprm -P%p %j</command></entry> </row> <row> -<entry><parameter>printing = sysv|hpux</parameter></entry> +<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> <entry>lprm command is <command>cancel %p-%j</command></entry> </row> <row> -<entry><parameter>printing = qnx</parameter></entry> +<entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> <entry>lprm command is <command>cancel %p-%j</command></entry> </row> <row> -<entry><parameter>printing = bsd|aix|lprng|plp</parameter></entry> +<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> <entry>lppause command is <command>lp -i %p-%j -H hold</command></entry> </row> <row> -<entry><parameter>printing = sysv|hpux</parameter></entry> +<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> <entry>lppause command (...is empty)</entry> </row> <row> -<entry><parameter>printing = qnx</parameter></entry> +<entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> <entry>lppause command (...is empty)</entry> </row> <row> -<entry><parameter>printing = bsd|aix|lprng|plp</parameter></entry> +<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> <entry>lpresume command is <command>lp -i %p-%j -H resume</command></entry> </row> <row> -<entry><parameter>printing = sysv|hpux</parameter></entry> +<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> <entry>lpresume command (...is empty)</entry> </row> <row> -<entry><parameter>printing = qnx</parameter></entry> +<entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> <entry>lpresume command (...is empty)</entry> </row> </tbody> @@ -1016,7 +931,7 @@ We excluded the special CUPS case here, because it is discussed in the next chapter. Just a short summary. For <parameter>printing = CUPS</parameter>: If SAMBA is compiled against libcups, it uses the CUPS API to submit jobs, etc. (It is a good idea also to set -<parameter>printcap = cups</parameter> in case your +<smbconfoption><name>printcap</name><value>cups</value></smbconfoption> in case your <filename>cupsd.conf</filename> is set to write its autogenerated printcap file to an unusual place). Otherwise Samba maps to the System V printing commands with the -oraw option for printing, i.e. it uses @@ -1050,7 +965,7 @@ way you want them to work and not rely on any built-in defaults. <para> After a print job has finished spooling to a service, the -<parameter>print command</parameter> will be used by Samba via a +<smbconfoption><name>print command</name></smbconfoption> will be used by Samba via a <emphasis>system()</emphasis> call to process the spool file. Usually the command specified will submit the spool file to the host's printing subsystem. But there is no requirement at all that this must @@ -1102,7 +1017,7 @@ command. In this case the job is sent to the default printer. </para> <para> -If specified in the <parameter>[global]</parameter> section, the print +If specified in the <smbconfsection>[global]</smbconfsection> section, the print command given will be used for any printable service that does not have its own print command specified. If there is neither a specified print command for a printable service nor a global print command, @@ -1115,7 +1030,7 @@ hard disk. Note that printing may fail on some UNIXes from the "nobody" account. If this happens, create an alternative guest account and supply it with the privilege to print. Set up this guest account in -the <parameter>[global]</parameter> section with the <parameter>guest +the <smbconfsection>[global]</smbconfsection> section with the <parameter>guest account</parameter> parameter. </para> @@ -1126,28 +1041,26 @@ expand the included environment variables as usual. (The syntax to include a UNIX environment variable <parameter>$variable</parameter> in or in the Samba print command is <parameter>%$variable</parameter>.) To give you a working -<parameter>print command</parameter> example, the following will log a +<smbconfoption><name>print command</name></smbconfoption> example, the following will log a print job to <filename>/tmp/print.log</filename>, print the file, then remove it. Note that ';' is the usual separator for commands in shell scripts: </para> -<para><programlisting> -<![CDATA[ - print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s -]]> -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>print command</name><value>echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s</value></smbconfoption> +</smbconfblock></para> <para> You may have to vary your own command considerably from this example depending on how you normally print files on your system. The default -for the <parameter>print command</parameter> parameter varies depending on the setting of -the <parameter>printing</parameter> parameter. Another example is: +for the <smbconfoption><name>print command</name></smbconfoption> parameter varies depending on the setting of +the <smbconfoption><name>printing</name></smbconfoption> parameter. Another example is: </para> -<para><programlisting> - print command = /usr/local/samba/bin/myprintscript %p %s -</programlisting></para> +<para><smbconfblock> +<smbconfoption><name>print command</name><value>/usr/local/samba/bin/myprintscript %p %s</value></smbconfoption> +</smbconfblock></para> </sect2> </sect1> @@ -1176,15 +1089,11 @@ The additional functionality provided by the new SPOOLSS support includes: <listitem><para>Uploading of printer drivers via the Windows NT <emphasis>Add Printer Wizard</emphasis> (APW) or the -<emphasis>Imprints</emphasis> tool set (refer to <ulink -url="http://imprints.sourceforge.net/">http://imprints.sourceforge.net</ulink>); +<ulink url="http://imprints.sourceforge.net/">Imprints</ulink> tool set. </para></listitem> <listitem><para>Support for the native MS-RPC printing calls such as -StartDocPrinter, EnumJobs(), etc... (See the MSDN documentation -at <ulink -url="http://msdn.microsoft.com/">http://msdn.microsoft.com/</ulink> -for more information on the Win32 printing API);</para></listitem> + StartDocPrinter, EnumJobs(), etc... (See the <ulink url="http://msdn.microsoft.com/">MSDN documentation</ulink> for more information on the Win32 printing API);</para></listitem> <listitem><para>Support for NT <emphasis>Access Control Lists</emphasis> (ACL) on printer objects;</para></listitem> @@ -1197,7 +1106,7 @@ files).</para></listitem> </itemizedlist> <para> -One other benefit of an update is this: Samba-3 is able to publish +One other benefit of an update is this: Samba 3 is able to publish all its printers in Active Directory (or LDAP)! </para> @@ -1238,12 +1147,12 @@ possess a valid driver for the printer. This was fixed in Samba <para> But it is a new <emphasis>option</emphasis> to install the printer -drivers into the <parameter>[print$]</parameter> share of the Samba +drivers into the <smbconfsection>[print$]</smbconfsection> share of the Samba server, and a big convenience too. Then <emphasis>all</emphasis> clients (including 95/98/ME) get the driver installed when they first connect to this printer share. The <emphasis>uploading</emphasis> or <emphasis>depositing</emphasis> of the driver into this -<parameter>[print$]</parameter> share, and the following binding of +<smbconfsection>[print$]</smbconfsection> share, and the following binding of this driver to an existing Samba printer share can be achieved by different means: </para> @@ -1271,17 +1180,17 @@ does not use these uploaded drivers in any way to process spooled files</emphasis>. Drivers are utilized entirely by the clients, who download and install them via the "Point'n'Print" mechanism supported by Samba. The clients use these drivers to generate print files in the -format the printer (or the Unix print system) requires. Print files -received by Samba are handed over to the Unix printing system, which +format the printer (or the UNIX print system) requires. Print files +received by Samba are handed over to the UNIX printing system, which is responsible for all further processing, if needed. </para> </sect2> <sect2> -<title>The [printer$] Section is removed from Samba-3</title> +<title>The [printer$] Section is removed from Samba 3</title> <formalpara><title> -<parameter>[print$]</parameter> vs. <parameter>[printer$]</parameter> +<smbconfsection>[print$]</smbconfsection> vs. <smbconfsection>[printer$]</smbconfsection> </title> <para> @@ -1289,7 +1198,7 @@ Versions of Samba prior to 2.2 made it possible to use a share named <emphasis>[printer$]</emphasis>. This name was taken from the same named service created by Windows 9x clients when a printer was shared by them. Windows 9x printer servers always have a -<parameter>[printer$]</parameter> service which provides read-only +<smbconfsection>[printer$]</smbconfsection> service which provides read-only access (with no password required) in order to support printer driver downloads. However, Samba's initial implementation allowed for a parameter named <parameter>printer driver location</parameter> to be @@ -1298,16 +1207,16 @@ files associated with that printer. Another parameter named <parameter>printer driver</parameter> provided a means of defining the printer driver name to be sent to the client. These parameters, including the <parameter>printer driver file</parameter> parameter, -are now removed and can not be used in installations of Samba-3.0. -Now the share name <parameter>[print$]</parameter> is used for the +are now removed and can not be used in installations of samba-3. +Now the share name <smbconfsection>[print$]</smbconfsection> is used for the location of downloadable printer drivers. It is taken from the -<parameter>[print$]</parameter> service created by Windows NT PCs when +<smbconfsection>[print$]</smbconfsection> service created by Windows NT PCs when a printer is shared by them. Windows NT print servers always have a -<parameter>[print$]</parameter> service which provides read-write +<smbconfsection>[print$]</smbconfsection> service which provides read-write access (in the context of its ACLs) in order to support printer driver down- and uploads. Don't fear -- this does not mean Windows 9x clients are thrown aside now. They can use Samba's -<parameter>[print$]</parameter> share support just fine. +<smbconfsection>[print$]</smbconfsection> share support just fine. </para></formalpara> </sect2> @@ -1317,7 +1226,7 @@ clients are thrown aside now. They can use Samba's <para> In order to support the up- and downloading of printer driver files, you must first configure a file share named -<parameter>[print$]</parameter>. The "public" name of this share is +<smbconfsection>[print$]</smbconfsection>. The "public" name of this share is hard coded in Samba's internals (because it is hard coded in the MS Windows clients too). It cannot be renamed since Windows clients are programmed to search for a service of exactly this name if they want @@ -1327,33 +1236,33 @@ to retrieve printer driver files. <para> You should modify the server's file to add the global parameters and create the -<parameter>[print$]</parameter> file share (of course, some of the +<smbconfsection>[print$]</smbconfsection> 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><screen> - [global] - ; members of the ntadmin group should be able to add drivers and set - ; printer properties. root is implicitly always a 'printer admin'. - printer admin = @ntadmin - [....] +<para><smbconfexample> + <title>[print\$] example</title> + <smbconfsection>[global]</smbconfsection> + <smbconfcomment>members of the ntadmin group should be able to add drivers and set</smbconfcomment> + <smbconfcomment>printer properties. root is implicitly always a 'printer admin'.</smbconfcomment> + <smbconfoption><name>printer admin</name><value>@ntadmin</value></smbconfoption> + <member>...</member> + <smbconfsection>[printers]</smbconfsection> + <member>...</member> - [printers] - [....] - - [print$] - comment = Printer Driver Download Area - path = /etc/samba/drivers - browseable = yes - guest ok = yes - read only = yes - write list = @ntadmin, root -</screen></para> + <smbconfsection>[print$]</smbconfsection> +<smbconfoption><name>comment</name><value>Printer Driver Download Area</value></smbconfoption> +<smbconfoption><name>path</name><value>/etc/samba/drivers</value></smbconfoption> +<smbconfoption><name>browseable</name><value>yes</value></smbconfoption> +<smbconfoption><name>guest ok</name><value>yes</value></smbconfoption> +<smbconfoption><name>read only</name><value>yes</value></smbconfoption> +<smbconfoption><name>write list</name><value>@ntadmin, root</value></smbconfoption> +</smbconfexample></para> <para> Of course, you also need to ensure that the directory named by the -<parameter>path</parameter> parameter exists on the Unix file system. +<smbconfoption><name>path</name></smbconfoption> parameter exists on the UNIX file system. </para> </sect2> @@ -1362,33 +1271,33 @@ Of course, you also need to ensure that the directory named by the <title>Parameters in the [print$] Section</title> <para> -<parameter>[print$]</parameter> is a special section in +<smbconfsection>[print$]</smbconfsection> is a special section in . It contains settings relevant to potential printer driver download and local installation by clients. </para> <variablelist> -<varlistentry><term><parameter>comment = Printer Driver -Download Area</parameter></term> + <varlistentry><term><smbconfoption><name>comment</name><value>Printer Driver + Download Area</value></smbconfoption></term> <listitem><para> the comment appears next to the share name if it is listed in a share list (usually Windows clients won't see it often but it will also appear up in a <command>smbclient -L sambaserver </command> output). </para></listitem></varlistentry> -<varlistentry><term><parameter>path = /etc/samba/printers</parameter></term> +<varlistentry><term><smbconfoption><name>path</name><value>/etc/samba/printers</value></smbconfoption></term> <listitem><para> this is the path to the location of the Windows driver file deposit from the UNIX point of view.</para></listitem></varlistentry> -<varlistentry><term><parameter>browseable = no</parameter></term> -<listitem><para> this makes the <parameter>[print$]</parameter> share +<varlistentry><term><smbconfoption><name>browseable</name><value>no</value></smbconfoption></term> +<listitem><para> this makes the <smbconfsection>[print$]</smbconfsection> share "invisible" in Network Neighbourhood to clients. However, you can still "mount" it from any client using the <command>net use g:\\sambaserver\print$</command> command in a "DOS box" or the "Connect network drive" menu from Windows Explorer.</para></listitem></varlistentry> -<varlistentry><term><parameter>guest ok = yes</parameter></term> +<varlistentry><term><smbconfoption><name>guest ok</name><value>yes</value></smbconfoption></term> <listitem><para>this gives read only access to this share for all guest users. Access may be used to download and install printer drivers on clients. The requirement for <parameter>guest ok = @@ -1404,19 +1313,19 @@ validated by the Domain Controller in order to logon to the Windows NT session), then guest access is not necessary. Of course, in a workgroup environment where you just want to be able to print without worrying about silly accounts and security, then configure the share -for guest access. You'll probably want to add <parameter>map to guest -= Bad User</parameter> in the <parameter>[global]</parameter> section +for guest access. You'll probably want to add <smbconfoption><name>map to guest</name><value>Bad User</value></smbconfoption> in the +<smbconfsection>[global]</smbconfsection> section as well. Make sure you understand what this parameter does before using it. </para></note> </listitem></varlistentry> -<varlistentry><term><parameter>read only = yes</parameter></term> +<varlistentry><term><smbconfoption><name>read only</name><value>yes</value></smbconfoption></term> <listitem><para>as we don't want everybody to upload driver files (or even change driver settings) we tagged this share as not writeable.</para></listitem></varlistentry> -<varlistentry><term><parameter>write list = @ntadmin,root</parameter></term> -<listitem><para>since the <parameter>[print$]</parameter> was made +<varlistentry><term><smbconfoption><name>write list</name><value>@ntadmin,root</value></smbconfoption></term> +<listitem><para>since the <smbconfsection>[print$]</smbconfsection> was made read only by the previous setting, we need to create a "write list" also. UNIX groups (denoted with a leading "@" character) and users listed here are allowed write access (as an exception to the general @@ -1425,7 +1334,7 @@ share. Normally you will want to only name administrative level user accounts in this setting. Check the file system permissions to make sure these accounts can copy files to the share. If this is a non-root account, then the account should also be mentioned in the global -<parameter>printer admin </parameter> parameter. See the +<smbconfoption><name>printer admin </name></smbconfoption> parameter. See the man page for more information on configuring file shares. </para></listitem></varlistentry> @@ -1439,18 +1348,18 @@ configuring file shares. </para></listitem></varlistentry> <para> In order for a Windows NT print server to support the downloading of driver files by multiple client architectures, you must create several -subdirectories within the <parameter>[print$]</parameter> service -(i.e. the Unix directory named by the <parameter>path</parameter> +subdirectories within the <smbconfsection>[print$]</smbconfsection> service +(i.e. the UNIX directory named by the <smbconfoption><name>path</name></smbconfoption> parameter). These correspond to each of the supported client architectures. Samba follows this model as well. Just like the name of -the <parameter>[print$]</parameter> share itself, the subdirectories +the <smbconfsection>[print$]</smbconfsection> share itself, the subdirectories *must* be exactly the names listed below (you may leave out the subdirectories of architectures you don't want to support). </para> <para> Therefore, create a directory tree below the -<parameter>[print$]</parameter> share for each architecture you wish +<smbconfsection>[print$]</smbconfsection> share for each architecture you wish to support. </para> @@ -1483,13 +1392,13 @@ named in the <emphasis>printer admin</emphasis>list.</para></listitem> <para> Of course, the connected account must still possess access to add files to the subdirectories beneath -<parameter>[print$]</parameter>. Remember that all file shares are set +<smbconfsection>[print$]</smbconfsection>. Remember that all file shares are set to 'read only' by default. </para> </important> <para> -Once you have created the required <parameter>[print$]</parameter> +Once you have created the required <smbconfsection>[print$]</smbconfsection> service and associated subdirectories, go to a Windows NT 4.0/2k/XP client workstation. Open <guiicon>Network Neighbourhood</guiicon> or <guiicon>My Network Places</guiicon> and browse for the Samba host. @@ -1504,7 +1413,7 @@ that matches the printer shares defined on your Samba host. <title>Installing Drivers into [print$]</title> <para> -You have successfully created the <parameter>[print$]</parameter> +You have successfully created the <smbconfsection>[print$]</smbconfsection> share in ? And Samba has re-read its configuration? Good. But you are not yet ready to take off. The <emphasis>driver files</emphasis> need to be present in this share, @@ -1512,7 +1421,7 @@ too! So far it is still an empty share. Unfortunately, it is not enough to just copy the driver files over. They need to be <emphasis>set up</emphasis> too. And that is a bit tricky, to say the least. We will now discuss two alternative ways to install the drivers into -<parameter>[print$]</parameter>: +<smbconfsection>[print$]</smbconfsection>: </para> <itemizedlist> @@ -1539,8 +1448,8 @@ entrance to this realm seems a little bit weird at first). <para> The initial listing of printers in the Samba host's <guiicon>Printers</guiicon> folder accessed from a client's Explorer -will have no real printer driver assigned to them. By default, in -Samba-3 (as in 2.2.1 and later) this driver name is set to a NULL +will have no real printer driver assigned to them. By default +this driver name is set to a NULL string. This must be changed now. The local <emphasis>Add Printer Wizard</emphasis>, run from NT/2000/XP clients, will help us in this task. @@ -1585,7 +1494,7 @@ Once the APW is started, the procedure is exactly the same as the one you are familiar with in Windows (we assume here that you are familiar with the printer driver installations procedure on Windows NT). Make sure your connection is in fact setup as a user with -<parameter>printer admin</parameter> privileges (if in doubt, use +<smbconfoption><name>printer admin</name></smbconfoption> privileges (if in doubt, use <command>smbstatus</command> to check for this). If you wish to install printer drivers for client operating systems other than <application>Windows NT x86</application>, you will need to use the @@ -1594,7 +1503,7 @@ install printer drivers for client operating systems other than <para> Assuming you have connected with an administrative (or root) account -(as named by the <parameter>printer admin</parameter> parameter), +(as named by the <smbconfoption><name>printer admin</name></smbconfoption> parameter), you will also be able to modify other printer properties such as ACLs and default device settings using this dialog. For the default device settings, please consider the advice given further below. @@ -1607,7 +1516,7 @@ settings, please consider the advice given further below. <para> The second way to install printer drivers into -<parameter>[print$]</parameter> and set them up in a valid way can be +<smbconfsection>[print$]</smbconfsection> and set them up in a valid way can be done from the UNIX command line. This involves four distinct steps: </para> @@ -1616,7 +1525,7 @@ done from the UNIX command line. This involves four distinct steps: and collecting the files together;</para></listitem> <listitem><para>deposit the driver files into the -<parameter>[print$]</parameter> share's correct subdirectories +<smbconfsection>[print$]</smbconfsection> share's correct subdirectories (possibly by using <command>smbclient</command>);</para></listitem> <listitem><para>running the <command>rpcclient</command> @@ -1692,35 +1601,35 @@ different spaces in between words: </para> <para><screen> -&rootprompt;<userinput>rpcclient -U'Danka%xxxx' -c 'getdriver "Heidelberg Digimaster 9110 (PS)" 3' TURBO_XP</userinput> - cmd = getdriver "Heidelberg Digimaster 9110 (PS)" 3 - - [Windows NT x86] - Printer Driver Info 3: - Version: [2] - Driver Name: [Heidelberg Digimaster 9110 (PS)] - Architecture: [Windows NT x86] - Driver Path: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01_de.DLL] - Datafile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.ppd] - Configfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01U_de.DLL] - Helpfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01U_de.HLP] +&rootprompt;<userinput>rpcclient -U'Danka%xxxx' -c \ + 'getdriver "Heidelberg Digimaster 9110 (PS)" 3' TURBO_XP</userinput> +cmd = getdriver "Heidelberg Digimaster 9110 (PS)" 3 + +[Windows NT x86] +Printer Driver Info 3: + Version: [2] + Driver Name: [Heidelberg Digimaster 9110 (PS)] + Architecture: [Windows NT x86] + Driver Path: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01_de.DLL] + Datafile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.ppd] + Configfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01U_de.DLL] + Helpfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01U_de.HLP] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.DLL] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.INI] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1KMMin.DLL] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.dat] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.cat] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.def] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.hre] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.vnd] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.hlp] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de_reg.HLP] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01Aux.dll] - Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01_de.NTF] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.DLL] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.INI] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1KMMin.DLL] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.dat] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.cat] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.def] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.hre] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.vnd] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.hlp] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de_reg.HLP] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01Aux.dll] + Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01_de.NTF] - Monitorname: [] - Defaultdatatype: [] - + Monitorname: [] + Defaultdatatype: [] </screen></para> <para> @@ -1738,7 +1647,7 @@ can also host the Win9x drivers, even if itself runs on Windows NT, </para> <para> -Since the <parameter>[print$]</parameter> share is usually accessible +Since the <smbconfsection>[print$]</smbconfsection> share is usually accessible through the <guiicon>Network Neighbourhood</guiicon>, you can also use the UNC notation from Windows Explorer to poke at it. The Win9x driver files will end up in subdirectory "0" of the "WIN40" directory. The full path to @@ -1763,7 +1672,7 @@ this. These type of drivers install into the "3" subdirectory. <para> Now we need to collect all the driver files we identified. in our previous step. Where do we get them from? Well, why not retrieve them -from the very PC and the same <parameter>[print$]</parameter> share +from the very PC and the same <smbconfsection>[print$]</smbconfsection> share which we investigated in our last step to identify the files? We can use <command>smbclient</command> to do this. We will use the paths and names which were leaked to us by <command>getdriver</command>. The @@ -1774,15 +1683,15 @@ listing is edited to include linebreaks for readability: &rootprompt;<userinput>smbclient //TURBO_XP/print\$ -U'Danka%xxxx' \ -c 'cd W32X86/2;mget HD*_de.* \ hd*ppd Hd*_de.* Hddm*dll HDN*Aux.DLL'</userinput> - added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0 - Got a positive name query response from 10.160.50.8 ( 10.160.50.8 ) - Domain=[DEVELOPMENT] OS=[Windows 5.1] Server=[Windows 2000 LAN Manager] - <prompt>Get file Hddm91c1_de.ABD? </prompt><userinput>n</userinput> - <prompt>Get file Hddm91c1_de.def? </prompt><userinput>y</userinput> - getting file \W32X86\2\Hddm91c1_de.def of size 428 as Hddm91c1_de.def (22.0 kb/s) (average 22.0 kb/s) - <prompt>Get file Hddm91c1_de.DLL? </prompt><userinput>y</userinput> - getting file \W32X86\2\Hddm91c1_de.DLL of size 876544 as Hddm91c1_de.DLL (737.3 kb/s) (average 737.3 kb/s) - [...] +added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0 +Got a positive name query response from 10.160.50.8 ( 10.160.50.8 ) +Domain=[DEVELOPMENT] OS=[Windows 5.1] Server=[Windows 2000 LAN Manager] +<prompt>Get file Hddm91c1_de.ABD? </prompt><userinput>n</userinput> +<prompt>Get file Hddm91c1_de.def? </prompt><userinput>y</userinput> +getting file \W32X86\2\Hddm91c1_de.def of size 428 as Hddm91c1_de.def +<prompt>Get file Hddm91c1_de.DLL? </prompt><userinput>y</userinput> +getting file \W32X86\2\Hddm91c1_de.DLL of size 876544 as Hddm91c1_de.DLL +[...] </screen></para> @@ -1800,7 +1709,7 @@ architecture should you need to support Win95/98/XP clients. Remember, the files for these architectures are in the WIN40/0/ subdir. Once we are complete, we can run <command>smbclient ... put</command> to store the collected files on the Samba server's -<parameter>[print$]</parameter> share. +<smbconfsection>[print$]</smbconfsection> share. </para> </sect3> @@ -1809,11 +1718,11 @@ the collected files on the Samba server's <para> So, now we are going to put the driver files into the -<parameter>[print$]</parameter> share. Remember, the UNIX path to this +<smbconfsection>[print$]</smbconfsection> share. Remember, the UNIX path to this share has been defined previously in your . You also have created subdirectories for the different Windows client types you want to support. Supposing -your <parameter>[print$]</parameter> share maps to the UNIX path +your <smbconfsection>[print$]</smbconfsection> share maps to the UNIX path <filename>/etc/samba/drivers/</filename>, your driver files should now go here: </para> @@ -1834,11 +1743,12 @@ network. We specify the same files and paths as were leaked to us by running <command>getdriver</command> against the original <emphasis>Windows</emphasis> install. However, now we are going to store the files into a <emphasis>Samba/UNIX</emphasis> print server's -<parameter>[print$]</parameter> share... +<smbconfsection>[print$]</smbconfsection> share... </para> <para><screen> -&rootprompt;<userinput>smbclient //SAMBA-CUPS/print\$ -U'root%xxxx' -c 'cd W32X86; put HDNIS01_de.DLL; \ + &rootprompt;<userinput>smbclient //SAMBA-CUPS/print\$ -U'root%xxxx' -c \ + 'cd W32X86; put HDNIS01_de.DLL; \ put Hddm91c1_de.ppd; put HDNIS01U_de.DLL; \ put HDNIS01U_de.HLP; put Hddm91c1_de.DLL; \ put Hddm91c1_de.INI; put Hddm91c1KMMin.DLL; \ @@ -1847,26 +1757,25 @@ store the files into a <emphasis>Samba/UNIX</emphasis> print server's put Hddm91c1_de.vnd; put Hddm91c1_de.hlp; \ put Hddm91c1_de_reg.HLP; put HDNIS01Aux.dll; \ put HDNIS01_de.NTF'</userinput> - added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0 - Got a positive name query response from 10.160.51.162 ( 10.160.51.162 ) - Domain=[CUPS-PRINT] OS=[Unix] Server=[Samba 2.2.7a] - putting file HDNIS01_de.DLL as \W32X86\HDNIS01_de.DLL (4465.5 kb/s) (average 4465.5 kb/s) - putting file Hddm91c1_de.ppd as \W32X86\Hddm91c1_de.ppd (12876.8 kb/s) (average 4638.9 kb/s) - putting file HDNIS01U_de.DLL as \W32X86\HDNIS01U_de.DLL (20249.8 kb/s) (average 5828.3 kb/s) - putting file HDNIS01U_de.HLP as \W32X86\HDNIS01U_de.HLP (9652.8 kb/s) (average 5899.8 kb/s) - putting file Hddm91c1_de.DLL as \W32X86\Hddm91c1_de.DLL (23777.7 kb/s) (average 10400.6 kb/s) - putting file Hddm91c1_de.INI as \W32X86\Hddm91c1_de.INI (98.6 kb/s) (average 10329.0 kb/s) - putting file Hddm91c1KMMin.DLL as \W32X86\Hddm91c1KMMin.DLL (22931.5 kb/s) (average 10501.7 kb/s) - putting file Hddm91c1_de.dat as \W32X86\Hddm91c1_de.dat (2462.8 kb/s) (average 10393.0 kb/s) - putting file Hddm91c1_de.dat as \W32X86\Hddm91c1_de.dat (4925.3 kb/s) (average 10356.3 kb/s) - putting file Hddm91c1_de.def as \W32X86\Hddm91c1_de.def (417.9 kb/s) (average 10290.1 kb/s) - putting file Hddm91c1_de.hre as \W32X86\Hddm91c1_de.hre (22571.3 kb/s) (average 11338.5 kb/s) - putting file Hddm91c1_de.vnd as \W32X86\Hddm91c1_de.vnd (3384.6 kb/s) (average 10754.3 kb/s) - putting file Hddm91c1_de.hlp as \W32X86\Hddm91c1_de.hlp (18406.8 kb/s) (average 10839.8 kb/s) - putting file Hddm91c1_de_reg.HLP as \W32X86\Hddm91c1_de_reg.HLP (20278.3 kb/s) (average 11386.3 kb/s) - putting file HDNIS01Aux.dll as \W32X86\HDNIS01Aux.dll (14994.6 kb/s) (average 11405.2 kb/s) - putting file HDNIS01_de.NTF as \W32X86\HDNIS01_de.NTF (23390.2 kb/s) (average 13170.8 kb/s) - +added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0 +Got a positive name query response from 10.160.51.162 ( 10.160.51.162 ) +Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.7a] +putting file HDNIS01_de.DLL as \W32X86\HDNIS01_de.DLL +putting file Hddm91c1_de.ppd as \W32X86\Hddm91c1_de.ppd +putting file HDNIS01U_de.DLL as \W32X86\HDNIS01U_de.DLL +putting file HDNIS01U_de.HLP as \W32X86\HDNIS01U_de.HLP +putting file Hddm91c1_de.DLL as \W32X86\Hddm91c1_de.DLL +putting file Hddm91c1_de.INI as \W32X86\Hddm91c1_de.INI +putting file Hddm91c1KMMin.DLL as \W32X86\Hddm91c1KMMin.DLL +putting file Hddm91c1_de.dat as \W32X86\Hddm91c1_de.dat +putting file Hddm91c1_de.dat as \W32X86\Hddm91c1_de.dat +putting file Hddm91c1_de.def as \W32X86\Hddm91c1_de.def +putting file Hddm91c1_de.hre as \W32X86\Hddm91c1_de.hre +putting file Hddm91c1_de.vnd as \W32X86\Hddm91c1_de.vnd +putting file Hddm91c1_de.hlp as \W32X86\Hddm91c1_de.hlp +putting file Hddm91c1_de_reg.HLP as \W32X86\Hddm91c1_de_reg.HLP +putting file HDNIS01Aux.dll as \W32X86\HDNIS01Aux.dll +putting file HDNIS01_de.NTF as \W32X86\HDNIS01_de.NTF </screen></para> <para> @@ -1893,42 +1802,42 @@ also and do this through a standard UNIX shell access too): </para> <para><screen> -&rootprompt;<userinput>smbclient //SAMBA-CUPS/print\$ -U 'root%xxxx' -c 'cd W32X86; pwd; dir; cd 2; pwd; dir'</userinput> +&rootprompt;<userinput>smbclient //SAMBA-CUPS/print\$ -U 'root%xxxx' \ + -c 'cd W32X86; pwd; dir; cd 2; pwd; dir'</userinput> added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0 - Got a positive name query response from 10.160.51.162 ( 10.160.51.162 ) - Domain=[CUPS-PRINT] OS=[Unix] Server=[Samba 2.2.7a] - - Current directory is \\SAMBA-CUPS\print$\W32X86\ - . D 0 Sun May 4 03:56:35 2003 - .. D 0 Thu Apr 10 23:47:40 2003 - 2 D 0 Sun May 4 03:56:18 2003 - HDNIS01Aux.dll A 15356 Sun May 4 03:58:59 2003 - Hddm91c1KMMin.DLL A 46966 Sun May 4 03:58:59 2003 - HDNIS01_de.DLL A 434400 Sun May 4 03:58:59 2003 - HDNIS01_de.NTF A 790404 Sun May 4 03:56:35 2003 - Hddm91c1_de.DLL A 876544 Sun May 4 03:58:59 2003 - Hddm91c1_de.INI A 101 Sun May 4 03:58:59 2003 - Hddm91c1_de.dat A 5044 Sun May 4 03:58:59 2003 - Hddm91c1_de.def A 428 Sun May 4 03:58:59 2003 - Hddm91c1_de.hlp A 37699 Sun May 4 03:58:59 2003 - Hddm91c1_de.hre A 323584 Sun May 4 03:58:59 2003 - Hddm91c1_de.ppd A 26373 Sun May 4 03:58:59 2003 - Hddm91c1_de.vnd A 45056 Sun May 4 03:58:59 2003 - HDNIS01U_de.DLL A 165888 Sun May 4 03:58:59 2003 - HDNIS01U_de.HLP A 19770 Sun May 4 03:58:59 2003 - Hddm91c1_de_reg.HLP A 228417 Sun May 4 03:58:59 2003 - 40976 blocks of size 262144. 709 blocks available - - Current directory is \\SAMBA-CUPS\print$\W32X86\2\ - . D 0 Sun May 4 03:56:18 2003 - .. D 0 Sun May 4 03:56:35 2003 - ADOBEPS5.DLL A 434400 Sat May 3 23:18:45 2003 - laserjet4.ppd A 9639 Thu Apr 24 01:05:32 2003 - ADOBEPSU.DLL A 109568 Sat May 3 23:18:45 2003 - ADOBEPSU.HLP A 18082 Sat May 3 23:18:45 2003 - PDFcreator2.PPD A 15746 Sun Apr 20 22:24:07 2003 - 40976 blocks of size 262144. 709 blocks available - +Got a positive name query response from 10.160.51.162 ( 10.160.51.162 ) +Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.7a] + +Current directory is \\SAMBA-CUPS\print$\W32X86\ +. D 0 Sun May 4 03:56:35 2003 +.. D 0 Thu Apr 10 23:47:40 2003 +2 D 0 Sun May 4 03:56:18 2003 +HDNIS01Aux.dll A 15356 Sun May 4 03:58:59 2003 +Hddm91c1KMMin.DLL A 46966 Sun May 4 03:58:59 2003 +HDNIS01_de.DLL A 434400 Sun May 4 03:58:59 2003 +HDNIS01_de.NTF A 790404 Sun May 4 03:56:35 2003 +Hddm91c1_de.DLL A 876544 Sun May 4 03:58:59 2003 +Hddm91c1_de.INI A 101 Sun May 4 03:58:59 2003 +Hddm91c1_de.dat A 5044 Sun May 4 03:58:59 2003 +Hddm91c1_de.def A 428 Sun May 4 03:58:59 2003 +Hddm91c1_de.hlp A 37699 Sun May 4 03:58:59 2003 +Hddm91c1_de.hre A 323584 Sun May 4 03:58:59 2003 +Hddm91c1_de.ppd A 26373 Sun May 4 03:58:59 2003 +Hddm91c1_de.vnd A 45056 Sun May 4 03:58:59 2003 +HDNIS01U_de.DLL A 165888 Sun May 4 03:58:59 2003 +HDNIS01U_de.HLP A 19770 Sun May 4 03:58:59 2003 +Hddm91c1_de_reg.HLP A 228417 Sun May 4 03:58:59 2003 + 40976 blocks of size 262144. 709 blocks available + +Current directory is \\SAMBA-CUPS\print$\W32X86\2\ +. D 0 Sun May 4 03:56:18 2003 +.. D 0 Sun May 4 03:56:35 2003 +ADOBEPS5.DLL A 434400 Sat May 3 23:18:45 2003 +laserjet4.ppd A 9639 Thu Apr 24 01:05:32 2003 +ADOBEPSU.DLL A 109568 Sat May 3 23:18:45 2003 +ADOBEPSU.HLP A 18082 Sat May 3 23:18:45 2003 +PDFcreator2.PPD A 15746 Sun Apr 20 22:24:07 2003 + 40976 blocks of size 262144. 709 blocks available </screen></para> <para> @@ -1952,7 +1861,7 @@ driver files belong. <para> So, next you must tell Samba about the special category of the files -you just uploaded into the <parameter>[print$]</parameter> share. This +you just uploaded into the <smbconfsection>[print$]</smbconfsection> share. This is done by the <command>adddriver</command> command. It will prompt Samba to register the driver files into its internal TDB database files. The following command and its output has been edited, @@ -1960,21 +1869,23 @@ again, for readability: </para> <para><screen> -&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'adddriver "Windows NT x86" "dm9110:HDNIS01_de.DLL: \ - Hddm91c1_de.ppd:HDNIS01U_de.DLL:HDNIS01U_de.HLP: \ - NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \ - Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre, \ - Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \ - HDNIS01Aux.dll,HDNIS01_de.NTF, \ - Hddm91c1_de_reg.HLP' SAMBA-CUPS</userinput> - - cmd = adddriver "Windows NT x86" "dm9110:HDNIS01_de.DLL:Hddm91c1_de.ppd:HDNIS01U_de.DLL: \ - HDNIS01U_de.HLP:NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \ - Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre, \ - Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \ - HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP" - - Printer Driver dm9110 successfully installed. + &rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'adddriver "Windows NT x86" \ +"dm9110:HDNIS01_de.DLL: \ +Hddm91c1_de.ppd:HDNIS01U_de.DLL:HDNIS01U_de.HLP: \ + NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \ + Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre, \ + Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \ + HDNIS01Aux.dll,HDNIS01_de.NTF, \ + Hddm91c1_de_reg.HLP' SAMBA-CUPS</userinput> + +cmd = adddriver "Windows NT x86" \ +"dm9110:HDNIS01_de.DLL:Hddm91c1_de.ppd:HDNIS01U_de.DLL: \ + HDNIS01U_de.HLP:NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \ + Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre, \ + Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \ + HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP" + +Printer Driver dm9110 successfully installed. </screen></para> @@ -2005,9 +1916,9 @@ subdirectory. You can check this again with </para> <para><screen> -&rootprompt;<userinput>smbclient //SAMBA-CUPS/print\$ -Uroot%xxxx -c 'cd W32X86;dir;pwd;cd 2;dir;pwd'</userinput> +&rootprompt;<userinput>smbclient //SAMBA-CUPS/print\$ -Uroot%xx -c 'cd W32X86;dir;pwd;cd 2;dir;pwd'</userinput> added interface ip=10.160.51.162 bcast=10.160.51.255 nmask=255.255.252.0 - Domain=[CUPS-PRINT] OS=[Unix] Server=[Samba 2.2.7a] + Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.7a] Current directory is \\SAMBA-CUPS\print$\W32X86\ . D 0 Sun May 4 04:32:48 2003 @@ -2101,7 +2012,7 @@ host and "xxxx" represents the actual Samba password assigned to root: <para> You will see a listing of all drivers Samba knows about. Your new one should be amongst them. But it is only listed under the <parameter>[Windows NT -x86]</parameter> heading, not under <parameter>[Windows 4.0]</parameter>, +x86]</parameter> heading, not under <smbconfsection>[Windows 4.0]</smbconfsection>, since we didn't install that part. Or did *you*? -- You will see a listing of all drivers Samba knows about. Your new one should be amongst them. In our example it is named <emphasis>dm9110</emphasis>. Note that the 3rd column @@ -2125,13 +2036,13 @@ with a different driver name, it will work the same: <para><screen> &rootprompt;<userinput>rpcclient -Uroot%xxxx \ - -c 'adddriver "Windows NT x86" \ - "myphantasydrivername:HDNIS01_de.DLL: \ - Hddm91c1_de.ppd:HDNIS01U_de.DLL:HDNIS01U_de.HLP: \ - NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \ - Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre, \ - Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \ - HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP' SAMBA-CUPS + -c 'adddriver "Windows NT x86" \ + "myphantasydrivername:HDNIS01_de.DLL: \ + Hddm91c1_de.ppd:HDNIS01U_de.DLL:HDNIS01U_de.HLP: \ + NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \ + Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre, \ + Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \ + HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP' SAMBA-CUPS </userinput> cmd = adddriver "Windows NT x86" @@ -2151,7 +2062,7 @@ you are responsible yourself that you associate drivers to queues which make sense to the target printer). Note, that you can't run the <command>rpcclient</command> <command>adddriver</command> command repeatedly. Each run "consumes" the files you had put into the -<parameter>[print$]</parameter> share by moving them into the +<smbconfsection>[print$]</smbconfsection> share by moving them into the respective subdirectories. So you <emphasis>must</emphasis> precede an <command>smbclient ... put</command> command before each <command>rpcclient ... adddriver</command>" command. @@ -2159,7 +2070,7 @@ respective subdirectories. So you <emphasis>must</emphasis> precede an </sect3> <sect3> -<title>La Grande Finale: Running <command>rpcclient</command> with +<title>Running <command>rpcclient</command> with <command>setdriver</command></title> <para> @@ -2207,8 +2118,7 @@ signal to all running smbd processes to work around this: </sect1> <sect1> -<title>"The Proof of the Pudding lies in the Eating" (Client Driver Install -Procedure)</title> +<title>Client Driver Install Procedure</title> <para> A famous philosopher said once: <quote>The Proof of the Pudding lies @@ -2227,7 +2137,7 @@ all further clients are easy to setup and shouldn't need further attention. What follows is a description for the recommended first procedure. You work now from a client workstation. First you should guarantee that your connection is not unwittingly mapped to -<parameter>bad user</parameter> "nobody". In a DOS box type: +<emphasis>bad user</emphasis> "nobody". In a DOS box type: </para> <para><userinput>net use \\<replaceable>SAMBA-SERVER</replaceable>\print$ /user:root</userinput></para> @@ -2330,13 +2240,13 @@ This can be achieved by accessing the drivers remotely from an NT (or <para> Be aware, that a valid Device Mode can only be initiated by a -<parameter>printer admin</parameter>, or root (the reason should be +<smbconfoption><name>printer admin</name></smbconfoption>, or root (the reason should be obvious). Device Modes can only correctly be set by executing the printer driver program itself. Since Samba can not execute this Win32 platform driver code, it sets this field initially to NULL (which is not a valid setting for clients to use). Fortunately, most drivers generate themselves the Printer Driver Data that is needed, when they -are uploaded to the <parameter>[print$]</parameter> share with the +are uploaded to the <smbconfsection>[print$]</smbconfsection> share with the help of the APW or rpcclient. </para> @@ -2447,10 +2357,10 @@ or in the <guimenuitem>Run command...</guimenuitem> field from the <para> After you installed the driver on the Samba server (in its -<parameter>[print$]</parameter> share, you should always make sure +<smbconfsection>[print$]</smbconfsection> share, you should always make sure that your first client installation completes correctly. Make it a habit for yourself to build that the very first connection from a client as -<parameter>printer admin</parameter>. This is to make sure that: +<smbconfoption><name>printer admin</name></smbconfoption>. This is to make sure that: </para> <itemizedlist> @@ -2477,7 +2387,10 @@ To connect as root to a Samba printer, try this command from a Windows 2K/XP DOS box command prompt: </para> -<para><userinput>runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry /p /t3 /n \\<replaceable>SAMBA-SERVER</replaceable>\<replaceable>printername</replaceable>"</userinput> +<para><screen> +&dosprompt;<userinput>runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry /p /t3 /n + \\<replaceable>SAMBA-SERVER</replaceable>\<replaceable>printername</replaceable>"</userinput> +</screen> </para> <para> @@ -2485,7 +2398,7 @@ You will be prompted for root's Samba-password; type it, wait a few seconds, click on <guibutton>Printing Defaults...</guibutton> and proceed to set the job options as should be used as defaults by all clients. Alternatively, instead of root you can name one other member -of the <parameter>printer admins</parameter> from the setting. +of the <smbconfoption><name>printer admin</name></smbconfoption> from the setting. </para> <para> @@ -2609,7 +2522,7 @@ either. However, only the last one, which you arrived at with steps C.1.-6. will permanently save any settings which will then become the defaults for new users. If you want all clients to have the same defaults, you need to conduct these steps as administrator -(<parameter>printer admin</parameter> in ) +(<smbconfoption><name>printer admin</name></smbconfoption> in ) <emphasis>before</emphasis> a client downloads the driver (the clients can later set their own <emphasis>per-user defaults</emphasis> by following the procedures <emphasis>A.</emphasis> @@ -2673,7 +2586,7 @@ clicking orgy alone, you need to think about a non-interactive script. If more than one printer is using the same driver, the <command>rpcclient setdriver</command> command can be used to set the driver associated with an installed queue. If the driver is uploaded -to <parameter>[print$]</parameter> once and registered with the +to <smbconfsection>[print$]</smbconfsection> once and registered with the printing TDBs, it can be used by multiple print queues. In this case you just need to repeat the <command>setprinter</command> subcommand of <command>rpcclient</command> for every queue (without the need to @@ -2715,7 +2628,8 @@ following is an example of how this could be accomplished: </screen> <screen> -&rootprompt;<userinput>rpcclient <replaceable>SAMBA-CUPS</replaceable> -U root%<replaceable>secret</replaceable> -c 'setdriver <replaceable>dm9110</replaceable> "<replaceable>Heidelberg Digimaster 9110 (PS)</replaceable>"'</userinput> +&rootprompt;<userinput>rpcclient <replaceable>SAMBA-CUPS</replaceable> -U root%<replaceable>secret</replaceable> -c \ + 'setdriver <replaceable>dm9110</replaceable> "<replaceable>Heidelberg Digimaster 9110 (PS)</replaceable>"'</userinput> cmd = setdriver dm9110 Heidelberg Digimaster 9110 (PPD) Successfully set dm9110 to driver Heidelberg Digimaster 9110 (PS). </screen> @@ -2725,7 +2639,8 @@ following is an example of how this could be accomplished: cmd = enumprinters flags:[0x800000] name:[\\SAMBA-CUPS\dm9110] - description:[\\SAMBA-CUPS\dm9110,Heidelberg Digimaster 9110 (PS),110ppm HiVolume DANKA Stuttgart] + description:[\\SAMBA-CUPS\dm9110,Heidelberg Digimaster 9110 (PS),\ + 110ppm HiVolume DANKA Stuttgart] comment:[110ppm HiVolume DANKA Stuttgart] [....] </screen> @@ -2741,7 +2656,8 @@ following is an example of how this could be accomplished: cmd = enumprinters flags:[0x800000] name:[\\SAMBA-CUPS\dm9110] - description:[\\SAMBA-CUPS\dm9110,myphantasydrivername,110ppm HiVolume DANKA Stuttgart] + description:[\\SAMBA-CUPS\dm9110,myphantasydrivername,\ + 110ppm HiVolume DANKA Stuttgart] comment:[110ppm HiVolume DANKA Stuttgart] [....] </screen></para> @@ -2771,7 +2687,7 @@ if: <itemizedlist> <listitem><para>...the connected user is able to successfully execute an <command>OpenPrinterEx(\\server)</command> with administrative -privileges (i.e. root or <parameter>printer admin</parameter>). +privileges (i.e. root or <smbconfoption><name>printer admin</name></smbconfoption>). </para> <tip><para> Try this from a Windows 2K/XP DOS box command prompt: @@ -2786,7 +2702,7 @@ and click on <guibutton>Printing Preferences...</guibutton> </para></tip></listitem> <listitem><para>... contains the setting -<parameter>show add printer wizard = yes</parameter> (the +<smbconfoption><name>show add printer wizard</name><value>yes</value></smbconfoption> (the default).</para></listitem> </itemizedlist> @@ -2796,7 +2712,7 @@ The APW can do various things: <itemizedlist> <listitem><para>upload a new driver to the Samba -<parameter>[print$]</parameter> share;</para></listitem> +<smbconfsection>[print$]</smbconfsection> share;</para></listitem> <listitem><para>associate an uploaded driver with an existing (but still "driverless") print queue;</para></listitem> @@ -2805,8 +2721,8 @@ still "driverless") print queue;</para></listitem> print queue with one that has been uploaded before;</para></listitem> <listitem><para>add an entirely new printer to the Samba host (only in -conjunction with a working <parameter>add printer command</parameter>; -a corresponding <parameter>delete printer command</parameter> for +conjunction with a working <smbconfoption><name>add printer command</name></smbconfoption>; +a corresponding <smbconfoption><name>delete printer command</name></smbconfoption> for removing entries from the <guiicon>Printers...</guiicon> folder may be provided too)</para></listitem> </itemizedlist> @@ -2814,9 +2730,9 @@ may be provided too)</para></listitem> <para> The last one (add a new printer) requires more effort than the previous ones. In order to use the APW to successfully add a printer -to a Samba server, the <parameter>add printer command</parameter> must +to a Samba server, the <smbconfoption><name>add printer command</name></smbconfoption> must have a defined value. The program hook must successfully add the -printer to the Unix print system (i.e. to +printer to the UNIX print system (i.e. to <filename>/etc/printcap</filename>, <filename>/etc/cups/printers.conf</filename> or other appropriate files) and to if necessary. @@ -2828,10 +2744,8 @@ exist, smbd will execute the <parameter>add printer command</parameter> and reparse to the to attempt to locate the new printer share. If the share is still not defined, an error of <errorname>Access Denied</errorname> is -returned to the client. Note that the <parameter>add printer -command</parameter> is executed under the context of the connected -user, not necessarily a root account. A <parameter>map to guest = bad -user</parameter> may have connected you unwittingly under the wrong +returned to the client. Note that the <smbconfoption><name>add printer command</name></smbconfoption> is executed under the context of the connected +user, not necessarily a root account. A <smbconfoption><name>map to guest</name><value>bad user</value></smbconfoption> may have connected you unwittingly under the wrong privilege; you should check it by using the <command>smbstatus</command> command. </para> @@ -3068,7 +2982,7 @@ multiple ports as a form of load balancing or fail over. If you require that multiple ports be defined for some reason or another (<quote>My users and my Boss should not know that they are working with Samba</quote>), possesses a -<parameter>enumports command</parameter> which can be used to define +<smbconfoption><name>enumports command</name></smbconfoption> which can be used to define an external program that generates a listing of ports on a system. </para> </sect2> @@ -3094,7 +3008,7 @@ Settings" in the CUPS Printing part of this document. The Imprints tool set provides a UNIX equivalent of the Windows NT Add Printer Wizard. For complete information, please refer to the Imprints web site -at<ulink url="http://imprints.sourceforge.net/">http://imprints.sourceforge.net/</ulink> +at <ulink noescape="1" url="http://imprints.sourceforge.net/">http://imprints.sourceforge.net/</ulink> as well as the documentation included with the imprints source distribution. This section will only provide a brief introduction to the features of Imprints. @@ -3298,14 +3212,6 @@ Here is a list of the used commandline parameters: </varlistentry> </variablelist> -<para> -I have tested this with a Samba 2.2.7a and a Samba-3alpha24 -installation and Windows XP Professional clients. Note that this -specific command set works with network print queues (installing -local print queues requires different parameters, but this is of no -interest here). -</para> - <itemizedlist> <listitem><para>Line 1 deletes a possibly existing previous network printer <emphasis>infotec2105-IPDS</emphasis> (which had used native @@ -3338,7 +3244,7 @@ on "sambacupsserver", and if the printer drivers have successfully been uploaded (via <command>APW</command> , <command>smbclient/rpcclient</command> or <command>cupsaddsmb</command>) into the -<parameter>[print$]</parameter> driver repository of Samba. Also, some +<smbconfsection>[print$]</smbconfsection> driver repository of Samba. Also, some Samba versions prior to version 3.0 required a re-start of smbd after the printer install and the driver upload, otherwise the script (or any other client driver download) would fail. @@ -3392,7 +3298,7 @@ create a new printer on Samba and the UNIX print subsystem! </sect1> <sect1> -<title>Migration of "Classical" printing to Samba-3</title> +<title>Migration of "Classical" printing to Samba</title> <para> The basic "NT-style" printer driver management has not changed @@ -3408,9 +3314,9 @@ possible scenarios for migration: <itemizedlist> <listitem><para>You need to study and apply the new Windows NT printer -and driver support. Previously used parameters "<parameter>printer -driver file</parameter>", " <parameter>printer driver</parameter>" and -"<parameter>printer driver location</parameter>" are no longer +and driver support. Previously used parameters <parameter>printer +driver file</parameter>, <parameter>printer driver</parameter> and +<parameter>printer driver location</parameter> are no longer supported.</para></listitem> <listitem><para>If you want to take advantage of WinNT printer driver @@ -3418,19 +3324,18 @@ support you also need to migrate the Win9x/ME drivers to the new setup.</para></listitem> <listitem><para>An existing <filename>printers.def</filename> file -(the one specified in the now removed parameter <parameter>printer -driver file = ...</parameter>) will work no longer with Samba-3.0. In + (the one specified in the now removed parameter <parameter>printer driver file</parameter>) will work no longer with samba 3. In 3.0, smbd attempts to locate a Win9x/ME driver files for the printer -in <parameter>[print$]</parameter> and additional settings in the TDB +in <smbconfsection>[print$]</smbconfsection> and additional settings in the TDB and only there; if it fails it will <emphasis>not</emphasis> (as 2.2.x used to do) drop down to using a <filename>printers.def</filename> (and all associated parameters). The make_printerdef tool is removed and there is no backwards compatibility for this.</para></listitem> <listitem><para>You need to install a Windows 9x driver into the -<parameter>[print$]</parameter> share for a printer on your Samba +<smbconfsection>[print$]</smbconfsection> share for a printer on your Samba host. The driver files will be stored in the "WIN40/0" subdirectory of -<parameter>[print$]</parameter>, and some other settings and info go +<smbconfsection>[print$]</smbconfsection>, and some other settings and info go into the printing-related TDBs.</para></listitem> <listitem><para>If you want to migrate an existing @@ -3441,7 +3346,7 @@ rpcclient. See the Imprints installation client at: </para> <para> -<ulink url="http://imprints.sourceforge.net/"><emphasis>http://imprints.sourceforge.net/</emphasis></ulink> + <ulink noescape="1" url="http://imprints.sourceforge.net/">http://imprints.sourceforge.net/</ulink> </para> <para> @@ -3459,18 +3364,13 @@ We will publish an update to this section shortly. </sect1> <sect1> -<title>Common Errors and Problems</title> - -<para> -Here are a few typical errors and problems people have -encountered. You can avoid them. Read on. -</para> +<title>Common Errors</title> <sect2> <title>I give my root password but I don't get access</title> <para> -Don't confuse the root password which is valid for the Unix system +Don't confuse the root password which is valid for the UNIX system (and in most cases stored in the form of a one-way hash in a file named <filename>/etc/shadow</filename>) with the password used to authenticate against Samba!. Samba doesn't know the UNIX password; for @@ -3484,7 +3384,7 @@ for root must be created first. This is often done with the <title>My printjobs get spooled into the spooling directory, but then get lost</title> <para> -Don't use the existing Unix print system spool directory for the Samba +Don't use the existing UNIX print system spool directory for the Samba spool directory. It may seem convenient and a saving of space, but it only leads to problems. The two <emphasis>must</emphasis> be separate. </para> diff --git a/docs/docbook/projdoc/samba-doc.xml b/docs/docbook/projdoc/samba-doc.xml index 91002c9133..a04ab6adee 100644 --- a/docs/docbook/projdoc/samba-doc.xml +++ b/docs/docbook/projdoc/samba-doc.xml @@ -39,23 +39,22 @@ application knowledge that is most to be desired by many Samba users and adminis </para> </abstract> -<legalnotice> +</bookinfo> + +<preface> + <title>Legal Notice</title> <para> This documentation is distributed under the GNU General Public License (GPL) version 2. A copy of the license is included with the Samba source distribution. A copy can be found on-line at <ulink url="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</ulink> </para> +</preface> -<formalpara> +<preface> <title>Attributions</title> - <para> &attributions; - </para> -</formalpara> - -</legalnotice> -</bookinfo> +</preface> <!-- Contents --> <toc/> @@ -131,15 +130,16 @@ Samba has several features that you might want or might not want to use. The cha <part id="troubleshooting"> <title>Troubleshooting</title> + &Diagnosis; &problems; &BUGS; </part> <part id="Appendixes"> -<title>Appendixes</title> + <title>Appendixes</title> &Compiling; -&Portability; + &Portability; &Other-Clients; &SPEED; &DNS-DHCP-Configuration; diff --git a/docs/docbook/projdoc/securing-samba.xml b/docs/docbook/projdoc/securing-samba.xml index bed4e4ee56..d59b0f381e 100644 --- a/docs/docbook/projdoc/securing-samba.xml +++ b/docs/docbook/projdoc/securing-samba.xml @@ -49,8 +49,8 @@ Samba may be secured from connections that originate from outside the local netw done using <emphasis>host based protection</emphasis> (using samba's implementation of a technology known as "tcpwrappers", or it may be done be using <emphasis>interface based exclusion</emphasis> so that &smbd; will bind only to specifically permitted interfaces. It is also -possible to set specific share or resource based exclusions, eg: on the <parameter>IPC$</parameter> -auto-share. The <parameter>IPC$</parameter> share is used for browsing purposes as well as to establish +possible to set specific share or resource based exclusions, eg: on the <smbconfsection>[IPC$]</smbconfsection> +auto-share. The <smbconfsection>[IPC$]</smbconfsection> share is used for browsing purposes as well as to establish TCP/IP connections. </para> @@ -85,16 +85,16 @@ before someone will find yet another vulnerability. </para> <para> - One of the simplest fixes in this case is to use the <parameter>hosts allow</parameter> and - <parameter>hosts deny</parameter> options in the Samba &smb.conf; configuration file to only + One of the simplest fixes in this case is to use the <smbconfoption><name>hosts allow</name></smbconfoption> and + <smbconfoption><name>hosts deny</name></smbconfoption> options in the Samba &smb.conf; configuration file to only allow access to your server from a specific range of hosts. An example might be: </para> - <para><programlisting> - hosts allow = 127.0.0.1 192.168.2.0/24 192.168.3.0/24 - hosts deny = 0.0.0.0/0 - </programlisting></para> + <para><smbconfblock> +<smbconfoption><name>hosts allow</name><value>127.0.0.1 192.168.2.0/24 192.168.3.0/24</value></smbconfoption> +<smbconfoption><name>hosts deny</name><value>0.0.0.0/0</value></smbconfoption> + </smbconfblock></para> <para> The above will only allow SMB connections from 'localhost' (your own @@ -111,12 +111,12 @@ before someone will find yet another vulnerability. <para> If you want to restrict access to your server to valid users only then the following - method may be of use. In the &smb.conf; <parameter>[globals]</parameter> section put: + method may be of use. In the &smb.conf; <smbconfsection>[global]</smbconfsection> section put: </para> - <para><programlisting> - valid users = @smbusers, jacko - </programlisting></para> + <para><smbconfblock> +<smbconfoption><name>valid users</name><value>@smbusers, jacko</value></smbconfoption> + </smbconfblock></para> <para> What this does is, it restricts all server access to either the user <emphasis>jacko</emphasis> @@ -140,10 +140,10 @@ before someone will find yet another vulnerability. You can change this behaviour using options like the following: </para> - <para><programlisting> - interfaces = eth* lo - bind interfaces only = yes - </programlisting></para> + <para><smbconfblock> +<smbconfoption><name>interfaces</name><value>eth* lo</value></smbconfoption> +<smbconfoption><name>bind interfaces only</name><value>yes</value></smbconfoption> + </smbconfblock></para> <para> This tells Samba to only listen for connections on interfaces with a @@ -209,11 +209,11 @@ before someone will find yet another vulnerability. To do that you could use: </para> - <para><programlisting> -[ipc$] - hosts allow = 192.168.115.0/24 127.0.0.1 - hosts deny = 0.0.0.0/0 - </programlisting></para> + <para><smbconfblock> +<smbconfsection>[ipc$]</smbconfsection> +<smbconfoption><name>hosts allow</name><value>192.168.115.0/24 127.0.0.1</value></smbconfoption> +<smbconfoption><name>hosts deny</name><value>0.0.0.0/0</value></smbconfoption> + </smbconfblock></para> <para> this would tell Samba that IPC$ connections are not allowed from @@ -245,23 +245,30 @@ before someone will find yet another vulnerability. To configure NTLMv2 authentication the following registry keys are worth knowing about: </para> - <!-- FIXME --> <para> - <screen> + <screen> [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa] "lmcompatibilitylevel"=dword:00000003 + </screen> + </para> + <para> 0x3 - Send NTLMv2 response only. Clients will use NTLMv2 authentication, use NTLMv2 session security if the server supports it. Domain controllers accept LM, NTLM and NTLMv2 authentication. + </para> + <para> + <screen> [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\MSV1_0] "NtlmMinClientSec"=dword:00080000 + </screen> + </para> + <para> 0x80000 - NTLMv2 session security. If either NtlmMinClientSec or NtlmMinServerSec is set to 0x80000, the connection will fail if NTLMv2 session security is not negotiated. - </screen> </para> </sect2> </sect1> @@ -270,10 +277,10 @@ before someone will find yet another vulnerability. <title>Upgrading Samba</title> <para> -Please check regularly on <ulink url="http://www.samba.org/">http://www.samba.org/</ulink> for updates and +Please check regularly on <ulink noescape="1" url="http://www.samba.org/">http://www.samba.org/</ulink> for updates and important announcements. Occasionally security releases are made and it is highly recommended to upgrade Samba when a security vulnerability -is discovered. +is discovered. Check with your OS vendor for OS specific upgrades. </para> </sect1> @@ -346,21 +353,21 @@ out to be a security problem request are totally convinced that the problem is w <para> Samba does allow the setup you require when you have set the - <parameter>only user = yes</parameter> option on the share, is that you have not set the + <smbconfoption><name>only user</name><value>yes</value></smbconfoption> option on the share, is that you have not set the valid users list for the share. </para> <para> Note that only user works in conjunction with the users= list, so to get the behavior you require, add the line : - <programlisting> - users = %S - </programlisting> + <smbconfblock> +<smbconfoption><name>users</name><value>%S</value></smbconfoption> +</smbconfblock> this is equivalent to: - <programlisting> - valid users = %S - </programlisting> - to the definition of the <parameter>[homes]</parameter> share, as recommended in + <smbconfblock> +<smbconfoption><name>valid users</name><value>%S</value></smbconfoption> + </smbconfblock> + to the definition of the <smbconfsection>[homes]</smbconfsection> share, as recommended in the &smb.conf; man page. </para> </sect2> diff --git a/docs/docbook/projdoc/unicode.xml b/docs/docbook/projdoc/unicode.xml index d24ec4b5cd..28d6f76cdf 100644 --- a/docs/docbook/projdoc/unicode.xml +++ b/docs/docbook/projdoc/unicode.xml @@ -25,9 +25,8 @@ origin. <para> Of all the effort that has been brought to bear on providing native language support -for all computer users, the efforts of the Openi18n organisation is deserving of -special mention. For more information about Openi18n please refer to: -<link url="http://www.openi18n.org/">http://www.openi18n.org/</link>. +for all computer users, the efforts of the <ulink url="http://www.openi18n.org/">Openi18n organisation</ulink> is deserving of +special mention. </para> <para> @@ -62,17 +61,16 @@ store one character). </para> <para> -A standardised multibyte charset is unicode, info is available at -<ulink url="http://www.unicode.org/">www.unicode.org</ulink>. -A big advantage of using a multibyte charset is that you only need one; no -need to make sure two computers use the same charset when they are + A standardised multibyte charset is <ulink url="http://www.unicode.org/">unicode</ulink>. +A big advantage of using a multibyte charset is that you only need one; there +is no need to make sure two computers use the same charset when they are communicating. </para> -<para>Old windows clients used to use single-byte charsets, named +<para>Old windows clients use single-byte charsets, named 'codepages' by Microsoft. However, there is no support for negotiating the charset to be used in the smb protocol. Thus, you -have to make sure you are using the same charset when talking to an old client. +have to make sure you are using the same charset when talking to an older client. Newer clients (Windows NT, 2K, XP) talk unicode over the wire. </para> </sect1> @@ -87,23 +85,23 @@ samba knows of three kinds of character sets: <variablelist> <varlistentry> - <term><parameter>unix charset</parameter></term> + <term><smbconfoption><name>unix charset</name></smbconfoption></term> <listitem><para> This is the charset used internally by your operating system. - The default is <constant>ASCII</constant>, which is fine for most - systems. + The default is <constant>UTF-8</constant>, which is fine for most + systems. The default in previous samba releases was <constant>ASCII</constant>. </para></listitem> </varlistentry> <varlistentry> - <term><parameter>display charset</parameter></term> + <term><smbconfoption><name>display charset</name></smbconfoption></term> <listitem><para>This is the charset samba will use to print messages on your screen. It should generally be the same as the <command>unix charset</command>. </para></listitem> </varlistentry> <varlistentry> - <term><parameter>dos charset</parameter></term> + <term><smbconfoption><name>dos charset</name></smbconfoption></term> <listitem><para>This is the charset samba uses when communicating with DOS and Windows 9x clients. It will talk unicode to all newer clients. The default depends on the charsets you have installed on your system. @@ -122,14 +120,10 @@ samba knows of three kinds of character sets: characters in filenames are usually not correct in the unix charset but only for the local charset used by the DOS/Windows clients.</para> -<para>The following script from Steve Langasek converts all -filenames from CP850 to the iso8859-15 charset.</para> - -<para> -<prompt>#</prompt><userinput>find <replaceable>/path/to/share</replaceable> -type f -exec bash -c 'CP="{}"; ISO=`echo -n "$CP" | iconv -f cp850 \ - -t iso8859-15`; if [ "$CP" != "$ISO" ]; then mv "$CP" "$ISO"; fi' \; -</userinput> +<para>Bjoern Jacke has written a utility named <ulink url="http://j3e.de/linux/convmv/">convm</ulink> that can convert whole directory + structures to different charsets with one single command. </para> + </sect1> <sect1> @@ -140,29 +134,41 @@ points of attention when setting it up:</para> <itemizedlist> -<listitem><para>You should set <parameter>mangling method = -hash</parameter></para></listitem> + <listitem><para>You should set <smbconfoption><name>mangling method</name><value>hash</value></smbconfoption></para></listitem> <listitem><para>There are various iconv() implementations around and not all of them work equally well. glibc2's iconv() has a critical problem in CP932. libiconv-1.8 works with CP932 but still has some problems and does not work with EUC-JP.</para></listitem> -<listitem><para>You should set <parameter>dos charset = CP932</parameter>, not +<listitem><para>You should set <smbconfoption><name>dos charset</name><value>CP932</value></smbconfoption>, not Shift_JIS, SJIS...</para></listitem> -<listitem><para>Currently only <parameter>unix charset = CP932</parameter> +<listitem><para>Currently only <smbconfoption><name>unix charset</name><value>CP932</value></smbconfoption> will work (but still has some problems...) because of iconv() issues. -<parameter>unix charset = EUC-JP</parameter> doesn't work well because of +<smbconfoption><name>unix charset</name><value>EUC-JP</value></smbconfoption> doesn't work well because of iconv() issues.</para></listitem> -<listitem><para>Currently Samba 3.0 does not support <parameter>unix charset -= UTF8-MAC/CAP/HEX/JIS*</parameter></para></listitem> +<listitem><para>Currently Samba 3.0 does not support <smbconfoption><name>unix charset</name><value>UTF8-MAC/CAP/HEX/JIS*</value></smbconfoption></para></listitem> </itemizedlist> -<para>More information (in Japanese) is available at: <ulink url="http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html">http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html</ulink>.</para> +<para>More information (in Japanese) is available at: <ulink noescape="1" url="http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html">http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html</ulink>.</para> + +</sect1> + +<sect1> + <title>Common errors</title> + + <sect2> + <title>CP850.so can't be found</title> + + <para><quote>Samba is complaining about a missing <filename>CP850.so</filename> file</quote>.</para> + + <para>CP850 is the default <smbconfoption><name>dos charset</name></smbconfoption>. The <smbconfoption><name>dos charset</name></smbconfoption> is used to convert data to the codepage used by your dos clients. If you don't have any dos clients, you can safely ignore this message. </para> + <para>CP850 should be supported by your local iconv implementation. Make sure you have all the required packages installed. If you compiled samba from source, make sure configure found iconv.</para> + </sect2> </sect1> </chapter> diff --git a/docs/docbook/projdoc/upgrading-to-3.0.xml b/docs/docbook/projdoc/upgrading-to-3.0.xml index b4c0732a65..74af0cbb9e 100644 --- a/docs/docbook/projdoc/upgrading-to-3.0.xml +++ b/docs/docbook/projdoc/upgrading-to-3.0.xml @@ -1,63 +1,571 @@ <chapter id="upgrading-to-3.0"> <chapterinfo> &author.jelmer; - <pubdate>25 October 2002</pubdate> + &author.jht; + &author.jerry; + <pubdate>June 30, 2003</pubdate> </chapterinfo> <title>Upgrading from Samba-2.x to Samba-3.0.0</title> + <sect1> -<title>Charsets</title> +<title>New Features in Samba-3</title> -<para>You might experience problems with special characters -when communicating with old DOS clients. Codepage -support has changed in samba 3.0. Read the chapter -<link linkend="unicode">Unicode support</link> for details. +<para> +Major new features: </para> -</sect1> +<orderedlist> + <listitem><para> + Active Directory support. This release is able to join a ADS realm + as a member server and authenticate users using LDAP/kerberos. + </para></listitem> -<sect1> -<title>Obsolete configuration options</title> + <listitem><para> + Unicode support. Samba will now negotiate UNICODE on the wire and + internally there is now a much better infrastructure for multi-byte + and UNICODE character sets. + </para></listitem> + + <listitem><para> + New authentication system. The internal authentication system has + been almost completely rewritten. Most of the changes are internal, + but the new auth system is also very configurable. + </para></listitem> + + <listitem><para> + New filename mangling system. The filename mangling system has been + completely rewritten. An internal database now stores mangling maps + persistently. This needs lots of testing. + </para></listitem> + + <listitem><para> + New "net" command. A new "net" command has been added. It is + somewhat similar to the "net" command in windows. Eventually we + plan to replace a bunch of other utilities (such as smbpasswd) + with subcommands in "net", at the moment only a few things are + implemented. + </para></listitem> + + <listitem><para> + Samba now negotiates NT-style status32 codes on the wire. This + improves error handling a lot. + </para></listitem> + + <listitem><para> + Better Windows 2000/XP/2003 printing support including publishing + printer attributes in active directory + </para></listitem> + + <listitem><para> + New loadable RPC modules + </para></listitem> + + <listitem><para> + New dual-daemon winbindd support (-B) for better performance + </para></listitem> + + <listitem><para> + Support for migrating from a Windows NT 4.0 domain to a Samba + domain and maintaining user, group and domain SIDs + </para></listitem> + + <listitem><para> + Support for establishing trust relationships with Windows NT 4.0 + domain controllers + </para></listitem> + <listitem><para> + Initial support for a distributed Winbind architecture using + an LDAP directory for storing SID to uid/gid mappings + </para></listitem> + + <listitem><para> + Major updates to the Samba documentation tree. + </para></listitem> +</orderedlist> <para> -In 3.0, the following configuration options have been removed. +Plus lots of other improvements! </para> -<simplelist> -<member>printer driver (replaced by new driver procedures) </member> -<member>printer driver file (replaced by new driver procedures)</member> -<member>printer driver location (replaced by new driver procedures)</member> -<member>use rhosts</member> -<member>postscript</member> -<member>client code page (replaced by dos charset)</member> -<member>vfs path</member> -<member>vfs options</member> -</simplelist> </sect1> <sect1> -<title>Password Backend</title> +<title>Configuration Parameter Changes</title> <para> -Effective with the release of samba-3 it is now imperative that the password backend -be correctly defined in smb.conf. +This section contains a brief listing of changes to smb.conf options +in the 3.0.0 release. Please refer to the smb.conf(5) man page for +complete descriptions of new or modified parameters. </para> -<para> -Those migrating from samba-2.x with plaintext password support need the following: -<emphasis>passdb backend = guest</emphasis>. -</para> +<sect2> +<title>Removed Parameters</title> -<para> -Those migrating from samba-2.x with encrypted password support should add to smb.conf -<emphasis>passdb backend = smbpasswd, guest</emphasis>. -</para> +<para>(order alphabetically):</para> -<para> -LDAP using Samba-2.x systems can continue to operate with the following entry -<emphasis>passdb backend = ldapsam_compat, guest</emphasis>. -</para> +<itemizedlist> + <listitem><para>admin log </para></listitem> + <listitem><para>alternate permissions </para></listitem> + <listitem><para>character set </para></listitem> + <listitem><para>client codepage </para></listitem> + <listitem><para>code page directory </para></listitem> + <listitem><para>coding system </para></listitem> + <listitem><para>domain admin group </para></listitem> + <listitem><para>domain guest group </para></listitem> + <listitem><para>force unknown acl user </para></listitem> + <listitem><para>nt smb support </para></listitem> + <listitem><para>post script </para></listitem> + <listitem><para>printer driver </para></listitem> + <listitem><para>printer driver file </para></listitem> + <listitem><para>printer driver location </para></listitem> + <listitem><para>status </para></listitem> + <listitem><para>total print jobs </para></listitem> + <listitem><para>use rhosts </para></listitem> + <listitem><para>valid chars </para></listitem> + <listitem><para>vfs options </para></listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>New Parameters</title> + +<para>(new parameters have been grouped by function):</para> + +<para>Remote management</para> + +<itemizedlist> + <listitem><para>abort shutdown script </para></listitem> + <listitem><para>shutdown script </para></listitem> +</itemizedlist> + +<para>User and Group Account Management</para> + +<itemizedlist> + <listitem><para>add group script </para></listitem> + <listitem><para>add machine script </para></listitem> + <listitem><para>add user to group script </para></listitem> + <listitem><para>algorithmic rid base </para></listitem> + <listitem><para>delete group script </para></listitem> + <listitem><para>delete user from group script </para></listitem> + <listitem><para>passdb backend </para></listitem> + <listitem><para>set primary group script </para></listitem> +</itemizedlist> + +<para>Authentication</para> + +<itemizedlist> + <listitem><para>auth methods </para></listitem> + <listitem><para>ads server </para></listitem> + <listitem><para>realm </para></listitem> +</itemizedlist> + +<para>Protocol Options</para> + +<itemizedlist> + <listitem><para>client lanman auth </para></listitem> + <listitem><para>client NTLMv2 auth </para></listitem> + <listitem><para>client schannel </para></listitem> + <listitem><para>client signing </para></listitem> + <listitem><para>client use spnego </para></listitem> + <listitem><para>disable netbios </para></listitem> + <listitem><para>ntlm auth </para></listitem> + <listitem><para>paranoid server security </para></listitem> + <listitem><para>server schannel </para></listitem> + <listitem><para>smb ports </para></listitem> + <listitem><para>use spnego </para></listitem> +</itemizedlist> + +<para>File Service</para> + +<itemizedlist> + <listitem><para>get quota command </para></listitem> + <listitem><para>hide special files </para></listitem> + <listitem><para>hide unwriteable files </para></listitem> + <listitem><para>hostname lookups </para></listitem> + <listitem><para>kernel change notify </para></listitem> + <listitem><para>mangle prefix </para></listitem> + <listitem><para>msdfs proxy </para></listitem> + <listitem><para>set quota command </para></listitem> + <listitem><para>use sendfile </para></listitem> + <listitem><para>vfs objects </para></listitem> +</itemizedlist> + +<para>Printing</para> + +<itemizedlist> + <listitem><para>max reported print jobs </para></listitem> +</itemizedlist> + + +<para>UNICODE and Character Sets</para> + +<itemizedlist> + <listitem><para>display charset </para></listitem> + <listitem><para>dos charset </para></listitem> + <listitem><para>unicode </para></listitem> + <listitem><para>unix charset </para></listitem> +</itemizedlist> + +<para>SID to uid/gid Mappings</para> + +<itemizedlist> + <listitem><para>idmap backend </para></listitem> + <listitem><para>idmap gid </para></listitem> + <listitem><para>idmap only </para></listitem> + <listitem><para>idmap uid </para></listitem> +</itemizedlist> + +<para>LDAP</para> + +<itemizedlist> + <listitem><para>ldap delete dn </para></listitem> + <listitem><para>ldap group suffix </para></listitem> + <listitem><para>ldap idmap suffix </para></listitem> + <listitem><para>ldap machine suffix </para></listitem> + <listitem><para>ldap passwd sync </para></listitem> + <listitem><para>ldap trust ids </para></listitem> + <listitem><para>ldap user suffix </para></listitem> +</itemizedlist> + +<para>General Configuration</para> + +<itemizedlist> + <listitem><para>preload modules </para></listitem> + <listitem><para>privatedir </para></listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>Modified Parameters (changes in behavior):</title> + +<itemizedlist> + <listitem><para>encrypt passwords (enabled by default) </para></listitem> + <listitem><para>mangling method (set to 'hash2' by default) </para></listitem> + <listitem><para>passwd chat </para></listitem> + <listitem><para>passwd program </para></listitem> + <listitem><para>restrict anonymous (integer value) </para></listitem> + <listitem><para>security (new 'ads' value) </para></listitem> + <listitem><para>strict locking (enabled by default) </para></listitem> + <listitem><para>winbind cache time (increased to 5 minutes) </para></listitem> + <listitem><para>winbind uid (deprecated in favor of 'idmap uid') </para></listitem> + <listitem><para>winbind gid (deprecated in favor of 'idmap gid') </para></listitem> +</itemizedlist> + +</sect2> + +</sect1> + +<sect1> +<title>New Functionality</title> + + <sect2> + <title>Databases</title> + + <para> + This section contains brief descriptions of any new databases + introduced in Samba 3.0. Please remember to backup your existing + ${lock directory}/*tdb before upgrading to Samba 3.0. Samba will + upgrade databases as they are opened (if necessary), but downgrading + from 3.0 to 2.2 is an unsupported path. + </para> + + + <table frame='all'><title>TDB File Descriptions</title> + <tgroup cols='3'> + <colspec align="left"/> + <colspec align="justify"/> + <colspec align="left"/> + <thead> + <row> + <entry align="left">Name</entry> + <entry align="justify">Description</entry> + <entry align="center">Backup?</entry> + </row> + </thead> + <tbody> + <row> + <entry>account_policy</entry> + <entry>User policy settings</entry> + <entry>yes</entry> + </row> + <row> + <entry>gencache</entry> + <entry>Generic caching db</entry> + <entry>no</entry> + </row> + <row> + <entry>group_mapping</entry> + <entry><para>Mapping table from Windows groups/SID to unix groups</para></entry> + <entry>yes</entry> + </row> + <row> + <entry>idmap</entry> + <entry><para>new ID map table from SIDS to UNIX uids/gids</para></entry> + <entry>yes</entry> + </row> + <row> + <entry>namecache</entry> + <entry>Name resolution cache entries</entry> + <entry>no</entry> + </row> + <row> + <entry>netlogon_unigrp</entry> + <entry><para>Cache of universal group membership obtained when operating + as a member of a Windows domain</para></entry> + <entry>no</entry> + </row> + <row> + <entry>printing/*.tdb</entry> + <entry><para>Cached output from 'lpq command' created on a per print + service basis</para></entry> + <entry>no</entry> + </row> + <row> + + <entry>registry</entry> + <entry><para>Read-only samba registry skeleton that provides support for + exporting various db tables via the winreg RPCs</para></entry> + <entry>no</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2> + <title>Changes in Behavior</title> + + <para> + The following issues are known changes in behavior between Samba 2.2 and + Samba 3.0 that may affect certain installations of Samba. + </para> + + <orderedlist> + <listitem><para> + When operating as a member of a Windows domain, Samba 2.2 would + map any users authenticated by the remote DC to the 'guest account' + if a uid could not be obtained via the getpwnam() call. Samba 3.0 + rejects the connection as NT_STATUS_LOGON_FAILURE. There is no + current work around to re-establish the 2.2 behavior. + </para></listitem> + + <listitem><para> + When adding machines to a Samba 2.2 controlled domain, the + 'add user script' was used to create the UNIX identity of the + machine trust account. Samba 3.0 introduces a new 'add machine + script' that must be specified for this purpose. Samba 3.0 will + not fall back to using the 'add user script' in the absence of + an 'add machine script' + </para></listitem> + </orderedlist> + + </sect2> + + <sect2> + <title>Charsets</title> + + <para> + You might experience problems with special characters when communicating with old DOS + clients. Codepage support has changed in samba 3.0. Read the chapter + <link linkend="unicode">Unicode support</link> for details. + </para> + + </sect2> + + <sect2> + <title>Passdb Backends and Authentication</title> + + <para> + There have been a few new changes that Samba administrators should be + aware of when moving to Samba 3.0. + </para> + + <orderedlist> + <listitem><para> + Encrypted passwords have been enabled by default in order to + inter-operate better with out-of-the-box Windows client + installations. This does mean that either (a) a samba account + must be created for each user, or (b) 'encrypt passwords = no' + must be explicitly defined in smb.conf. + </para></listitem> + + <listitem><para> + Inclusion of new <smbconfoption><name>security</name><value>ads</value></smbconfoption> option for integration + with an Active Directory domain using the native Windows + Kerberos 5 and LDAP protocols. + </para></listitem> + </orderedlist> + + <para> + Samba 3.0 also includes the possibility of setting up chains + of authentication methods + (<smbconfoption><name>auth methods</name></smbconfoption>) and account + storage backends + (<smbconfoption><name>passdb backend</name></smbconfoption>). + Please refer to the &smb.conf; + man page and <link linkend="passdb">the chapter about account information databases</link> for details. While both parameters assume sane default + values, it is likely that you will need to understand what the + values actually mean in order to ensure Samba operates correctly. + </para> + + <para> + Certain functions of the smbpasswd(8) tool have been split between the + new smbpasswd(8) utility, the net(8) tool, and the new pdbedit(8) + utility. See the respective man pages for details. + </para> + + </sect2> + + <sect2> + <title>Charsets</title> + + <para> + You might experience problems with special characters when communicating with old DOS + clients. Codepage support has changed in samba 3.0. Read the chapter + <link linkend="unicode">Unicode support</link> for details. + </para> + + </sect2> + + <sect2> + <title>LDAP</title> + + <para> + This section outlines the new features affecting Samba / LDAP integration. + </para> + + <sect3> + <title>New Schema</title> + + <para> + A new object class (sambaSamAccount) has been introduced to replace + the old sambaAccount. This change aids us in the renaming of attributes + to prevent clashes with attributes from other vendors. There is a + conversion script (examples/LDAP/convertSambaAccount) to modify and LDIF + file to the new schema. + </para> + + <para> + Example: + </para> + <para><screen> + &prompt;ldapsearch .... -b "ou=people,dc=..." > old.ldif + &prompt;convertSambaAccount <DOM SID> old.ldif new.ldif + </screen></para> + + <para> + The <DOM SID> can be obtained by running 'net getlocalsid <DOMAINNAME> + on the Samba PDC as root. + </para> + + <para> + The old sambaAccount schema may still be used by specifying the + "ldapsam_compat" passdb backend. However, the sambaAccount and + associated attributes have been moved to the historical section of + the schema file and must be uncommented before use if needed. + The 2.2 object class declaration for a sambaAccount has not changed + in the 3.0 samba.schema file. + </para> + + <para> + Other new object classes and their uses include: + </para> + + <itemizedlist> + <listitem><para> + sambaDomain - domain information used to allocate rids + for users and groups as necessary. The attributes are added + in 'ldap suffix' directory entry automatically if + an idmap uid/gid range has been set and the 'ldapsam' + passdb backend has been selected. + </para></listitem> + + <listitem><para> + sambaGroupMapping - an object representing the + relationship between a posixGroup and a Windows + group/SID. These entries are stored in the 'ldap + group suffix' and managed by the 'net groupmap' command. + </para></listitem> + + <listitem><para> + sambaUnixIdPool - created in the 'ldap idmap suffix' entry + automatically and contains the next available 'idmap uid' and + 'idmap gid' + </para></listitem> + + <listitem><para> + sambaIdmapEntry - object storing a mapping between a + SID and a UNIX uid/gid. These objects are created by the + idmap_ldap module as needed. + </para></listitem> + </itemizedlist> + + </sect3> + + <sect3> + <title>New Suffix for Searching</title> + + <para> + The following new smb.conf parameters have been added to aid in directing + certain LDAP queries when 'passdb backend = ldapsam://...' has been + specified. + </para> + + <itemizedlist> + <listitem><para>ldap suffix - used to search for user and computer accounts</para></listitem> + <listitem><para>ldap user suffix - used to store user accounts</para></listitem> + <listitem><para>ldap machine suffix - used to store machine trust accounts</para></listitem> + <listitem><para>ldap group suffix - location of posixGroup/sambaGroupMapping entries</para></listitem> + <listitem><para>ldap idmap suffix - location of sambaIdmapEntry objects</para></listitem> + </itemizedlist> + + <para> + If an 'ldap suffix' is defined, it will be appended to all of the + remaining sub-suffix parameters. In this case, the order of the suffix + listings in smb.conf is important. Always place the 'ldap suffix' first + in the list. + </para> + + <para> + Due to a limitation in Samba's smb.conf parsing, you should not surround + the DN's with quotation marks. + </para> + + </sect3> + + <sect3> + <title>IdMap LDAP support</title> + + <para> + Samba 3.0 supports an ldap backend for the idmap subsystem. The + following options would inform Samba that the idmap table should be + stored on the directory server onterose in the "ou=idmap,dc=plainjoe, + dc=org" partition. + </para> + + <smbconfblock> + <smbconfsection>[global]</smbconfsection> + <member>...</member> + <smbconfoption><name>idmap backend</name><value>ldap:ldap://onterose/</value></smbconfoption> + <smbconfoption><name>ldap idmap suffix</name><value>ou=idmap,dc=plainjoe,dc=org</value></smbconfoption> + <smbconfoption><name>idmap uid</name><value>40000-50000</value></smbconfoption> + <smbconfoption><name>idmap gid</name><value>40000-50000</value></smbconfoption> + </smbconfblock> + + <para> + This configuration allows winbind installations on multiple servers to + share a uid/gid number space, thus avoiding the interoperability problems + with NFS that were present in Samba 2.2. + </para> + + </sect3> + + </sect2> </sect1> diff --git a/docs/docbook/projdoc/winbind.xml b/docs/docbook/projdoc/winbind.xml index 524f05ffa2..001b2f16c1 100644 --- a/docs/docbook/projdoc/winbind.xml +++ b/docs/docbook/projdoc/winbind.xml @@ -6,7 +6,7 @@ <firstname>Tim</firstname><surname>Potter</surname> <affiliation> <orgname>Samba Team</orgname> - <address><email>tpot@samba.org</email></address> + <address><email>tpot@linuxcare.com.au</email></address> </affiliation> </author> &author.tridge; @@ -15,29 +15,87 @@ <affiliation> <address><email>getnag@rediffmail.com</email></address> </affiliation> + <contrib>Notes for Solaris</contrib> </author> + <author> + <firstname>John</firstname><surname>Trostel</surname> + <affiliation> + <orgname>SNAP</orgname> + <address><email>jtrostel@snapserver.com</email></address> + </affiliation> + </author> + &author.jelmer; &author.jht; </authorgroup> <pubdate>27 June 2002</pubdate> </chapterinfo> -<title>Integrated Logon Support using Winbind</title> +<title>Winbind: Use of Domain Accounts</title> <sect1> <title>Features and Benefits</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 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 - system, explaining the functionality it provides, how it is configured, - and how it works internally.</para> + <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. + </para> + + <para> + There is one other facility without which UNIX and Microsoft Windows network + interoperability would suffer greatly. It is imperative that there be a + mechanism for sharing files across UNIX systems and to be able to assign + domain user and group ownerships with integrity. + </para> + + <para> + <emphasis>winbind</emphasis> is a component of the Samba suite of programs + solves 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 chapter describes the winbind system, explaining the functionality + it provides, how it is configured, and how it works internally. + </para> + + <para> + Winbind provides three separate functions: + </para> + + <itemizedlist> + <listitem><para> + Authentication of user credentials (via PAM) + </para></listitem> + + <listitem><para> + Identity resolution (via NSS)` + </para></listitem> + + <listitem><para> + Windindd maintains a database called winbind_idmap.tdb in which it stores + mappings between UNIX UIDs / GIDs and NT SIDs. This mapping is used only + for users and groups that do not have a local UID/GID. It stored the UID/GID + allocated from the idmap uid/gid range that it has mapped to the NT SID. + If <parameter>idmap backend</parameter> has been specified as ldapsam:url + then instead of using a local mapping winbindd will obtain this information + from the LDAP database. + </para></listitem> + </itemizedlist> + + <note><para> + If winbindd is not running, then smbd (which calls winbindd) will fall back to + using purely local information from /etc/passwd and /etc/group and no dynamic + mapping will be used. + </para></note> + + + <!-- <figure id="winbind_idmap"><title></title> + <mediaobject> + <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap_winbind_no_loop" scale="50" scalefit="1"/></imageobject> + <imageobject><imagedata fileref="projdoc/imagefiles/idmap_winbind_no_loop.png" scale="50" scalefit="1"/></imageobject> + </mediaobject> +</figure>--> + </sect1> @@ -219,7 +277,7 @@ 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 + are looked up. This config line specifies which implementations of that service should be tried and in what order. If the passwd config line is:</para> @@ -323,36 +381,17 @@ passwd: files example <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 3.0. -</para> - <sect2> <title>Introduction</title> <para> This section describes the procedures used to get winbind up and -running on a RedHat 7.1 system. Winbind is capable of providing access +running. 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> @@ -421,10 +460,8 @@ on your system. For recent RedHat systems (7.1, for instance), that means <filename>pam-0.74-22</filename>. For best results, it is helpful to also install the development packages in <filename>pam-devel-0.74-22</filename>. </para> - </sect2> - <sect2> <title>Testing Things Out</title> @@ -433,7 +470,7 @@ Before starting, it is probably best to kill off all the SAMBA related daemons running on your server. Kill off all &smbd;, &nmbd;, and &winbindd; 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> +standard PAM package 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 @@ -442,33 +479,6 @@ the header files needed to compile pam-aware applications. </para> <sect3> -<title>Configure and compile SAMBA</title> - -<para> -The configuration and compilation of SAMBA is pretty straightforward. -The first three steps may not be necessary depending upon -whether or not you have previously built the Samba binaries. -</para> - -<para><screen> -&rootprompt;<command>autoconf</command> -&rootprompt;<command>make clean</command> -&rootprompt;<command>rm config.cache</command> -&rootprompt;<command>./configure</command> -&rootprompt;<command>make</command> -&rootprompt;<command>make install</command> -</screen></para> - - -<para> -This will, by default, install SAMBA in <filename>/usr/local/samba</filename>. -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 <filename>nsswitch.conf</filename> and the winbind libraries on Linux and Solaris</title> @@ -576,22 +586,23 @@ the <citerefentry><refentrytitle>winbindd</refentrytitle> include the following entries in the [global] section: </para> -<para><programlisting> -[global] - <...> - # separate domain and username with '+', like DOMAIN+username - <ulink url="winbindd.8.html#WINBINDSEPARATOR">winbind separator</ulink> = + - # use uids from 10000 to 20000 for domain users - <ulink url="winbindd.8.html#WINBINDUID">idmap uid</ulink> = 10000-20000 - # use gids from 10000 to 20000 for domain groups - <ulink url="winbindd.8.html#WINBINDGID">idmap gid</ulink> = 10000-20000 - # allow enumeration of winbind users and groups - <ulink url="winbindd.8.html#WINBINDENUMUSERS">winbind enum users</ulink> = yes - <ulink url="winbindd.8.html#WINBINDENUMGROUP">winbind enum groups</ulink> = yes - # give winbind users a real shell (only needed if they have telnet access) - <ulink url="winbindd.8.html#TEMPLATEHOMEDIR">template homedir</ulink> = /home/winnt/%D/%U - <ulink url="winbindd.8.html#TEMPLATESHELL">template shell</ulink> = /bin/bash -</programlisting></para> +<para><smbconfexample> + <title>smb.conf for winbind set-up</title> +<smbconfsection>[global]</smbconfsection> +<member>...</member> +<smbconfcomment> separate domain and username with '+', like DOMAIN+username</smbconfcomment> +<smbconfoption><name>winbind separator</name><value>+</value></smbconfoption> +<smbconfcomment> use uids from 10000 to 20000 for domain users</smbconfcomment> +<smbconfoption><name>idmap uid</name><value>10000-20000</value></smbconfoption> +<smbconfcomment> use gids from 10000 to 20000 for domain groups</smbconfcomment> +<smbconfoption><name>winbind gid</name><value>10000-20000</value></smbconfoption> +<smbconfcomment> allow enumeration of winbind users and groups</smbconfcomment> +<smbconfoption><name>winbind enum users</name><value>yes</value></smbconfoption> +<smbconfoption><name>winbind enum groups</name><value>yes</value></smbconfoption> +<smbconfcomment> give winbind users a real shell (only needed if they have telnet access)</smbconfcomment> +<smbconfoption><name>template homedir</name><value>/home/winnt/%D/%U</value></smbconfoption> +<smbconfoption><name>template shell</name><value>/bin/bash</value></smbconfoption> +</smbconfexample></para> </sect3> @@ -608,7 +619,7 @@ a domain user who has administrative privileges in the domain. <para> -&rootprompt;<userinput>/usr/local/samba/bin/net join -S PDC -U Administrator</userinput> +&rootprompt;<userinput>/usr/local/samba/bin/net rpc join -S PDC -U Administrator</userinput> </para> @@ -688,8 +699,7 @@ your PDC. For example, I get the following response: </screen></para> <para> -Obviously, I have named my domain 'CEO' and my <parameter>winbind -separator</parameter> is '+'. + Obviously, I have named my domain 'CEO' and my <smbconfoption><name>winbind separator</name></smbconfoption> is '+'. </para> <para> @@ -982,7 +992,7 @@ 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 &smb.conf; global entry -<parameter>template homedir</parameter>. +<smbconfoption><name>template homedir</name></smbconfoption>. </para> <para> @@ -1025,7 +1035,7 @@ same way. It now looks like this: In this case, I added the <programlisting>auth sufficient /lib/security/pam_winbind.so</programlisting> lines as before, but also added the <programlisting>required pam_securetty.so</programlisting> above it, to disallow root logins over the network. I also added a -<command>sufficient /lib/security/pam_unix.so use_first_pass</command> +<programlisting>sufficient /lib/security/pam_unix.so use_first_pass</programlisting> line after the <command>winbind.so</command> line to get rid of annoying double prompts for passwords. </para> @@ -1144,7 +1154,7 @@ configured in the pam.conf. <itemizedlist> <listitem><para>Winbind is currently only available for - the Linux, Solaris and IRIX operating systems, although ports to other operating + the Linux, Solaris, AIX and IRIX operating systems, although ports to other operating systems are certainly possible. For such ports to be feasible, we require the C library of the target operating system to support the Name Service Switch and Pluggable Authentication @@ -1163,6 +1173,25 @@ configured in the pam.conf. that may be been set for Windows NT users, this is instead up to the PDC to enforce.</para></listitem> </itemizedlist> + + <sect2> + <title>NSCD Problem Warning</title> + + <?latex \nopagebreak ?> + + <note><para> + Do NOT under ANY circumstances run <command>nscd</command> on any system + on which <command>winbind</command> is running. + </para></note> + + <para> + If <command>nscd</command> is running on the UNIX/Linux system, then + even though NSSWITCH is correctly configured it will NOT be possible to resolve + domain users and groups for file and directory controls. + </para> + + </sect2> </sect1> </chapter> + diff --git a/docs/docbook/sambadoc.dtd b/docs/docbook/sambadoc.dtd new file mode 100644 index 0000000000..63776534ae --- /dev/null +++ b/docs/docbook/sambadoc.dtd @@ -0,0 +1,25 @@ +<!-- Samba parameter, used for the smb.conf options --> +<!ELEMENT parameter (#PCDATA) > +<!ATTLIST parameter name CDATA #REQUIRED > +<!ATTLIST parameter context CDATA #REQUIRED > +<!ATTLIST parameter basic CDATA #REQUIRED > +<!ATTLIST parameter wizard CDATA #REQUIRED > +<!ATTLIST parameter advanced CDATA #REQUIRED > +<!ATTLIST parameter share CDATA #REQUIRED > +<!ATTLIST parameter print CDATA #REQUIRED > +<!ATTLIST parameter developer CDATA #REQUIRED > +<!ATTLIST parameter hide CDATA #REQUIRED > + +<!-- embedding smb.conf examples, options, option values, etc in docs --> +<!ELEMENT smbconfoption (name, value?) > +<!ELEMENT smbconfsection (#PCDATA) > +<!ELEMENT smbconfexample (title, id?, smbconfoption*, smbconfsection*) > +<!ELEMENT smbconfblock (smbconfoption*, smbconfsection*) > +<!ELEMENT smbconfcomment (#PCDATA) > + +<!-- Other stuff used quite often --> +<!ELEMENT ntgroup (#PCDATA) > +<!ELEMENT ntuser (#PCDATA) > +<!ELEMENT imagedescription (#PCDATA) > +<!ELEMENT imagefile (#PCDATA) > +<!ELEMENT image (imagedescription,imagefile) > diff --git a/docs/docbook/smbdotconf/base/netbiosaliases.xml b/docs/docbook/smbdotconf/base/netbiosaliases.xml index a62fb8f7d6..ac8ffaf2b9 100644 --- a/docs/docbook/smbdotconf/base/netbiosaliases.xml +++ b/docs/docbook/smbdotconf/base/netbiosaliases.xml @@ -3,7 +3,7 @@ advanced="1" wizard="1" developer="1" xmlns:samba="http://samba.org/common"> <listitem> - <para>This is a list of NetBIOS names that <ulink url="nmbd.8.html">nmbd(8)</ulink> will + <para>This is a list of NetBIOS names that nmbd will advertise as additional names by which the Samba server is known. This allows one machine to appear in browse lists under multiple names. If a machine is acting as a browse server or logon server none of these names will be advertised as either browse server or logon diff --git a/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml b/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml index 06017fce59..7caf3058c9 100644 --- a/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml +++ b/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml @@ -5,8 +5,8 @@ <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 + parameter) then periodically a running smbd + process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called <filename moreinfo="none">private/secrets.tdb </filename>. This parameter specifies how often this password will be changed, in seconds. The default is one week (expressed in diff --git a/docs/docbook/smbdotconf/filename/mangleprefix.xml b/docs/docbook/smbdotconf/filename/mangleprefix.xml index cbd41f973d..eff1f2b8fe 100644 --- a/docs/docbook/smbdotconf/filename/mangleprefix.xml +++ b/docs/docbook/smbdotconf/filename/mangleprefix.xml @@ -9,6 +9,10 @@ hash and therefore more name collisions. The minimum value is 1 and the maximum value is 6.</para> + <para> + mangle prefix is effective only when mangling method is hash2. + </para> + <para>Default: <command moreinfo="none">mangle prefix = 1</command></para> <para>Example: <command moreinfo="none">mangle prefix = 4</command></para> diff --git a/docs/docbook/smbdotconf/filename/manglingchar.xml b/docs/docbook/smbdotconf/filename/manglingchar.xml index 57c4fa2acd..de5f620fd9 100644 --- a/docs/docbook/smbdotconf/filename/manglingchar.xml +++ b/docs/docbook/smbdotconf/filename/manglingchar.xml @@ -5,7 +5,7 @@ <para>This controls what character is used as the <emphasis>magic</emphasis> character in <link linkend="NAMEMANGLINGSECT">name mangling</link>. The default is a '~' but this may interfere with some software. Use this option to set - it to whatever you prefer.</para> + it to whatever you prefer. This is effective only when mangling method is hash.</para> <para>Default: <command moreinfo="none">mangling char = ~</command></para> diff --git a/docs/docbook/smbdotconf/ldap/ldapgroupsuffix.xml b/docs/docbook/smbdotconf/ldap/ldapgroupsuffix.xml new file mode 100644 index 0000000000..5e6b9cc886 --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapgroupsuffix.xml @@ -0,0 +1,14 @@ +<samba:parameter name="ldap group suffix" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameters specifies the suffix that is + used for groups when these are added to the LDAP directory. + If this parameter is unset, the value of <parameter>ldap suffix</parameter> will be used instead.</para> + + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <emphasis>dc=samba,ou=Groups</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapidmapsuffix.xml b/docs/docbook/smbdotconf/ldap/ldapidmapsuffix.xml new file mode 100644 index 0000000000..f826183c33 --- /dev/null +++ b/docs/docbook/smbdotconf/ldap/ldapidmapsuffix.xml @@ -0,0 +1,15 @@ +<samba:parameter name="ldap idmap suffix" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameters specifies the suffix that is + used when storing idmap mappings. If this parameter + is unset, the value of <parameter>ldap suffix</parameter> + will be used instead.</para> + + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <emphasis>dc=samba,ou=Idmap</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml b/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml index 731fba3420..93d450b5e4 100644 --- a/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml +++ b/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml @@ -3,7 +3,8 @@ advanced="1" developer="1" xmlns:samba="http://samba.org/common"> <listitem> - <para>It specifies where users are added to the tree.</para> + <para>This parameter specifies where users are added to the tree. + If this parameter is not specified, the value from <command>ldap suffix</command>.</para> <para>Default: <emphasis>none</emphasis></para> </listitem> diff --git a/docs/docbook/smbdotconf/locking/lockspincount.xml b/docs/docbook/smbdotconf/locking/lockspincount.xml index d308f5d845..eb5862699a 100644 --- a/docs/docbook/smbdotconf/locking/lockspincount.xml +++ b/docs/docbook/smbdotconf/locking/lockspincount.xml @@ -12,6 +12,6 @@ and FoxPro. </para> - <para>Default: <command moreinfo="none">lock spin count = 2</command></para> + <para>Default: <command moreinfo="none">lock spin count = 3</command></para> </listitem> </samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/adduserscript.xml b/docs/docbook/smbdotconf/logon/adduserscript.xml index 34d3e7ea58..42f7b04563 100644 --- a/docs/docbook/smbdotconf/logon/adduserscript.xml +++ b/docs/docbook/smbdotconf/logon/adduserscript.xml @@ -11,7 +11,7 @@ created for all users accessing files on this server. For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the - Windows NT PDC is an onerous task. This option allows <ulink url="smbd.8.html">smbd</ulink> to create the required UNIX users + Windows NT PDC is an onerous task. This option allows smbd to create the required UNIX users <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.</para> <para>In order to use this option, <citerefentry><refentrytitle>smbd</refentrytitle> diff --git a/docs/docbook/smbdotconf/logon/logonscript.xml b/docs/docbook/smbdotconf/logon/logonscript.xml index 65b6253c0c..a1e8e0c03b 100644 --- a/docs/docbook/smbdotconf/logon/logonscript.xml +++ b/docs/docbook/smbdotconf/logon/logonscript.xml @@ -22,8 +22,8 @@ suggested command would be to add <command moreinfo="none">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 moreinfo="none">NET USE - U: \\SERVER\UTILS</command> for commonly used utilities, or <command moreinfo="none"> - NET USE Q: \\SERVER\ISO9001_QA</command> for example.</para> + U: \\SERVER\UTILS</command> for commonly used utilities, or <screen> + <userinput>NET USE Q: \\SERVER\ISO9001_QA</userinput></screen> for example.</para> <para>Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users write permission diff --git a/docs/docbook/smbdotconf/logon/shutdownscript.xml b/docs/docbook/smbdotconf/logon/shutdownscript.xml index 0eaffea747..8935714307 100644 --- a/docs/docbook/smbdotconf/logon/shutdownscript.xml +++ b/docs/docbook/smbdotconf/logon/shutdownscript.xml @@ -38,7 +38,7 @@ <para>Default: <emphasis>None</emphasis>.</para> - <para>Example: <command moreinfo="none">abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f</command></para> + <para>Example: <command moreinfo="none">shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f</command></para> <para>Shutdown script example: <programlisting format="linespecific"> diff --git a/docs/docbook/smbdotconf/misc/kernelchangenotify.xml b/docs/docbook/smbdotconf/misc/kernelchangenotify.xml new file mode 100644 index 0000000000..c6dc215b94 --- /dev/null +++ b/docs/docbook/smbdotconf/misc/kernelchangenotify.xml @@ -0,0 +1,17 @@ +<samba:parameter name="kernel change notify" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies whether Samba should ask the + kernel for change notifications in directories so that + SMB clients can refresh whenever the data on the server changes. + </para> + + <para>This parameter is only usd when your kernel supports + change notification to user programs, using the F_NOTIFY fcntl. + </para> + + <para>Default: <emphasis>Yes</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/remoteannounce.xml b/docs/docbook/smbdotconf/misc/remoteannounce.xml index 019cc306a7..d03ea8b0e2 100644 --- a/docs/docbook/smbdotconf/misc/remoteannounce.xml +++ b/docs/docbook/smbdotconf/misc/remoteannounce.xml @@ -27,8 +27,7 @@ addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable.</para> - <para>See the documentation file <ulink url="improved-browsing.html">BROWSING</ulink> - in the <filename moreinfo="none">docs/</filename> directory.</para> + <para>See <link linkend="NetworkBrowsing"/>.</para> <para>Default: <command moreinfo="none">remote announce = <empty string></command></para> </listitem> diff --git a/docs/docbook/smbdotconf/printing/os2drivermap.xml b/docs/docbook/smbdotconf/printing/os2drivermap.xml index 478031c7b9..ffaa58fe2a 100644 --- a/docs/docbook/smbdotconf/printing/os2drivermap.xml +++ b/docs/docbook/smbdotconf/printing/os2drivermap.xml @@ -14,9 +14,8 @@ LaserJet 5L</command>.</para> <para>The need for the file is due to the printer driver namespace - problem described in the <ulink url="printing.html">Samba - Printing HOWTO</ulink>. For more details on OS/2 clients, please - refer to the OS2-Client-HOWTO containing in the Samba documentation.</para> + problem described in <link linkiend="printing"/>. For more details on OS/2 clients, please + refer to <link linkend="Other-Clients"/>.</para> <para>Default: <command moreinfo="none">os2 driver map = <empty string></command></para> </listitem> diff --git a/docs/docbook/smbdotconf/protocol/clientusespnego.xml b/docs/docbook/smbdotconf/protocol/clientusespnego.xml index df25fbfb20..ce187a36fa 100644 --- a/docs/docbook/smbdotconf/protocol/clientusespnego.xml +++ b/docs/docbook/smbdotconf/protocol/clientusespnego.xml @@ -6,6 +6,9 @@ <para> This variable controls controls whether samba clients will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000 servers to agree upon an authentication mechanism. + SPNEGO client support for SMB Signing is currently broken, so + you might want to turn this option off when operating with + Windows 2003 domain controllers in particular. </para> <para>Default: <emphasis>client use spnego = yes</emphasis></para> diff --git a/docs/docbook/smbdotconf/protocol/nameresolveorder.xml b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml index 4e88495489..45bc98843f 100644 --- a/docs/docbook/smbdotconf/protocol/nameresolveorder.xml +++ b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml @@ -18,7 +18,7 @@ <para><constant>lmhosts</constant> : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has no name type attached to the NetBIOS name (see the <ulink - url="lmhosts.5.html">lmhosts(5)</ulink> for details) then + noescape="1" url="lmhosts.5.html">lmhosts(5)</ulink> for details) then any name type matches for lookup.</para> </listitem> diff --git a/docs/docbook/smbdotconf/protocol/profileacls.xml b/docs/docbook/smbdotconf/protocol/profileacls.xml index 6f2b3ec510..505f371809 100644 --- a/docs/docbook/smbdotconf/protocol/profileacls.xml +++ b/docs/docbook/smbdotconf/protocol/profileacls.xml @@ -10,7 +10,10 @@ Windows XP clients. New versions of Windows 2000 or Windows XP service packs do security ACL checking on the owner and ability to write of the profile directory stored on a local workstation when copied from a Samba - share. When not in domain mode with winbindd then the security info copied + share. +</para> + +<para>When not in domain mode with winbindd then the security info copied onto the local workstation has no meaning to the logged in user (SID) on that workstation so the profile storing fails. Adding this parameter onto a share used for profile storage changes two things about the @@ -19,15 +22,17 @@ BUILTIN\\Users respectively (SIDs S-1-5-32-544, S-1-5-32-545). Secondly it adds an ACE entry of "Full Control" to the SID BUILTIN\\Users to every returned ACL. This will allow any Windows 2000 or XP workstation - user to access the profile. Note that if you have multiple users logging + user to access the profile.</para> + + <para>Note that if you have multiple users logging on to a workstation then in order to prevent them from being able to access each others profiles you must remove the "Bypass traverse checking" advanced user right. This will prevent access to other users profile directories as the top level profile directory (named after the user) is created by the workstation profile code and has an ACL restricting entry to the directory tree to the owning user. - </para> - +</para> + <para>Default: <command moreinfo="none">profile acls = no</command></para> </listitem> </samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/unixextensions.xml b/docs/docbook/smbdotconf/protocol/unixextensions.xml index 2f68b9605e..e62ca1a2d4 100644 --- a/docs/docbook/smbdotconf/protocol/unixextensions.xml +++ b/docs/docbook/smbdotconf/protocol/unixextensions.xml @@ -10,6 +10,6 @@ These extensions require a similarly enabled client, and are of no current use to Windows clients.</para> - <para>Default: <command moreinfo="none">unix extensions = no</command></para> + <para>Default: <command moreinfo="none">unix extensions = yes</command></para> </listitem> </samba:parameter> diff --git a/docs/docbook/smbdotconf/security/allowtrusteddomains.xml b/docs/docbook/smbdotconf/security/allowtrusteddomains.xml index 63363d2607..8354f8b8da 100644 --- a/docs/docbook/smbdotconf/security/allowtrusteddomains.xml +++ b/docs/docbook/smbdotconf/security/allowtrusteddomains.xml @@ -7,7 +7,7 @@ <parameter moreinfo="none">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 <ulink url="smbd.8.html">smbd</ulink> is running + a domain or workgroup other than the one which smbd is running in will fail, even if that domain is trusted by the remote server doing the authentication.</para> diff --git a/docs/docbook/smbdotconf/security/clientntlmv2auth.xml b/docs/docbook/smbdotconf/security/clientntlmv2auth.xml index 0bf196488b..611ebcd094 100644 --- a/docs/docbook/smbdotconf/security/clientntlmv2auth.xml +++ b/docs/docbook/smbdotconf/security/clientntlmv2auth.xml @@ -13,6 +13,12 @@ (including NT4 < SP4, Win9x and Samba 2.2) are not compatible with NTLMv2. </para> + <para>Similarly, if enabled, NTLMv1, <command + moreinfo="none">client lanman auth</command> and <command + moreinfo="none">client plaintext auth</command> + authentication will be disabled. This also disables share-level + authentication. </para> + <para>If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of <command moreinfo="none">client lanman auth</command>. </para> diff --git a/docs/docbook/smbdotconf/security/clientplaintextauth.xml b/docs/docbook/smbdotconf/security/clientplaintextauth.xml new file mode 100644 index 0000000000..ac90ef9fe5 --- /dev/null +++ b/docs/docbook/smbdotconf/security/clientplaintextauth.xml @@ -0,0 +1,12 @@ +<samba:parameter name="client plaintext auth" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies whether a client should send a plaintext + password if the server does not support encrypted passwords.</para> + + <para>Default: <command moreinfo="none">client plaintext auth = yes</command></para> + +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/clientschannel.xml b/docs/docbook/smbdotconf/security/clientschannel.xml new file mode 100644 index 0000000000..f3ad682517 --- /dev/null +++ b/docs/docbook/smbdotconf/security/clientschannel.xml @@ -0,0 +1,19 @@ +<samba:parameter name="client schannel" + context="G" + basic="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>This controls whether the client offers or even + demands the use of the netlogon schannel. + <parameter>client schannel = no</parameter> does not + offer the schannel, <parameter>server schannel = + auto</parameter> offers the schannel but does not + enforce it, and <parameter>server schannel = + yes</parameter> denies access if the server is not + able to speak netlogon schannel. </para> + + <para>Default: <command>client schannel = auto</command></para> + <para>Example: <command>client schannel = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/clientsigning.xml b/docs/docbook/smbdotconf/security/clientsigning.xml new file mode 100644 index 0000000000..e006dc71ab --- /dev/null +++ b/docs/docbook/smbdotconf/security/clientsigning.xml @@ -0,0 +1,19 @@ +<samba:parameter name="client signing" + context="G" + basic="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>This controls whether the client offers or requires + the server it talks to to use SMB signing. Possible values + are <emphasis>auto</emphasis>, <emphasis>mandatory</emphasis> + and <emphasis>disabled</emphasis>. + </para> + + <para>When set to auto, SMB signing is offered, but not enforced. + When set to mandatory, SMB signing is required and if set + to disabled, SMB signing is not offered either.</para> + + <para>Default: <command>client signing = auto</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/passdbbackend.xml b/docs/docbook/smbdotconf/security/passdbbackend.xml index 1a3a83946a..8c64299dd4 100644 --- a/docs/docbook/smbdotconf/security/passdbbackend.xml +++ b/docs/docbook/smbdotconf/security/passdbbackend.xml @@ -55,22 +55,15 @@ details. </para></listitem> - <listitem> - <para><command moreinfo="none">guest</command> - - Very simple backend that only provides one user: the guest user. - Only maps the NT guest user to the <parameter>guest account</parameter>. - Required in pretty much all situations. - </para></listitem> - </itemizedlist> </para> <para>Default: <command moreinfo="none">passdb backend = smbpasswd</command></para> - <para>Example: <command moreinfo="none">passdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd guest</command></para> + <para>Example: <command moreinfo="none">passdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd</command></para> - <para>Example: <command moreinfo="none">passdb backend = ldapsam:ldaps://ldap.example.com guest</command></para> + <para>Example: <command moreinfo="none">passdb backend = ldapsam:ldaps://ldap.example.com</command></para> - <para>Example: <command moreinfo="none">passdb backend = mysql:my_plugin_args tdbsam:/etc/samba/private/passdb.tdb guest</command></para> + <para>Example: <command moreinfo="none">passdb backend = mysql:my_plugin_args tdbsam</command></para> </listitem> </samba:parameter> diff --git a/docs/docbook/smbdotconf/security/passwdprogram.xml b/docs/docbook/smbdotconf/security/passwdprogram.xml index dbcc261ce4..db02670158 100644 --- a/docs/docbook/smbdotconf/security/passwdprogram.xml +++ b/docs/docbook/smbdotconf/security/passwdprogram.xml @@ -17,9 +17,8 @@ <para><emphasis>Note</emphasis> that if the <parameter moreinfo="none">unix password sync</parameter> parameter is set to <constant>yes </constant> then this program is called <emphasis>AS ROOT</emphasis> - before the SMB password in the <ulink url="smbpasswd.5.html"><citerefentry> - <refentrytitle>smbpasswd</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </ulink> file is changed. If this UNIX password change fails, then + before the SMB password in the smbpasswd + file is changed. If this UNIX password change fails, then <command moreinfo="none">smbd</command> will fail to change the SMB password also (this is by design).</para> diff --git a/docs/docbook/smbdotconf/security/preloadmodules.xml b/docs/docbook/smbdotconf/security/preloadmodules.xml index 7b4e57cff1..101d9606fa 100644 --- a/docs/docbook/smbdotconf/security/preloadmodules.xml +++ b/docs/docbook/smbdotconf/security/preloadmodules.xml @@ -7,9 +7,6 @@ be loaded into smbd before a client connects. This improves the speed of smbd when reacting to new connections somewhat. </para> - <para>It is recommended to only use this option on heavy-performance - servers.</para> - <para>Default: <command>preload modules = </command></para> <para>Example: <command>preload modules = /usr/lib/samba/passdb/mysql.so+++ </command></para> diff --git a/docs/docbook/smbdotconf/security/serversigning.xml b/docs/docbook/smbdotconf/security/serversigning.xml new file mode 100644 index 0000000000..5108918d84 --- /dev/null +++ b/docs/docbook/smbdotconf/security/serversigning.xml @@ -0,0 +1,19 @@ +<samba:parameter name="server signing" + context="G" + basic="1" + xmlns:samba="http://samba.org/common"> +<listitem> + + <para>This controls whether the server offers or requires + the client it talks to to use SMB signing. Possible values + are <emphasis>auto</emphasis>, <emphasis>mandatory</emphasis> + and <emphasis>disabled</emphasis>. + </para> + + <para>When set to auto, SMB signing is offered, but not enforced. + When set to mandatory, SMB signing is required and if set + to disabled, SMB signing is not offered either.</para> + + <para>Default: <command>client signing = False</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/deadtime.xml b/docs/docbook/smbdotconf/tuning/deadtime.xml index cbbf751862..938f354b9a 100644 --- a/docs/docbook/smbdotconf/tuning/deadtime.xml +++ b/docs/docbook/smbdotconf/tuning/deadtime.xml @@ -1,4 +1,4 @@ -<samba:parameter name="dead time" +<samba:parameter name="deadtime" context="G" developer="1" xmlns:samba="http://samba.org/common"> diff --git a/docs/docbook/smbdotconf/vfs/aclcompatibility.xml b/docs/docbook/smbdotconf/vfs/aclcompatibility.xml new file mode 100644 index 0000000000..ca3f39512d --- /dev/null +++ b/docs/docbook/smbdotconf/vfs/aclcompatibility.xml @@ -0,0 +1,17 @@ +<samba:parameter name="acl compatibility" + context="S" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies what OS ACL semantics should + be compatible with. Possible values are <emphasis>winnt</emphasis> for Windows NT 4, + <emphasis>win2k</emphasis> for Windows 2000 and above and <emphasis>auto</emphasis>. + If you specify <emphasis>auto</emphasis>, the value for this parameter + will be based upon the version of the client. There should + be no reason to change this parameter from the default.</para> + + <para>Default: <command moreinfo="none">acl compatibility = Auto</command></para> + + <para>Example: <command moreinfo="none">acl compatibility = win2k</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/vfs/getquotacommand.xml b/docs/docbook/smbdotconf/vfs/getquotacommand.xml new file mode 100644 index 0000000000..93c9089519 --- /dev/null +++ b/docs/docbook/smbdotconf/vfs/getquotacommand.xml @@ -0,0 +1,52 @@ +<samba:parameter name="get quota command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The <command>get quota command</command> should only be used + whenever there is no operating system API available from the OS that + samba can use.</para> + + <para>This parameter should specify the path to a script that + queries the quota information for the specified + user/group for the partition that + the specified directory is on.</para> + + <para>Such a script should take 3 arguments:</para> + + <itemizedlist> + <listitem><para>directory</para></listitem> + <listitem><para>type of query</para></listitem> + <listitem><para>uid of user or gid of group</para></listitem> + </itemizedlist> + + <para>The type of query can be one of :</para> + + <itemizedlist> + <listitem><para>1 - user quotas</para></listitem> + <listitem><para>2 - user default quotas (uid = -1)</para></listitem> + <listitem><para>3 - group quotas</para></listitem> + <listitem><para>4 - group default quotas (gid = -1)</para></listitem> + </itemizedlist> + + <para>This script should print its output according to the following format:</para> + + <itemizedlist> + <listitem><para>Line 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</para></listitem> + <listitem><para>Line 2 - number of currently used blocks</para></listitem> + <listitem><para>Line 3 - the softlimit number of blocks</para></listitem> + <listitem><para>Line 4 - the hardlimit number of blocks</para></listitem> + <listitem><para>Line 5 - currently used number of inodes</para></listitem> + <listitem><para>Line 6 - the softlimit number of inodes</para></listitem> + <listitem><para>Line 7 - the hardlimit number of inodes</para></listitem> + <listitem><para>Line 8(optional) - the number of bytes in a block(default is 1024)</para></listitem> + </itemizedlist> + + <para>See also the <link linkend="SETQUOTACOMMAND"><parameter moreinfo="none">set quota command</parameter></link> parameter. + </para> + + <para>Default: <command moreinfo="none">get quota command = </command></para> + + <para>Example: <command moreinfo="none">get quota command = /usr/local/sbin/query_quota</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/vfs/hostmsdfs.xml b/docs/docbook/smbdotconf/vfs/hostmsdfs.xml index c843969e50..d2b64cc68f 100644 --- a/docs/docbook/smbdotconf/vfs/hostmsdfs.xml +++ b/docs/docbook/smbdotconf/vfs/hostmsdfs.xml @@ -3,16 +3,14 @@ advanced="1" developer="1" xmlns:samba="http://samba.org/common"> <listitem> - <para>This boolean parameter is only available - if Samba has been configured and compiled with the <command moreinfo="none"> - --with-msdfs</command> option. If set to <constant>yes</constant>, - Samba will act as a Dfs server, and allow Dfs-aware clients - to browse Dfs trees hosted on the server.</para> + <para>If set to <constant>yes</constant>, Samba will act as a Dfs + server, and allow Dfs-aware clients to browse Dfs trees hosted + on the server.</para> <para>See also the <link linkend="MSDFSROOT"><parameter moreinfo="none"> msdfs root</parameter></link> share level parameter. For more information on setting up a Dfs tree on Samba, - refer to <ulink url="msdfs_setup.html">msdfs_setup.html</ulink>. + refer to <link linkend="msdfs"/>. </para> <para>Default: <command moreinfo="none">host msdfs = no</command></para> diff --git a/docs/docbook/smbdotconf/vfs/msdfsroot.xml b/docs/docbook/smbdotconf/vfs/msdfsroot.xml index 35142ff037..059ffff9a0 100644 --- a/docs/docbook/smbdotconf/vfs/msdfsroot.xml +++ b/docs/docbook/smbdotconf/vfs/msdfsroot.xml @@ -2,16 +2,14 @@ context="S" xmlns:samba="http://samba.org/common"> <listitem> - <para>This boolean parameter is only available if - Samba is configured and compiled with the <command moreinfo="none"> - --with-msdfs</command> option. If set to <constant>yes</constant>, - Samba treats the share as a Dfs root and allows clients to browse - the distributed file system tree rooted at the share directory. - Dfs links are specified in the share directory by symbolic - links of the form <filename moreinfo="none">msdfs:serverA\\shareA,serverB\\shareB</filename> - and so on. For more information on setting up a Dfs tree - on Samba, refer to <ulink url="msdfs.html">"Hosting a Microsoft - Distributed File System tree on Samba"</ulink> document.</para> + <para>If set to <constant>yes</constant>, Samba treats the + share as a Dfs root and allows clients to browse the + distributed file system tree rooted at the share directory. + Dfs links are specified in the share directory by symbolic + links of the form <filename + moreinfo="none">msdfs:serverA\\shareA,serverB\\shareB</filename> + and so on. For more information on setting up a Dfs tree on + Samba, refer to <link linkend="msdfs"/>.</para> <para>See also <link linkend="HOSTMSDFS"><parameter moreinfo="none">host msdfs</parameter></link></para> diff --git a/docs/docbook/smbdotconf/vfs/setquotacommand.xml b/docs/docbook/smbdotconf/vfs/setquotacommand.xml new file mode 100644 index 0000000000..b4b7303a0d --- /dev/null +++ b/docs/docbook/smbdotconf/vfs/setquotacommand.xml @@ -0,0 +1,42 @@ +<samba:parameter name="set quota command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The <command>set quota command</command> should only be used + whenever there is no operating system API available from the OS that + samba can use.</para> + + <para>This parameter should specify the path to a script that + can set quota for the specified arguments.</para> + + <para>The specified script should take the following arguments:</para> + + <itemizedlist> + <listitem><para>1 - quota type + <itemizedlist> + <listitem><para>1 - user quotas</para></listitem> + <listitem><para>2 - user default quotas (uid = -1)</para></listitem> + <listitem><para>3 - group quotas</para></listitem> + <listitem><para>4 - group default quotas (gid = -1)</para></listitem> + </itemizedlist> + </para></listitem> + <listitem><para>2 - id (uid for user, gid for group, -1 if N/A)</para></listitem> + <listitem><para>3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</para></listitem> + <listitem><para>4 - block softlimit</para></listitem> + <listitem><para>5 - block hardlimit</para></listitem> + <listitem><para>6 - inode softlimit</para></listitem> + <listitem><para>7 - inode hardlimit</para></listitem> + <listitem><para>8(optional) - block size, defaults to 1024</para></listitem> + </itemizedlist> + + <para>The script should output at least one line of data.</para> + + <para>See also the <link linkend="GETQUOTACOMMAND"><parameter moreinfo="none">get quota command</parameter></link> parameter. + </para> + + <para>Default: <command moreinfo="none">set quota command = </command></para> + + <para>Example: <command moreinfo="none">set quota command = /usr/local/sbin/set_quota</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/idmapbackend.xml b/docs/docbook/smbdotconf/winbind/idmapbackend.xml new file mode 100644 index 0000000000..bc725b589f --- /dev/null +++ b/docs/docbook/smbdotconf/winbind/idmapbackend.xml @@ -0,0 +1,18 @@ +<samba:parameter name="idmap backend" + context="G" + advanced="1" developer="1" hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> + The purpose of the idmap backend parameter is to allow idmap to NOT use the local idmap + tdb file to obtain SID to UID / GID mappings, but instead to obtain them from a common + LDAP backend. This way all domain members and controllers will have the same UID and GID + to SID mappings. This avoids the risk of UID / GID inconsistencies across UNIX / Linux + systems that are sharing information over protocols other than SMB/CIFS (ie: NFS). + </para> + + <para>Default: <command moreinfo="none">idmap backend = <empty string></command></para> + + <para>Example: <command moreinfo="none">idmap backend = ldap:ldap://ldapslave.example.com</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/winbind/winbindcachetime.xml b/docs/docbook/smbdotconf/winbind/winbindcachetime.xml index 3080adc7c8..cd063f8daa 100644 --- a/docs/docbook/smbdotconf/winbind/winbindcachetime.xml +++ b/docs/docbook/smbdotconf/winbind/winbindcachetime.xml @@ -9,6 +9,6 @@ user and group information before querying a Windows NT server again.</para> - <para>Default: <command moreinfo="none">winbind cache type = 15</command></para> + <para>Default: <command moreinfo="none">winbind cache type = 300</command></para> </listitem> </samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winsserver.xml b/docs/docbook/smbdotconf/wins/winsserver.xml index 12ee635acd..577a130ff1 100644 --- a/docs/docbook/smbdotconf/wins/winsserver.xml +++ b/docs/docbook/smbdotconf/wins/winsserver.xml @@ -21,7 +21,7 @@ to a WINS server if you have multiple subnets and wish cross-subnet browsing to work correctly.</para></note> - <para>See the documentation file <ulink url="improved-browsing.html">Browsing</ulink> in the samba howto collection.</para> + <para>See the <link linkend="NetworkBrowsing"/>.</para> <para>Default: <emphasis>not enabled</emphasis></para> diff --git a/docs/docbook/xslt/expand-sambadoc.xsl b/docs/docbook/xslt/expand-sambadoc.xsl new file mode 100644 index 0000000000..2749fdf3e9 --- /dev/null +++ b/docs/docbook/xslt/expand-sambadoc.xsl @@ -0,0 +1,304 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:exsl="http://exslt.org/common" + xmlns:samba="http://samba.org/common" + version="1.1" + extension-element-prefixes="exsl"> + +<xsl:output method="xml"/> + +<xsl:param name="xmlSambaNsUri" select="'http://samba.org/common'"/> + +<xsl:template match="reference/refentry/refsect1"> + <xsl:if test="title!='VERSION' and title!='AUTHOR'"> + <xsl:element name="refsect1"> + <xsl:if test="@id!=''"> + <xsl:attribute name="id"> + <xsl:value-of select="@id"/> + </xsl:attribute> + </xsl:if> + <xsl:apply-templates/> + </xsl:element> + </xsl:if> +</xsl:template> + +<xsl:template match="reference/refentry"> + <xsl:element name="section"> + <xsl:attribute name="id"> + <xsl:value-of select="@id"/> + </xsl:attribute> + <xsl:element name="title"> + <xsl:value-of select="refmeta/refentrytitle"/> +<!-- <xsl:text> (</xsl:text> + <xsl:value-of select="refnamediv/refpurpose"/> + <xsl:text>)</xsl:text>--> + </xsl:element> + <xsl:apply-templates/> + </xsl:element> +</xsl:template> + +<xsl:template match="reference/refentry/refmeta"/> + +<xsl:template match="reference/refentry/refnamediv"/> + +<xsl:template match="reference"> + <xsl:element name="appendix"> + <xsl:attribute name="id"> + <xsl:value-of select="@id"/> + </xsl:attribute> + <xsl:apply-templates/> + </xsl:element> +</xsl:template> + +<xsl:template match="/node()"> + <xsl:text disable-output-escaping="yes"> +<!DOCTYPE </xsl:text><xsl:value-of select="name(.)"/><xsl:text disable-output-escaping="yes"> PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + + <!ENTITY % globalentities SYSTEM 'global.ent'> %globalentities; + ]> +</xsl:text> +<xsl:copy> + <xsl:attribute name="id"><xsl:value-of select="@id"/></xsl:attribute> + <xsl:apply-templates/> +</xsl:copy> +</xsl:template> + + +<!-- This is needed to copy content unchanged --> +<xsl:template match="@*|node()"> + + <xsl:copy> + <xsl:apply-templates select="@*|node()"/> + </xsl:copy> +</xsl:template> + +<xsl:template match="smbconfexample/smbconfoption|smbconfblock/smbconfoption"> + <xsl:element name="member"> + <xsl:element name="parameter"> + <xsl:value-of select="name"/> + <xsl:choose> + <xsl:when test="value != ''"> + <xsl:text> = </xsl:text> + <xsl:value-of select="value"/> + </xsl:when> + </xsl:choose> + </xsl:element> + </xsl:element> +</xsl:template> + +<xsl:template match="smbconfexample/smbconfcomment|smbconfblock/smbconfcomment"> + <xsl:element name="member"> + <xsl:text># </xsl:text> + <xsl:apply-templates/> + </xsl:element> +</xsl:template> + +<xsl:template match="smbconfexample/smbconfsection|smbconfblock/smbconfsection"> + <xsl:element name="member"> + <xsl:text> </xsl:text> + </xsl:element> + <xsl:element name="member"> + <xsl:element name="parameter"> + <xsl:apply-templates/> + </xsl:element> + </xsl:element> +</xsl:template> + +<xsl:template match="smbconfoption"> + <!-- Include an index term --> + <xsl:element name="indexterm"> + <xsl:element name="primary"> + <xsl:value-of select="name"/> + </xsl:element> + </xsl:element> + +<!-- FIXME: Do this only when smb.conf is included + <xsl:element name="link"> + <xsl:attribute name="linkend"> + <xsl:value-of select="translate(translate(string(name),' ',''),'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/> + </xsl:attribute>--> + + <xsl:element name="parameter"> + <xsl:attribute name="moreinfo"> + <xsl:text>none</xsl:text> + </xsl:attribute> + <xsl:value-of select="name"/> + </xsl:element> + + <xsl:choose> + <xsl:when test="value != ''"> + <xsl:text> = </xsl:text> + <xsl:value-of select="value"/> + </xsl:when> + </xsl:choose> + <!-- + </xsl:element>--> +</xsl:template> + +<!-- FIXME: Needs extension sometime --> +<xsl:template match="ntgroup|ntuser"> + <xsl:element name="emphasis"> + <xsl:apply-templates/> + </xsl:element> +</xsl:template> + +<xsl:template match="smbconfexample"> + <xsl:choose> + <xsl:when test="title = ''"> + <xsl:message> + <xsl:text>Warning: smbconfexample does not have title!</xsl:text> + </xsl:message> + </xsl:when> + </xsl:choose> + <xsl:element name="example"> + <xsl:choose> + <xsl:when test="@id != ''"> + <xsl:attribute name="id"> + <xsl:value-of select="@id"/> + </xsl:attribute> + </xsl:when> + </xsl:choose> + + <xsl:element name="title"> + <xsl:value-of select="title"/> + </xsl:element> + <xsl:element name="simplelist"> + <xsl:apply-templates/> + </xsl:element> + </xsl:element> +</xsl:template> + +<xsl:template match="smbconfexample/title"> +</xsl:template> + +<xsl:template match="smbconfblock"> + <xsl:element name="simplelist"> + <xsl:apply-templates/> + </xsl:element> +</xsl:template> + +<xsl:template match="smbconfsection"> + <xsl:element name="parameter"> + <xsl:apply-templates/> + </xsl:element> +</xsl:template> + +<xsl:template match="smbconfcomment"> + <xsl:text># </xsl:text> + <xsl:apply-templates/> +</xsl:template> + +<xsl:template match="image"> + <xsl:element name="figure"> + <xsl:attribute name="id"> + <xsl:choose> + <xsl:when test="@id != ''"> + <xsl:value-of select="@id"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="imagefile"/> + </xsl:otherwise> + </xsl:choose> + </xsl:attribute> + + <xsl:element name="title"> + <xsl:value-of select="imagedescription"/> + </xsl:element> + <xsl:element name="mediaobject"> + <xsl:element name="imageobject"> + <xsl:attribute name="role"><xsl:text>latex</xsl:text></xsl:attribute> + <xsl:element name="imagedata"> + <xsl:attribute name="fileref"> + <xsl:text>projdoc/imagefiles/</xsl:text><xsl:value-of select="imagefile"/></xsl:attribute> + <xsl:attribute name="scale"> + <xsl:choose> + <xsl:when test="@scale != ''"> + <xsl:value-of select="@scale"/> + </xsl:when> + + <xsl:otherwise> + <xsl:text>50</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:attribute> + <xsl:attribute name="scalefit"><xsl:text>1</xsl:text></xsl:attribute> + </xsl:element> + </xsl:element> + <xsl:element name="imageobject"> + <xsl:element name="imagedata"> + <xsl:attribute name="fileref"> + <xsl:text>projdoc/imagefiles/</xsl:text><xsl:value-of select="imagefile"/><xsl:text>.png</xsl:text></xsl:attribute> + <xsl:attribute name="scale"><xsl:text>50</xsl:text></xsl:attribute> + <xsl:attribute name="scalefit"><xsl:text>1</xsl:text></xsl:attribute> + </xsl:element> + </xsl:element> + </xsl:element> + </xsl:element> +</xsl:template> + +<xsl:template match="//samba:parameter"> + <!-- reconstruct varlistentry - not all of them will go into separate files + and also we must repair the main varlistentry itself. + --> + <xsl:variable name="name"><xsl:value-of select="translate(translate(string(@name),' ',''), + 'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/> + </xsl:variable> + + <xsl:variable name="anchor"> + <xsl:element name="anchor"> + <xsl:attribute name="id"> + <xsl:value-of select="$name"/> + </xsl:attribute> + </xsl:element> + </xsl:variable> + + <xsl:variable name="context"> + <xsl:text> (</xsl:text> + <xsl:value-of select="@context"/> + <xsl:text>)</xsl:text> + </xsl:variable> + + <xsl:variable name="term"> + <xsl:element name="term"> + <xsl:copy-of select="$anchor"/> + <xsl:value-of select="@name"/> + <xsl:value-of select="$context"/> + </xsl:element> + </xsl:variable> + + <xsl:variable name="content"> + <xsl:apply-templates/> + </xsl:variable> + + <xsl:element name="varlistentry"> + <xsl:text> </xsl:text> + <xsl:element name="indexterm"> + <xsl:attribute name="significance"> + <xsl:text>preferred</xsl:text> + </xsl:attribute> + <xsl:element name="primary"> + <xsl:value-of select="@name"/> + </xsl:element> + </xsl:element> + <xsl:copy-of select="$term"/> + <xsl:copy-of select="$content"/> + <xsl:text> +</xsl:text> + </xsl:element> + +</xsl:template> + +<xsl:template match="ulink"> + <xsl:element name="ulink"> + <xsl:attribute name="url"> + <xsl:value-of select="@url"/> + </xsl:attribute> + + <xsl:apply-templates/> + + </xsl:element> +</xsl:template> + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/generate-attributions.xsl b/docs/docbook/xslt/generate-attributions.xsl index c781a77cc4..29683b1921 100644 --- a/docs/docbook/xslt/generate-attributions.xsl +++ b/docs/docbook/xslt/generate-attributions.xsl @@ -12,38 +12,39 @@ <xsl:apply-templates select="@*|node()"/> </xsl:template> -<xsl:template match="book"> - <xsl:element name="variablelist"> - <xsl:apply-templates/> - </xsl:element> -</xsl:template> - <xsl:template match="chapter"> - <xsl:element name="varlistentry"> - <xsl:element name="term"> - <xsl:element name="link"> - <xsl:attribute name="linkend"><xsl:value-of select="@id"/></xsl:attribute> - <xsl:value-of select="title"/> - </xsl:element> - </xsl:element> - <xsl:element name="listitem"> + <xsl:choose> + <xsl:when test="chapterinfo/author != ''"> <xsl:element name="para"> + <xsl:element name="link"> + <xsl:attribute name="linkend"><xsl:value-of select="@id"/></xsl:attribute> + <xsl:value-of select="title"/> + </xsl:element> <xsl:element name="itemizedlist"> - <xsl:apply-templates/> + <xsl:apply-templates/> </xsl:element> </xsl:element> - </xsl:element> - </xsl:element> + </xsl:when> + </xsl:choose> </xsl:template> <xsl:template match="author"> <xsl:element name="listitem"> <xsl:element name="para"> - <xsl:value-of select="firstname"/><xsl:text> </xsl:text><xsl:value-of select="surname"/> + <xsl:value-of select="firstname"/> + <xsl:if test="othername != ''"> + <xsl:text> </xsl:text> + <xsl:value-of select="othername"/> + <xsl:text> </xsl:text> + </xsl:if> + <xsl:text> </xsl:text><xsl:value-of select="surname"/> <xsl:choose> <xsl:when test="affiliation/address/email != ''"> <xsl:text> <</xsl:text> <xsl:element name="ulink"> + <xsl:attribute name="noescape"> + <xsl:text>1</xsl:text> + </xsl:attribute> <xsl:attribute name="url"> <xsl:text>mailto:</xsl:text> <xsl:value-of select="affiliation/address/email"/> @@ -62,6 +63,8 @@ </xsl:choose> </xsl:element> </xsl:element> + <xsl:text> + </xsl:text> </xsl:template> </xsl:stylesheet> diff --git a/docs/docbook/xslt/html-common.xsl b/docs/docbook/xslt/html-common.xsl index ecb8a08662..dce900ef67 100644 --- a/docs/docbook/xslt/html-common.xsl +++ b/docs/docbook/xslt/html-common.xsl @@ -19,4 +19,7 @@ <xsl:value-of select="refentrytitle"/><xsl:text>.</xsl:text><xsl:value-of select="manvolnum"/><xsl:text>.html</xsl:text> </xsl:template> +<xsl:template match="author"> +</xsl:template> + </xsl:stylesheet> diff --git a/docs/docbook/xslt/latex.xsl b/docs/docbook/xslt/latex.xsl index 8fafd5d140..406a64b646 100644 --- a/docs/docbook/xslt/latex.xsl +++ b/docs/docbook/xslt/latex.xsl @@ -1,18 +1,21 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'> -<xsl:import href="db2latex/docbook.xsl"/> -<xsl:import href="table.mod.xsl"/> -<xsl:import href="lists.mod.xsl"/> +<xsl:import href="http://db2latex.sourceforge.net/xsl/docbook.xsl"/> <xsl:output method="text" encoding="ISO-8859-1" indent="yes"/> -<xsl:variable name="latex.documentclass">xslt/latex/sambadoc</xsl:variable> -<xsl:variable name="latex.documentclass.common">english,final,titlepage,parskip</xsl:variable> +<xsl:param name="l10n.gentext.default.language">en</xsl:param> +<xsl:variable name="latex.documentclass">sambadoc</xsl:variable> +<xsl:variable name="latex.documentclass.common">english,final,titlepage,parskip,<xsl:value-of select="$papersize"/>,<xsl:value-of select="$fontsize"/>pt</xsl:variable> <xsl:variable name="latex.documentclass.book"></xsl:variable> +<xsl:variable name="latex.generate.indexterm">1</xsl:variable> <xsl:variable name="latex.hyperref.param.pdftex">hyperfigures,hyperindex,citecolor=blue,urlcolor=blue</xsl:variable> <xsl:variable name="latex.document.font">default</xsl:variable> <xsl:variable name="latex.admonition.path">xslt/figures</xsl:variable> <xsl:variable name="latex.hyphenation.tttricks">1</xsl:variable> <xsl:variable name="latex.use.tabularx">1</xsl:variable> +<xsl:template name="latex.thead.row.entry"> +<xsl:text>{\bfseries </xsl:text><xsl:apply-templates/><xsl:text>}</xsl:text> +</xsl:template> <xsl:param name="latex.babel.language">english</xsl:param> <xsl:param name="ulink.url">1</xsl:param> @@ -31,5 +34,9 @@ </xsl:if> </xsl:template> +<xsl:template name="latex.thead.row.entry"> +<xsl:text>{\bfseries </xsl:text><xsl:apply-templates/><xsl:text>}</xsl:text> +</xsl:template> + </xsl:stylesheet> diff --git a/docs/docbook/xslt/latex/sambadoc.cls b/docs/docbook/xslt/latex/sambadoc.cls index 9f3caa5482..fcea11992f 100644 --- a/docs/docbook/xslt/latex/sambadoc.cls +++ b/docs/docbook/xslt/latex/sambadoc.cls @@ -2,7 +2,7 @@ %%-- RC Thesis %%--------------------------------------------------- \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{xslt/latex/sambadoc} +\ProvidesClass{sambadoc} %%--------------------------------------------------- %%-- Load the base class and modify current macros. |